pqServerConfigurationCollection Class Reference

pqServerConfigurationCollection maintains a serializable collection of server-configurations defined in pqServerConfiguration instances. More...

#include <pqServerConfigurationCollection.h>

List of all members.

Signals
void	changed ()
	fired when the collection is modified.
Public Member Functions
	pqServerConfigurationCollection (QObject *parent=0)
virtual	~pqServerConfigurationCollection ()
bool	loadContents (const QString &contents, bool mutable_configs)
	load a pvsc txt.
QString	saveContents (bool only_mutable) const
	save the currently loaded configurations to a file.
bool	load (const QString &filename, bool mutable_configs)
	load/save configurations from/to file.
bool	save (const QString &filename, bool only_mutable)
void	addConfiguration (vtkPVXMLElement *configuration, bool mutable_config=true)
	Add a server configuration.
void	addConfiguration (const pqServerConfiguration &)
void	removeConfiguration (const QString &)
	remove a configuration given the name.
QList< pqServerConfiguration >	configurations () const
	returns the set of server-configurations.
QList< pqServerConfiguration >	configurations (const pqServerResource &selector) const
	returns the configurations matching the selector's host.
const pqServerConfiguration *	configuration (const char *configuration_name) const
	Returns a configuration with the given name.
Protected Attributes
QMap< QString, pqServerConfiguration >	Configurations

---

Detailed Description

pqServerConfigurationCollection maintains a serializable collection of server-configurations defined in pqServerConfiguration instances.

During construction, this class attempts to read server-configurations from following locations:

• QApplication::applicationDirPath()/default_servers.pvsc
• ${COMMON_APPDATA}/QApplication::organizationName()/servers.pvsc
• /usr/share/QApplication::organizationName()/servers.pvsc
• ${QSettings INI Path}/servers.pvsc -- User-specific servers.

The location marked as "User-specific servers" is the location where any server-configurations created/imported by user are saved. User can only modify the server-configurations loaded from this file. All others are treated as read-only configurations.

Definition at line 58 of file pqServerConfigurationCollection.h.

---

Constructor & Destructor Documentation

pqServerConfigurationCollection::pqServerConfigurationCollection

(

QObject *

parent = 0

)

virtual pqServerConfigurationCollection::~pqServerConfigurationCollection

(

)

[virtual]

---

Member Function Documentation

bool pqServerConfigurationCollection::loadContents	(	const QString &	contents,
		bool	mutable_configs
	)

load a pvsc txt.

If mutable_configs==true, then the server-configurations loaded from this file can be edited by the user and get saved in "User-specific servers" configuration file at destruction.

QString pqServerConfigurationCollection::saveContents

(

bool

only_mutable

)

const

save the currently loaded configurations to a file.

If only_mutable==true, only the configurations that were marked mutable are saved, otherwise all configurations are saved.

bool pqServerConfigurationCollection::load	(	const QString &	filename,
		bool	mutable_configs
	)

load/save configurations from/to file.

bool pqServerConfigurationCollection::save	(	const QString &	filename,
		bool	only_mutable
	)

void pqServerConfigurationCollection::addConfiguration	(	vtkPVXMLElement *	configuration,
		bool	mutable_config = true
	)

Add a server configuration.

void pqServerConfigurationCollection::addConfiguration

(

const pqServerConfiguration &

)

void pqServerConfigurationCollection::removeConfiguration

(

const QString &

)

remove a configuration given the name.

QList<pqServerConfiguration> pqServerConfigurationCollection::configurations

(

)

const

returns the set of server-configurations.

QList<pqServerConfiguration> pqServerConfigurationCollection::configurations

(

const pqServerResource &

selector

)

const

returns the configurations matching the selector's host.

const pqServerConfiguration* pqServerConfigurationCollection::configuration

(

const char *

configuration_name

)

const

Returns a configuration with the given name.

Returns NULL when none is found.

void pqServerConfigurationCollection::changed

(

)

[signal]

fired when the collection is modified.

---

Member Data Documentation

QMap<QString, pqServerConfiguration> pqServerConfigurationCollection::Configurations [protected]

Definition at line 104 of file pqServerConfigurationCollection.h.

---

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

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