dca_interface  6.3.4
dca_malware::MalwareEnum Class Reference

#include <malware_enum.h>

Detailed Description

The MalwareEnum class describes a single enumerable item (currebtly not used for malware)

To retrieve all the enumerations available use the MalwareCategoriesInfo class.

See also
MalwareCategoriesInfo

Definition at line 26 of file malware_enum.h.

Public Member Functions

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

Member Function Documentation

◆ operator==()

bool dca_malware::MalwareEnum::operator== ( const MalwareEnum aInst) const

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

Parameters
[in]aInstAnother MalwareEnum instance to check for equality with current instance.
Returns
True if identical else false
See also
dca_malware::NullMalwareEnum

◆ operator!=()

bool dca_malware::MalwareEnum::operator!= ( const MalwareEnum aInst) const

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

Parameters
[in]aInstAnother instance to check for inequality with the current instance.
Returns
False if identical, otherwise true
See also
dca_malware::NullMalwareEnum

◆ id()

DCA_ENUM_ID_TYPE dca_malware::MalwareEnum::id ( ) const

Returns the internal id of the enumerable item.

Returns
The id of the category.

◆ name()

std::string dca_malware::MalwareEnum::name ( const std::string &  localeString = std::string()) const

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

Parameters
[in]localeStringThe 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 MalwareCategoriesInfo object can be obtained via the Locales class.

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