CollectionIdentifier Class Reference

Defines how to identify a collection. More...

#include <CollectionIdentifier.hh>

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

Detailed Description

Defines how to identify a collection.

Constructor & Destructor Documentation

CollectionIdentifier() [1/2]

CollectionIdentifier

(

)

Constructor.

CollectionIdentifier() [2/2]

CollectionIdentifier

(

const CollectionIdentifier &

_orig

)

Copy Constructor.

Parameters

[in]

_orig

CollectionIdentifier to copy.

~CollectionIdentifier()

~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]

_prefix

Optional 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]

_prefix

Optional 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]

_orig

CollectionIdentifier to copy.

Returns

Reference to this object.

operator==()

bool operator==

(

const CollectionIdentifier &

_rhs

)

const

Equality operator.

Parameters

[in]

_rhs

CollectionIdentifier 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]

_name

The name to set.

Returns

True if successful.

SetOwner()

bool SetOwner

(

const std::string &

_name

)

Set the owner of the collection.

Parameters

[in]

_name

The 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]

_server

The 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.

Url()

gz::common::URI Url

(

)

const

Returns a URL for the collection.

Remarks

this is Server/Owner/Name.

---

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

• CollectionIdentifier.hh