dca_ipr::IprEnum Class Reference
[IP Reputation]

#include <ipr_enum.h>

List of all members.


Detailed Description

The IprEnum class describes a single enumerable item, for example the Geo Location "Greenland".

To retrieve all the enumerations available use the IprCategoriesInfo class.

See also:
IprCategoriesInfo

Definition at line 26 of file ipr_enum.h.

Public Member Functions

bool operator== (const IprEnum &aInst) const
 Equality operator, returns true if two IprEnum objects refer to the identical item.
bool operator!= (const IprEnum &aInst) const
 Inequality operator, returns true if two IprEnum objects refer to different internal enum items.
DCA_ENUM_ID_TYPE id () const
 Returns the internal id of the enumerable item.
std::string name (const std::string &localeString=std::string()) const
 Returns the localized (display) name of the enumerable item.

Member Function Documentation

bool dca_ipr::IprEnum::operator== ( const IprEnum aInst  )  const

Equality operator, returns true if two IprEnum objects refer to the identical item.

Parameters:
[in] aInst Another IprEnum instance to check for equality with current instance.
Returns:
True if identical else false
See also:
dca_ipr::NullIprEnum
bool dca_ipr::IprEnum::operator!= ( const IprEnum aInst  )  const

Inequality operator, returns true if two IprEnum objects refer to different internal enum items.

Parameters:
[in] aInst Another instance to check for inequality with the current instance.
Returns:
False if identical, otherwise true
See also:
dca_ipr::NullIprEnum
DCA_ENUM_ID_TYPE dca_ipr::IprEnum::id (  )  const

Returns the internal id of the enumerable item.

Returns:
The id of the category.
std::string dca_ipr::IprEnum::name ( const std::string &  localeString = std::string()  )  const

Returns the localized (display) name of the enumerable item.

Parameters:
[in] localeString The name of the Locale to be used. Leave blank for using the default locale ("en_US")
Returns:
Localized enumeration name.
Note:
The available locales for a given IprCategoriesInfo object can be obtained via the Locales class.

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

Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1