RemoteViz::Rendering::ConnectionParameters Class Reference

More...

#include <RemoteViz/Rendering/ConnectionParameters.h>

Public Member Functions
unsigned int	getNumParameters () const
	Gets the number of parameters.
const std::string &	getValue (int index) const
	Gets the value of a parameter associated with an index.
const std::string &	getValue (const std::string &key) const
	Gets the value of a parameter associated with a key.
const std::string &	getKey (int index) const
	Gets the key associated with an index.
int	getIndex (const std::string &key) const
	Gets the index associated with a key.

Detailed Description

Field-value pairs included in the URL when the client requested a connection. See RemoteVizRenderArea::connectTo and SoRemoteVizClient::connectionParameters.

A ConnectionParameters object is passed to ServiceListener::onPendingCreateRenderArea and to ServiceListener::onPendingShareRenderArea.

The application can also query this object from a Connection object. The Connection object can obtained in, e.g., RenderAreaListener::onInitializedConnection().

Definition at line 55 of file ConnectionParameters.h.

Member Function Documentation

getIndex()

int RemoteViz::Rendering::ConnectionParameters::getIndex

(

const std::string &

key

)

const

Gets the index associated with a key.

Returns

the index if the key exists, otherwise returns -1.

getKey()

const std::string & RemoteViz::Rendering::ConnectionParameters::getKey

(

int

index

)

const

Gets the key associated with an index.

Parameters

index

: the parameter index. Range id [0..getNumParameters - 1]

Returns

the key if the index exists, otherwise returns an empty string.

getNumParameters()

unsigned int RemoteViz::Rendering::ConnectionParameters::getNumParameters

(

)

const

Gets the number of parameters.

Returns

the number of parameters

getValue() [1/2]

const std::string & RemoteViz::Rendering::ConnectionParameters::getValue

(

const std::string &

key

)

const

Gets the value of a parameter associated with a key.

Parameters

key

: the key

Returns

the value if the key exists, otherwise returns an empty string.

getValue() [2/2]

const std::string & RemoteViz::Rendering::ConnectionParameters::getValue

(

int

index

)

const

Gets the value of a parameter associated with an index.

Parameters

index

: the parameter index. Range id [0..getNumParameters - 1]

Returns

the value if the index exists, otherwise returns an empty string.

---

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

• RemoteViz/Rendering/ConnectionParameters.h