Gazebo Fuel_tools

API Reference

4.9.1
ServerConfig Class Reference

Describes options needed for a server. More...

#include <ClientConfig.hh>

Public Member Functions

 ServerConfig ()
 Constructor. More...
 
 ServerConfig (const ServerConfig &_orig)
 Copy constructor. More...
 
 ~ServerConfig ()
 Destructor. More...
 
std::string ApiKey () const
 Get the API key to auth with the server. More...
 
std::string AsPrettyString (const std::string &_prefix="") const
 Returns all the available model information as a string using colors for better human parsing. More...
 
std::string AsString (const std::string &_prefix="") const
 Returns all the server information as a string. More...
 
void Clear ()
 Clear the server config. This will set all values to empty strings, except the version string which will be set to its default value. More...
 
ServerConfigoperator= (const ServerConfig &_orig)
 Assignment operator overload. More...
 
void SetApiKey (const std::string &_key)
 Set the API key to auth with the server. More...
 
void SetUrl (const common::URI &_url)
 Set the URL of this server. More...
 
void SetVersion (const std::string &_version)
 Set the protocol version used with this server. More...
 
common::URI Url () const
 Get the URL to access the server. More...
 
std::string Version () const
 Get the protocol version used with this server. More...
 

Detailed Description

Describes options needed for a server.

Constructor & Destructor Documentation

◆ ServerConfig() [1/2]

Constructor.

◆ ServerConfig() [2/2]

ServerConfig ( const ServerConfig _orig)

Copy constructor.

Parameters
[in]_origThe server config to copy.

◆ ~ServerConfig()

Destructor.

Member Function Documentation

◆ ApiKey()

std::string ApiKey ( ) const

Get the API key to auth with the server.

Returns
The API key.

◆ AsPrettyString()

std::string AsPrettyString ( const std::string _prefix = "") const

Returns all the available model information as a string using colors for better human parsing.

Parameters
[in]_prefixOptional prefix for every line of the string.
Returns
Model information string

◆ AsString()

std::string AsString ( const std::string _prefix = "") const

Returns all the server information as a string.

Parameters
[in]_prefixOptional prefix for every line of the string.
Returns
Server information string

◆ Clear()

void Clear ( )

Clear the server config. This will set all values to empty strings, except the version string which will be set to its default value.

◆ operator=()

ServerConfig& operator= ( const ServerConfig _orig)

Assignment operator overload.

Parameters
[in]_origThe server config to copy.

◆ SetApiKey()

void SetApiKey ( const std::string _key)

Set the API key to auth with the server.

Parameters
[in]_keyThe API key.

◆ SetUrl()

void SetUrl ( const common::URI _url)

Set the URL of this server.

Parameters
[in]_urlURL of this server.

◆ SetVersion()

void SetVersion ( const std::string _version)

Set the protocol version used with this server.

Parameters
[in]_versionThe version. E.g.: "1.0".

◆ Url()

common::URI Url ( ) const

Get the URL to access the server.

Returns
The URL of this server.

◆ Version()

std::string Version ( ) const

Get the protocol version used with this server.

Returns
The version. E.g.: "1.0".

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