Public Member Functions |
| | pqServerResource () |
| | pqServerResource (const QString &) |
| | pqServerResource (const pqServerResource &) |
| pqServerResource & | operator= (const pqServerResource &) |
| | ~pqServerResource () |
| const QString | toURI () const |
| | Returns a compact string representation of the resource in URI format.
|
| const QString | serializeString () const |
| | Returns a compact string representation of the resource including extra data.
|
| const QString | scheme () const |
| | Returns the resource scheme - builtin, cs, csrc, cdsrs, cdsrsrc, or session.
|
| void | setScheme (const QString &) |
| | Sets the resource scheme.
|
| const QString | host () const |
| | Returns the resource host, or empty string for builtin, session, cdsrs, and cdsrsrc schemes.
|
| void | setHost (const QString &) |
| | Sets the resource host.
|
| 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.
|
| const pqServerResource | schemeHosts () const |
| | Returns a copy of this resource containing a subset of server information - scheme and host (no port numbers.
|
| const pqServerResource | hostPath () const |
| | Returns a copy of this resource containing only host and path information - scheme, port numbers, and server session are excluded.
|
| bool | operator== (const pqServerResource &) const |
| bool | operator!= (const pqServerResource &) const |
| bool | operator< (const pqServerResource &) const |
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 99 of file pqServerResource.h.
