Gazebo Fuel_tools

API Reference

4.9.1
CollectionIdentifier Class Reference

Defines how to identify a collection. More...

#include <CollectionIdentifier.hh>

Public Member Functions

 CollectionIdentifier ()
 Constructor. More...
 
 CollectionIdentifier (const CollectionIdentifier &_orig)
 Copy Constructor. More...
 
 ~CollectionIdentifier ()
 Destructor. More...
 
std::string AsPrettyString (const std::string &_prefix="") const
 Returns all the available collection information as a string using colors for better human parsing. More...
 
std::string AsString (const std::string &_prefix="") const
 Returns all the collection information as a string. Convenient for debugging. More...
 
std::string Name () const
 Returns the collection name. More...
 
CollectionIdentifieroperator= (const CollectionIdentifier &_orig)
 Assignment operator. More...
 
bool operator== (const CollectionIdentifier &_rhs) const
 Equality operator. More...
 
std::string Owner () const
 Returns owner to attribute collection to. More...
 
ServerConfigServer () const
 Returns server information to retrieve collection from. More...
 
bool SetName (const std::string &_name)
 Set the name of the collection. More...
 
bool SetOwner (const std::string &_name)
 Set the owner of the collection. More...
 
bool SetServer (const ServerConfig &_server)
 Set the server from which this collection comes. More...
 
std::string UniqueName () const
 Returns a unique name for the collection. More...
 

Detailed Description

Defines how to identify a collection.

Constructor & Destructor Documentation

◆ CollectionIdentifier() [1/2]

Constructor.

◆ CollectionIdentifier() [2/2]

Copy Constructor.

Parameters
[in]_origCollectionIdentifier to copy.

◆ ~CollectionIdentifier()

Destructor.

Member Function Documentation

◆ AsPrettyString()

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

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

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

◆ AsString()

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

Returns all the collection information as a string. Convenient for debugging.

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

◆ Name()

std::string Name ( ) const

Returns the collection name.

Returns
Collection name.

◆ operator=()

CollectionIdentifier& operator= ( const CollectionIdentifier _orig)

Assignment operator.

Parameters
[in]_origCollectionIdentifier to copy.
Returns
Reference to this object.

◆ operator==()

bool operator== ( const CollectionIdentifier _rhs) const

Equality operator.

Parameters
[in]_rhsCollectionIdentifier to compare.
Returns
True if the CollectionIdentifier names are equal.

◆ Owner()

std::string Owner ( ) const

Returns owner to attribute collection to.

Returns
Owner name.

◆ Server()

ServerConfig& Server ( ) const

Returns server information to retrieve collection from.

Returns
Server information.

◆ SetName()

bool SetName ( const std::string _name)

Set the name of the collection.

Parameters
[in]_nameThe name to set.
Returns
True if successful.

◆ SetOwner()

bool SetOwner ( const std::string _name)

Set the owner of the collection.

Parameters
[in]_nameThe name to set. Must be ascii and pass [-_a-z0-9]+
Returns
true if successful

◆ SetServer()

bool SetServer ( const ServerConfig _server)

Set the server from which this collection comes.

Parameters
[in]_serverThe server to retrieve the collection from.
Returns
True if successful.

◆ UniqueName()

std::string UniqueName ( ) const

Returns a unique name for the collection.

Remarks
this is Server/Owner/Name.
Returns
Unique collection name.

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