pqServerConfiguration.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqServerConfiguration_h
#define pqServerConfiguration_h

#include "pqCoreModule.h"
#include "pqServerResource.h"
#include "vtkPVXMLElement.h"        // needed for ivar
#include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_14_0
#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; };

  PARAVIEW_DEPRECATED_IN_5_14_0("Use int localPortForwardingPort() const instead")
  QString portForwardingLocalPort() const;

  int localPortForwardingPort() const;

  void setDefaultLocalPortForwardingPort(int port);

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;
  int LocalPortForwardingPort = -1;
  int DefaultLocalPortForwardingPort = -1;
  QString ActualURI;
};

#endif