dca_wac::WacTag Class Reference
[Web Application Classification (WAC)]

#include <wac_tag.h>

List of all members.


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.
bool operator!= (const WacTag &aInst) const
 Inequality operator, returns true if two WacTag objects refer to two different internal tags.
DCA_TAG_ID_TYPE id () const
 Returns the internal id of a WacTag class.
std::string name (const std::string &localeString=std::string()) const
 Returns the localized (display) name of the tag.
std::string description (const std::string &localeString=std::string()) const
 Returns the localized (brief) description of the tag.

Member Function Documentation

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
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
DCA_TAG_ID_TYPE dca_wac::WacTag::id (  )  const

Returns the internal id of a WacTag class.

Returns:
The id of the tag.
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.
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:

Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1