dca_interface  6.3.4
dca_malware::MalwareEnums Class Reference

#include <malware_enums.h>

Detailed Description

Definition of a container class for MalwareEnum objects.

Can be obtained from an MalwareCategoriesInfo object.

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

See also
MalwareEnumsInfo, MalwareEnum

Definition at line 30 of file malware_enums.h.

Public Member Functions

MalwareEnum at (DCA_INDEX_TYPE index) const
 Returns the MalwareEnum with given index. More...
 
MalwareEnum operator[] (DCA_INDEX_TYPE index) const
 Similar to at() but allows a more C++ style access. More...
 
DCA_SIZE_TYPE size () const
 Returns the number of enums in the container. More...
 
MalwareEnum byId (DCA_ENUM_ID_TYPE id) const
 Returns the MalwareEnums with the given id. More...
 

Member Function Documentation

◆ at()

MalwareEnum dca_malware::MalwareEnums::at ( DCA_INDEX_TYPE  index) const

Returns the MalwareEnum with given index.

Parameters
[in]indexThe index of the enum. Range is from 0 to size() - 1
Returns
The MalwareEnum with the given index in the container.

◆ operator[]()

MalwareEnum dca_malware::MalwareEnums::operator[] ( DCA_INDEX_TYPE  index) const

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

Parameters
[in]indexThe index of the enum. Range is from 0 to size() - 1
Returns
The MalwareEnum with the given index in the container.

◆ size()

DCA_SIZE_TYPE dca_malware::MalwareEnums::size ( ) const

Returns the number of enums in the container.

Returns
The size of the container or 0 if the container is empty.

◆ byId()

MalwareEnum dca_malware::MalwareEnums::byId ( DCA_ENUM_ID_TYPE  id) const

Returns the MalwareEnums with the given id.

Parameters
[in]idThe id of the requested enum
Returns
The MalwareEnums with the given id in the container.

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