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

#include <wac_application.h>

List of all members.


Detailed Description

The WacApplication class represents a given application e.g. HOTMAIL, GMAIL etc.

To retrieve all applications use the WacApplications container class that can be obtained from a WacCategoriesInfo class.

The result of a WAC classification (WacClassificationResult) contains the id of an application if found. With this id you can use a WacApplications container class and its method byId() to get the Application object.

See also:
WacApplications, WacCategoriesInfo, WacApplication

Definition at line 31 of file wac_application.h.

Public Member Functions

bool operator== (const WacApplication &aInst) const
 Equality operator, returns true if two WacApplication objects refer to the identical internal application.
bool operator!= (const WacApplication &aInst) const
 Inequality operator, returns true if two WacApplication objects refer to two different internal applications.
DCA_APPLICATION_ID_TYPE id () const
 Returns the internal id of a WacApplication class.
std::string name (const std::string &localeString=std::string()) const
 Returns the localized (display) name of the application.
std::string description (const std::string &localeString=std::string()) const
 Returns the localized (brief) description of the application.
DCA_CATEGORY_ID_TYPE categoryId () const
 Returns the id of the associated dca::Category. Each application is a member of only one category.
WacActions getActions () const
 Returns all actions available for the application. If an application does not support actions, this container will be empty..
WacTags getTags () const
 Returns all tags that are defined for a given application e.g. "RISKLEVEL_1", "HIGH BANDWIDTH" etc.

Member Function Documentation

bool dca_wac::WacApplication::operator== ( const WacApplication aInst  )  const

Equality operator, returns true if two WacApplication objects refer to the identical internal application.

Parameters:
[in] aInst Another WacApplication instance to check for equality with current instance.
Returns:
True if identical else false
See also:
dca_wac::NullWacApplication
bool dca_wac::WacApplication::operator!= ( const WacApplication aInst  )  const

Inequality operator, returns true if two WacApplication objects refer to two different internal applications.

Parameters:
[in] aInst Another WacApplication instance to check for inequality with the current instance.
Returns:
False if identical else true
See also:
dca_wac::NullWacApplication
DCA_APPLICATION_ID_TYPE dca_wac::WacApplication::id (  )  const

Returns the internal id of a WacApplication class.

Returns:
The id of the application.
std::string dca_wac::WacApplication::name ( const std::string &  localeString = std::string()  )  const

Returns the localized (display) name of the application.

Parameters:
[in] localeString The name of the Locale to be used. Leave blank for using the default locale ("en_US")
Returns:
Localized application name.
Note:
The available locales for a given WacCategoriesInfo object can be obtained via the dca::Locales class.
std::string dca_wac::WacApplication::description ( const std::string &  localeString = std::string()  )  const

Returns the localized (brief) description of the application.

Parameters:
[in] localeString The name of the Locale to be used. Leave blank for using the default locale ("en_US")
Returns:
Localized application description.
Note:
The available locales for a given WacCategoriesInfo object can be obtained via the dca::Locales class.
DCA_CATEGORY_ID_TYPE dca_wac::WacApplication::categoryId (  )  const

Returns the id of the associated dca::Category. Each application is a member of only one category.

Returns:
the id of a dca::Category class if found.
See also:
dca::Category, dca::Categories, dca::CategoriesInfo, WacCategoriesInfo
WacActions dca_wac::WacApplication::getActions (  )  const

Returns all actions available for the application. If an application does not support actions, this container will be empty..

Returns:
A container class that contains all available actions for an application class.
See also:
WacActions
WacTags dca_wac::WacApplication::getTags (  )  const

Returns all tags that are defined for a given application e.g. "RISKLEVEL_1", "HIGH BANDWIDTH" etc.

Returns:
A container class that contains all associated tags for a given application
See also:
WacTag

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

Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1