dca_interface  6.3.4
dca_wac::WacClassificationResult Class Reference

#include <wac_classification_result.h>

Detailed Description

Definition of the WacClassificationResult class.

A WAC classification, carried out by calling WacClassifier::classify(), returns this class if successful.

See also
WacClassifier

Definition at line 27 of file wac_classification_result.h.

Public Member Functions

bool operator== (const WacClassificationResult &aInst) const
 Equality operator, returns true if two WacClassificationResult objects contain the identical applicationId and actionId. More...
 
bool operator!= (const WacClassificationResult &aInst) const
 Inequality operator, returns true if two WacClassificationResult objects contain different applicationId and actionId. More...
 
DCA_APPLICATION_ID_TYPE applicationId () const
 If the classification was successful this is the matched application. More...
 
DCA_ACTION_ID_TYPE actionId () const
 If the classification was successful this is the matched action. More...
 

Member Function Documentation

◆ operator==()

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

Equality operator, returns true if two WacClassificationResult objects contain the identical applicationId and actionId.

Parameters
[in]aInstAnother WacClassificationResult instance to check for equality with current instance.
Returns
True if identical, otherwise false
Note
A handy way to check a classification result would be: if ( myCResult == NullWacClassificationResult ) --> nothing matched!
See also
NullWacClassificationResult

◆ operator!=()

bool dca_wac::WacClassificationResult::operator!= ( const WacClassificationResult aInst) const

Inequality operator, returns true if two WacClassificationResult objects contain different applicationId and actionId.

Parameters
[in]aInstAnother WacClassificationResult instance to check for inequality with current instance.
Returns
True if not identical, otherwise false
Note
A handy way to check a classification result would be: if ( myCResult != NullWacClassificationResult ) --> anything matched!
See also
NullWacClassificationResult

◆ applicationId()

DCA_APPLICATION_ID_TYPE dca_wac::WacClassificationResult::applicationId ( ) const

If the classification was successful this is the matched application.

Returns
The matched application id.
See also
WacApplication

◆ actionId()

DCA_ACTION_ID_TYPE dca_wac::WacClassificationResult::actionId ( ) const

If the classification was successful this is the matched action.

Note
To obtain an action id it may be necessary to fill the response field of the WacInputData structure for the WAC classification.
Returns
The matched action id.
See also
WacClassifier, WacInputData

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