class RED::CID
Defines the ID of a REDsdk class (CID stands for Class ID). More...
#include <REDCID.h>Public functions:
| CID ( unsigned int iKey ) | |
| ~CID ( ) | |
| unsigned int | GetKey ( ) const |
| bool | operator!= ( const CID & iOther ) const |
| bool | operator== ( const CID & iOther ) const |
Private variables:
| unsigned int | _key |
Detailed description:
Defines the ID of a REDsdk class (CID stands for Class ID).
All REDsdk classes have their own CID which in turn must be unique (note that no uniqueness check will be performed by REDsdk when creating new CIDs; it's the programmer responsibility to ensure new CIDs uniqueness).
Please, refer to the RED::Factory class documentation for further explanations about the use of CIDs.
Functions documentation
| public RED::CID::CID | ( | unsigned int | iKey | ) |
Constructor.
Parameters:
| iKey: | Unique key identifying the cid. |
| public RED::CID::~CID | ( | ) |
Destructor.
| public unsigned int RED::CID::GetKey | ( | ) const |
Access the CID key value
Returns:
the CID key value.
| public bool RED::CID::operator!= | ( | const CID & | iOther | ) const |
Inequality test operator.
Returns:
true if the two objects are different, false otherwise.
| public bool RED::CID::operator== | ( | const CID & | iOther | ) const |
Equality test operator.
Returns:
true if the two objects are identical, false otherwise.
Variables documentation
private unsigned int RED::CID::_key
Unique key identifying the class.
