pqServerConfiguration.h

Go to the documentation of this file.

/*=========================================================================

   Program: ParaView
   Module:    $RCSfile$

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#ifndef pqServerConfiguration_h
#define pqServerConfiguration_h

#include "pqCoreModule.h"
#include "pqServerResource.h"
#include "vtkPVXMLElement.h" // needed for ivar
#include "vtkSmartPointer.h"
#include <QObject>

class vtkPVXMLElement;
class pqServerResource;
class vtkIndent;

class PQCORE_EXPORT pqServerConfiguration
{
public:
  pqServerConfiguration();

  ~pqServerConfiguration();

  pqServerConfiguration(const QString& name);

  pqServerConfiguration(vtkPVXMLElement* xml);

  bool isMutable() const { return this->Mutable; }
  void setMutable(bool val) { this->Mutable = val; }

  void setName(const QString& name);
  QString name() const;

  bool isNameDefault() const;

  static QString defaultName();

  pqServerResource resource() const;
  void setResource(const QString&);
  void setResource(const pqServerResource&);

  pqServerResource actualResource();

  QString URI() const;

  int connectionTimeout(int defaultTimeout = 60) const;
  void setConnectionTimeout(int connectionTimeout);

  enum StartupType
  {
    INVALID,
    MANUAL,
    COMMAND
  };

  StartupType startupType() const;

  QString command(double& processWait, double& delay) const;

  QString execCommand(double& processWait, double& delay) const;

  void setStartupToManual();

  void setStartupToCommand(double processWait, double delay, const QString& command);

  QString toString(vtkIndent indent) const;

  pqServerConfiguration clone() const;

  vtkPVXMLElement* optionsXML() const;

  vtkPVXMLElement* hintsXML() const;

  bool isPortForwarding() const { return this->PortForwarding; };

  QString portForwardingLocalPort() const;

protected:
  vtkPVXMLElement* startupXML() const;

  void parseSshPortForwardingXML();
  QString sshFullCommand(QString sshCommand, vtkPVXMLElement* sshConfigXML) const;

  static QString termCommand();
  static QString sshCommand();
  static QString lookForCommand(QString command);

private:
  void constructor(const QString& name);
  void constructor(vtkPVXMLElement*);
  bool Mutable = true;
  vtkSmartPointer<vtkPVXMLElement> XML;
  bool PortForwarding = false;
  bool SSHCommand = false;
  QString PortForwardingLocalPort;
  QString ActualURI;
};

#endif