dca_ipr::IprEnums Class Reference
[IP Reputation]

#include <ipr_enums.h>

List of all members.


Detailed Description

Definition of a container class for IprEnum objects.

Can be obtained from an IprCategoriesInfo object.

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

See also:
IprEnumsInfo, IprEnum

Definition at line 30 of file ipr_enums.h.

Public Member Functions

IprEnum at (DCA_INDEX_TYPE index) const
 Returns the IprEnum with given index.
IprEnum 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 enums in the container.
IprEnum byId (DCA_ENUM_ID_TYPE id) const
 Returns the IprEnum with the given id.

Member Function Documentation

IprEnum dca_ipr::IprEnums::at ( DCA_INDEX_TYPE  index  )  const

Returns the IprEnum with given index.

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

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

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

Returns the number of enums in the container.

Returns:
The size of the container or 0 if the container is empty.
IprEnum dca_ipr::IprEnums::byId ( DCA_ENUM_ID_TYPE  id  )  const

Returns the IprEnum with the given id.

Parameters:
[in] id The id of the requested enum
Returns:
The IprEnum 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