ParaView
Public Types | Public Member Functions | Protected Member Functions | List of all members
pqServerConfiguration Class Reference

pqServerConfiguration corresponds to a server connection configuration. More...

#include <pqServerConfiguration.h>

Public Types

enum  StartupType { INVALID, MANUAL, COMMAND }
 Types of start. More...
 

Public Member Functions

 pqServerConfiguration ()
 
 pqServerConfiguration (vtkPVXMLElement *xml)
 
 ~pqServerConfiguration ()
 
bool isMutable () const
 Get/Set whether the configuration is mutable. More...
 
void setMutable (bool val)
 
void setName (const QString &name)
 Get/Set the name for the configuration. More...
 
QString name () const
 
bool isNameDefault () const
 Returns true if the name for this configuration is the default one i.e. More...
 
pqServerResource resource () const
 Get/Set the URI that describes the server scheme, hostname(s) and port(s). More...
 
void setResource (const pqServerResource &)
 
void setResource (const QString &)
 
StartupType startupType () const
 returns the startup type for this configuration. More...
 
QString command (double &timeout, double &delay) const
 If startupType() == COMMAND, then this method can be used to obtain the command for the startup. More...
 
void setStartupToManual ()
 changes the startup type to manual. More...
 
void setStartupToCommand (double timeout, double delay, const QString &command)
 changes the startup type to command. More...
 
QString toString (vtkIndent indent) const
 serialize to a string. More...
 
pqServerConfiguration clone () const
 Create a new clone (deep copying the vtkPVXMLElement). More...
 
vtkPVXMLElementoptionsXML () const
 returns the <Options> element, if any. More...
 
vtkPVXMLElementhintsXML () const
 returns the <Hints> element, if any. More...
 

Protected Member Functions

vtkPVXMLElementstartupXML () const
 

Detailed Description

pqServerConfiguration corresponds to a server connection configuration.

These are typically read from pvsc files.

Definition at line 47 of file pqServerConfiguration.h.

Member Enumeration Documentation

◆ StartupType

Types of start.

Enumerator
INVALID 
MANUAL 
COMMAND 

Definition at line 84 of file pqServerConfiguration.h.

Constructor & Destructor Documentation

◆ pqServerConfiguration() [1/2]

pqServerConfiguration::pqServerConfiguration ( )

◆ pqServerConfiguration() [2/2]

pqServerConfiguration::pqServerConfiguration ( vtkPVXMLElement xml)

◆ ~pqServerConfiguration()

pqServerConfiguration::~pqServerConfiguration ( )

Member Function Documentation

◆ isMutable()

bool pqServerConfiguration::isMutable ( ) const
inline

Get/Set whether the configuration is mutable.

This variable is not serialized.

Definition at line 58 of file pqServerConfiguration.h.

◆ setMutable()

void pqServerConfiguration::setMutable ( bool  val)
inline

Definition at line 59 of file pqServerConfiguration.h.

◆ setName()

void pqServerConfiguration::setName ( const QString &  name)

Get/Set the name for the configuration.

◆ name()

QString pqServerConfiguration::name ( ) const

◆ isNameDefault()

bool pqServerConfiguration::isNameDefault ( ) const

Returns true if the name for this configuration is the default one i.e.

the one that gets set when none is specified. Useful to determine "empty" configurations.

◆ resource()

pqServerResource pqServerConfiguration::resource ( ) const

Get/Set the URI that describes the server scheme, hostname(s) and port(s).

◆ setResource() [1/2]

void pqServerConfiguration::setResource ( const pqServerResource )

◆ setResource() [2/2]

void pqServerConfiguration::setResource ( const QString &  )

◆ startupType()

StartupType pqServerConfiguration::startupType ( ) const

returns the startup type for this configuration.

There are 3 types of startup: manual, simple-command and custom-command.

◆ command()

QString pqServerConfiguration::command ( double &  timeout,
double &  delay 
) const

If startupType() == COMMAND, then this method can be used to obtain the command for the startup.

Note that this does not include any information options etc. that may be specified in the startup.

◆ setStartupToManual()

void pqServerConfiguration::setStartupToManual ( )

changes the startup type to manual.

◆ setStartupToCommand()

void pqServerConfiguration::setStartupToCommand ( double  timeout,
double  delay,
const QString &  command 
)

changes the startup type to command.

◆ toString()

QString pqServerConfiguration::toString ( vtkIndent  indent) const

serialize to a string.

◆ clone()

pqServerConfiguration pqServerConfiguration::clone ( ) const

Create a new clone (deep copying the vtkPVXMLElement).

◆ optionsXML()

vtkPVXMLElement* pqServerConfiguration::optionsXML ( ) const

returns the <Options> element, if any.

◆ hintsXML()

vtkPVXMLElement* pqServerConfiguration::hintsXML ( ) const

returns the <Hints> element, if any.

◆ startupXML()

vtkPVXMLElement* pqServerConfiguration::startupXML ( ) const
protected

The documentation for this class was generated from the following file: