dca_ipr::IprClassificationResults Class Reference
[IP Reputation]

#include <ipr_classification_results.h>

List of all members.


Detailed Description

Definition of the IprClassificationResults class.

The IprClassificationResults class is a collection of IprClassificationResult objects. An IPR classification returns this class if successful.

See also:
IprClassifier

Definition at line 28 of file ipr_classification_results.h.

Public Member Functions

bool isCategorized () const
 If the classification returned a result this function returns true.
DCA_SIZE_TYPE size () const
 Returns the number of classification results.
IprClassificationResult at (DCA_INDEX_TYPE index) const
 Returns the classification result with the given index.
IprClassificationResult operator[] (DCA_INDEX_TYPE index) const
 Identical to the at() function but allows a more C++ style access.

Member Function Documentation

bool dca_ipr::IprClassificationResults::isCategorized (  )  const

If the classification returned a result this function returns true.

Returns:
Whether or not the classification returned a result.
DCA_SIZE_TYPE dca_ipr::IprClassificationResults::size (  )  const

Returns the number of classification results.

Returns:
The number of classification results, or zero if no results are available.
IprClassificationResult dca_ipr::IprClassificationResults::at ( DCA_INDEX_TYPE  index  )  const

Returns the classification result with the given index.

Parameters:
[in] index The index of the item to retrieve
Returns:
The result item for the given index in the container.
IprClassificationResult dca_ipr::IprClassificationResults::operator[] ( DCA_INDEX_TYPE  index  )  const

Identical to the at() function but allows a more C++ style access.

Parameters:
[in] index The index of the item to retrieve
Returns:
The result item for the given index in the container.

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

Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1