pqServerResource encapsulates a resource in ParaView. More...

#include <pqServerResource.h>

Public Member Functions
	pqServerResource ()

	pqServerResource (const QString &)

	pqServerResource (const QString &, const pqServerConfiguration &)

	pqServerResource (const pqServerResource &)

pqServerResource &	operator= (const pqServerResource &)

	~pqServerResource ()

const pqServerConfiguration &	configuration () const
	Returns the pqServerConfiguration from which this resource was created, if any. More...

const QString	toURI () const
	Returns a compact string representation of the resource in URI format Prefer using configuration->URI() if a configuration is available and not default. More...

const QString	serializeString () const
	Returns a compact string representation of the resource including extra data. More...

const QString	scheme () const
	Returns the resource scheme - builtin, cs, csrc, cdsrs, cdsrsrc, or session. More...

void	setScheme (const QString &)
	Sets the resource scheme. More...

bool	isReverse () const
	Returns if the connection scheme is a reverse one. More...

const QString	host () const
	Returns the resource host, or empty string for builtin, session, cdsrs, and cdsrsrc schemes. More...

void	setHost (const QString &)
	Sets the resource host. More...

int	port () const

int	port (int default_port) const

void	setPort (int)

const QString	dataServerHost () const

void	setDataServerHost (const QString &)

int	dataServerPort () const

int	dataServerPort (int default_port) const

void	setDataServerPort (int)

const QString	renderServerHost () const

void	setRenderServerHost (const QString &)

int	renderServerPort () const

int	renderServerPort (int default_port) const

void	setRenderServerPort (int)

const QString	path () const

void	setPath (const QString &)

const pqServerResource	sessionServer () const

void	setSessionServer (const pqServerResource &)

void	addData (const QString &key, const QString &value)

const QString	data (const QString &key) const

const QString	data (const QString &key, const QString &default_value) const

bool	hasData (const QString &key) const

const pqServerResource	schemeHostsPorts () const
	Returns a copy of this resource containing only server information - scheme, host, and port numbers. More...

const pqServerResource	schemeHosts () const
	Returns a copy of this resource containing a subset of server information - scheme and host (no port numbers. More...

const pqServerResource	hostPath () const
	Returns a copy of this resource containing only host and path information - scheme, port numbers, and server session are excluded. More...

bool	operator== (const pqServerResource &) const

bool	operator!= (const pqServerResource &) const

bool	operator< (const pqServerResource &) const

Detailed Description

pqServerResource encapsulates a resource in ParaView.

A resource can be anything, a data file, a list of data files, a state file, or a connection to a server. The resource specification is based on URL-like syntax:

* <scheme>://<scheme-specific-parameters>
*

To specify a data file, the following syntax is used:

* <connection-scheme>:[//<server-details>]/<path-to-data-file>
*

connection-scheme can be

builtin - for builtin connections
cs - for client-server connections (pvserver)
csrc - for client-server connections with reverse-connect (pvserver rc)
cdsrs - for client-data-server-render-server connections (pvdataserver, pvrenderserver)
cdsrsrc - for cdsrs with reverse-connect.

server-details are of the form <serverhost-name>:<port> or <dataserver-hostname>:<dataserver-port>/<renderserver-hostname>:<render-server-port> as applicable. Port numbers are always optional.

Examples:

* builtin:/home/user/foo.vtk
* cs://amber1:11112/C:\Users\User\foo.vtk
* cdsrsrc://amber2:11111/amber3:22222/home/user/foo.vtk
*

To specify a state file, the following syntax is used:

* session:/<path-to-state-file>
*

Session files are not associated with any connection.

To specify a server-connection, without pointing to any data file(s), the following syntax may be used:

* <connection-scheme>:[//<server-details>]
*

Examples:

* builtin:
* cs://amber1:11112
* cdsrsrc://amber2:11111/amber3:22222
*

As with data-files, port numbers are always optional in when specifying server-details.

Arbitrary data can be added to a resource. ParaView leverages this mechanism to save additional files in a file series when referring to a data file, or details about how to connect to the server when referring to a server-connection.

See also: pqServerResources, pqServer

Definition at line 102 of file pqServerResource.h.

Constructor & Destructor Documentation

◆ pqServerResource() [1/4]

pqServerResource::pqServerResource ( )

◆ pqServerResource() [2/4]

pqServerResource::pqServerResource ( const QString & )

◆ pqServerResource() [3/4]

pqServerResource::pqServerResource	(	const QString &	,
		const pqServerConfiguration &
	)

◆ pqServerResource() [4/4]

pqServerResource::pqServerResource ( const pqServerResource & )

◆ ~pqServerResource()

pqServerResource::~pqServerResource ( )

Member Function Documentation

◆ operator=()

pqServerResource& pqServerResource::operator= ( const pqServerResource & )

◆ configuration()

const pqServerConfiguration& pqServerResource::configuration ( ) const

Returns the pqServerConfiguration from which this resource was created, if any.

◆ toURI()

const QString pqServerResource::toURI ( ) const

Returns a compact string representation of the resource in URI format Prefer using configuration->URI() if a configuration is available and not default.

◆ serializeString()

const QString pqServerResource::serializeString ( ) const

Returns a compact string representation of the resource including extra data.

◆ scheme()

const QString pqServerResource::scheme ( ) const

Returns the resource scheme - builtin, cs, csrc, cdsrs, cdsrsrc, or session.

◆ setScheme()

void pqServerResource::setScheme ( const QString & )

Sets the resource scheme.

◆ isReverse()

bool pqServerResource::isReverse ( ) const

Returns if the connection scheme is a reverse one.

◆ host()

const QString pqServerResource::host ( ) const

Returns the resource host, or empty string for builtin, session, cdsrs, and cdsrsrc schemes.

◆ setHost()

void pqServerResource::setHost ( const QString & )

Sets the resource host.

◆ port() [1/2]

int pqServerResource::port ( ) const

◆ port() [2/2]

int pqServerResource::port ( int default_port ) const

◆ setPort()

void pqServerResource::setPort ( int )

◆ dataServerHost()

const QString pqServerResource::dataServerHost ( ) const

◆ setDataServerHost()

void pqServerResource::setDataServerHost ( const QString & )

◆ dataServerPort() [1/2]

int pqServerResource::dataServerPort ( ) const

◆ dataServerPort() [2/2]

int pqServerResource::dataServerPort ( int default_port ) const

◆ setDataServerPort()

void pqServerResource::setDataServerPort ( int )

◆ renderServerHost()

const QString pqServerResource::renderServerHost ( ) const

◆ setRenderServerHost()

void pqServerResource::setRenderServerHost ( const QString & )

◆ renderServerPort() [1/2]

int pqServerResource::renderServerPort ( ) const

◆ renderServerPort() [2/2]

int pqServerResource::renderServerPort ( int default_port ) const

◆ setRenderServerPort()

void pqServerResource::setRenderServerPort ( int )

◆ path()

const QString pqServerResource::path ( ) const

◆ setPath()

void pqServerResource::setPath ( const QString & )

◆ sessionServer()

const pqServerResource pqServerResource::sessionServer ( ) const

◆ setSessionServer()

void pqServerResource::setSessionServer ( const pqServerResource & )

◆ addData()

void pqServerResource::addData	(	const QString &	key,
		const QString &	value
	)

◆ data() [1/2]

const QString pqServerResource::data ( const QString & key ) const

◆ data() [2/2]

const QString pqServerResource::data	(	const QString &	key,
		const QString &	default_value
	)		const

◆ hasData()

bool pqServerResource::hasData ( const QString & key ) const

◆ schemeHostsPorts()

const pqServerResource pqServerResource::schemeHostsPorts ( ) const

Returns a copy of this resource containing only server information - scheme, host, and port numbers.

◆ schemeHosts()

const pqServerResource pqServerResource::schemeHosts ( ) const

Returns a copy of this resource containing a subset of server information - scheme and host (no port numbers.

◆ hostPath()

const pqServerResource pqServerResource::hostPath ( ) const

Returns a copy of this resource containing only host and path information - scheme, port numbers, and server session are excluded.

◆ operator==()

bool pqServerResource::operator== ( const pqServerResource & ) const

◆ operator!=()

bool pqServerResource::operator!= ( const pqServerResource & ) const

◆ operator<()

bool pqServerResource::operator< ( const pqServerResource & ) const

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

/builds/gitlab-kitware-sciviz-ci/Qt/Core/pqServerResource.h

Public Member Functions