dca_ipr::IprCategories Class Reference
[IP Reputation]

#include <ipr_categories.h>

List of all members.


Detailed Description

Definition of a container class for IprCategory objects.

Can be obtained from an IprCategoriesInfo object.

Use IprCategories in a similar manner to a std::container. The container can be easily iterated over using size() and operator [].

See also:
IprCategoriesInfo, IprCategory

Definition at line 63 of file ipr_categories.h.

Public Member Functions

IprCategory at (DCA_INDEX_TYPE index) const
 Returns the IprCategory with given index.
IprCategory operator[] (DCA_INDEX_TYPE index) const
 Similar to at() but allows a more C++ style access.
DCA_SIZE_TYPE size () const
 Returns the number of categories in the container.
IprCategory byId (DCA_CATEGORY_ID_TYPE catid) const
 Returns the category with the given category id.

Member Function Documentation

IprCategory dca_ipr::IprCategories::at ( DCA_INDEX_TYPE  index  )  const

Returns the IprCategory with given index.

Parameters:
[in] index The index of the category. Range is from 0 to size() - 1
Returns:
The IprCategory with the given index in the container.
IprCategory dca_ipr::IprCategories::operator[] ( DCA_INDEX_TYPE  index  )  const

Similar to at() but allows a more C++ style access.

Parameters:
[in] index The index of the category. Range is from 0 to size() - 1
Returns:
The IprCategory with the given index in the container.
DCA_SIZE_TYPE dca_ipr::IprCategories::size (  )  const

Returns the number of categories in the container.

Returns:
The size of the container or 0 if the container is empty.
IprCategory dca_ipr::IprCategories::byId ( DCA_CATEGORY_ID_TYPE  catid  )  const

Returns the category with the given category id.

Parameters:
[in] catid The id of the requested category
Returns:
The IprCategory with the given id 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