dca_interface  6.3.4
dca_wac::WacApplication Class Reference

#include <wac_application.h>

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

Member Function Documentation

◆ operator==()

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]aInstAnother WacApplication instance to check for equality with current instance.
Returns
True if identical else false
See also
dca_wac::NullWacApplication

◆ operator!=()

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]aInstAnother WacApplication instance to check for inequality with the current instance.
Returns
False if identical else true
See also
dca_wac::NullWacApplication

◆ id()

DCA_APPLICATION_ID_TYPE dca_wac::WacApplication::id ( ) const

Returns the internal id of a WacApplication class.

Returns
The id of the application.

◆ name()

std::string dca_wac::WacApplication::name ( const std::string &  localeString = std::string()) const

Returns the localized (display) name of the application.

Parameters
[in]localeStringThe 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.

◆ description()

std::string dca_wac::WacApplication::description ( const std::string &  localeString = std::string()) const

Returns the localized (brief) description of the application.

Parameters
[in]localeStringThe 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.

◆ categoryId()

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

◆ getActions()

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

◆ getTags()

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: