dca_wac::WacTag Class Reference

#include <wac_tag.h>

Detailed Description

The WacTag class represents a given tag that is associated with an application e.g. HIGH BANDWIDTH, RISKLEVEL_1 etc.

To retrieve all tags associated with a given application use the WacApplication class.

To retrieve a list of all available tags use the WacCategoriesInfo class.

See also

WacTags, WacCategoriesInfo, WacApplication

Definition at line 29 of file wac_tag.h.

Public Member Functions
bool	operator== (const WacTag &aInst) const
	Equality operator, returns true if two WacTag objects refer to the identical internal tag. More...
bool	operator!= (const WacTag &aInst) const
	Inequality operator, returns true if two WacTag objects refer to two different internal tags. More...
DCA_TAG_ID_TYPE	id () const
	Returns the internal id of a WacTag class. More...
std::string	name (const std::string &localeString=std::string()) const
	Returns the localized (display) name of the tag. More...
std::string	description (const std::string &localeString=std::string()) const
	Returns the localized (brief) description of the tag. More...

Member Function Documentation

operator==()

bool dca_wac::WacTag::operator==

(

const WacTag &

aInst

)

const

Equality operator, returns true if two WacTag objects refer to the identical internal tag.

Parameters

[in]

aInst

Another WacTag instance to check for equality with current instance.

Returns

True if identical, otherwise false

See also

dca_wac::NullWacTag

operator!=()

bool dca_wac::WacTag::operator!=

(

const WacTag &

aInst

)

const

Inequality operator, returns true if two WacTag objects refer to two different internal tags.

Parameters

[in]

aInst

Another WacTag instance to check for inequality with the current instance.

Returns

False if identical, otherwise true

See also

dca_wac::NullWacTag

id()

DCA_TAG_ID_TYPE dca_wac::WacTag::id

(

)

const

Returns the internal id of a WacTag class.

Returns

The id of the tag.

name()

std::string dca_wac::WacTag::name

(

const std::string &

localeString = std::string()

)

const

Returns the localized (display) name of the tag.

Parameters

[in]

localeString

The name of the Locale to be used. Leave blank to use the default locale ("en_US")

Returns

Localized tag name.

Note

The available locales for a given WacCategoriesInfo object can be obtained via the dca::Locales class.

description()

std::string dca_wac::WacTag::description

(

const std::string &

localeString = std::string()

)

const

Returns the localized (brief) description of the tag.

Parameters

[in]

localeString

The name of the Locale to be used. Leave blank to use the default locale ("en_US")

Returns

Localized tag description.

Note

The available locales for a given WacCategoriesInfo object can be obtained via the dca::Locales class.

---

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

• wac_tag.h