pqServerConfiguration Class Reference

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

#include <pqServerConfiguration.h>

List of all members.

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.
void	setMutable (bool val)
void	setName (const QString &name)
	Get/Set the name for the configuration.
QString	name () const
pqServerResource	resource () const
	Get/Set the URI that describes the server scheme, hostname(s) and port(s).
void	setResource (const pqServerResource &)
void	setResource (const QString &)
StartupType	startupType () const
	returns the startup type for this configuration.
QString	command (double &timeout, double &delay) const
	If startupType() == COMMAND, then this method can be used to obtain the command for the startup.
void	setStartupToManual ()
	changes the startup type to manual.
void	setStartupToCommand (double timeout, double delay, const QString &command)
	changes the startup type to command.
QString	toString (vtkIndent indent) const
	serialize to a string.
pqServerConfiguration	clone () const
	Create a new clone (deep copying the vtkPVXMLElement).
vtkPVXMLElement *	optionsXML () const
	returns the <Options> element, if any.

---

Detailed Description

pqServerConfiguration corresponds to a server connection configuration.

These are typically read from pvsc files.

Definition at line 45 of file pqServerConfiguration.h.

---

Member Enumeration Documentation

enum pqServerConfiguration::StartupType

Types of start.

Enumerator:

INVALID
MANUAL
COMMAND

Definition at line 67 of file pqServerConfiguration.h.

---

Constructor & Destructor Documentation

pqServerConfiguration::pqServerConfiguration

(

)

pqServerConfiguration::pqServerConfiguration

(

vtkPVXMLElement *

xml

)

pqServerConfiguration::~pqServerConfiguration

(

)

---

Member Function Documentation

bool pqServerConfiguration::isMutable

(

)

const [inline]

Get/Set whether the configuration is mutable.

This variable is not serialized.

Definition at line 54 of file pqServerConfiguration.h.

void pqServerConfiguration::setMutable

(

bool

val

)

[inline]

Definition at line 55 of file pqServerConfiguration.h.

void pqServerConfiguration::setName

(

const QString &

name

)

Get/Set the name for the configuration.

QString pqServerConfiguration::name

(

)

const

pqServerResource pqServerConfiguration::resource

(

)

const

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

void pqServerConfiguration::setResource

(

const pqServerResource &

)

void pqServerConfiguration::setResource

(

const QString &

)

StartupType pqServerConfiguration::startupType

(

)

const

returns the startup type for this configuration.

There are 3 types of startup: manual, simple-command and custom-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.

void pqServerConfiguration::setStartupToManual

(

)

changes the startup type to manual.

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

changes the startup type to command.

QString pqServerConfiguration::toString

(

vtkIndent

indent

)

const

serialize to a string.

pqServerConfiguration pqServerConfiguration::clone

(

)

const

Create a new clone (deep copying the vtkPVXMLElement).

vtkPVXMLElement* pqServerConfiguration::optionsXML

(

)

const

returns the <Options> element, if any.

---

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

• /home/kitware/Dashboards/My Tests/ParaView/Qt/Core/pqServerConfiguration.h