RemoteViz::Rendering::ConnectionParameters Class Reference
[RemoteViz]
More...
#include <RemoteViz/Rendering/ConnectionParameters.h>
List of all members.
Public Member Functions |
unsigned int | getNumParameters () const |
const std::string & | getValue (int index) const |
const std::string & | getValue (const std::string &key) const |
const std::string & | getKey (int index) const |
int | getIndex (const std::string &key) const |
Detailed Description
Field-value pairs included in the URL during the client connection. (see RemoteVizRenderArea::connectTo and SoRemoteVizClient::connectionParameters)
Member Function Documentation
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.
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.
unsigned int RemoteViz::Rendering::ConnectionParameters::getNumParameters |
( |
|
) |
const |
Gets the number of parameters.
- Returns:
- the number of parameters
const std::string& RemoteViz::Rendering::ConnectionParameters::getValue |
( |
const std::string & |
key |
) |
const |
Gets the value of a parameter associated with a key.
- Parameters:
-
- Returns:
- the value if the key exists, otherwise returns an empty string.
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: