pqServerConfiguration corresponds to a server connection configuration.
More...
#include <pqServerConfiguration.h>
pqServerConfiguration corresponds to a server connection configuration.
These are typically read from pvsc files.
Definition at line 47 of file pqServerConfiguration.h.
◆ StartupType
◆ pqServerConfiguration() [1/2]
pqServerConfiguration::pqServerConfiguration |
( |
| ) |
|
◆ pqServerConfiguration() [2/2]
◆ ~pqServerConfiguration()
pqServerConfiguration::~pqServerConfiguration |
( |
| ) |
|
◆ 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 |
◆ 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()
Get/Set the URI that describes the server scheme, hostname(s) and port(s).
◆ setResource() [1/2]
◆ 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 |
◆ clone()
◆ optionsXML()
returns the <Options> element, if any.
◆ hintsXML()
returns the <Hints> element, if any.
◆ startupXML()
The documentation for this class was generated from the following file: