Puma::CEnumInfo Class Reference
#include <Puma/infos/CEnumInfo.h>
List of all members.
Detailed Description
A
CEnumInfo object represents a C++ 'enum'.
Constructor & Destructor Documentation
Puma::CEnumInfo::CEnumInfo |
( |
|
) |
[inline] |
Construct a new enumeration info object.
Puma::CEnumInfo::~CEnumInfo |
( |
|
) |
|
Member Function Documentation
unsigned Puma::CEnumInfo::Enumerators |
( |
|
) |
const [inline] |
Get the number of enumerators in this enumeration.
CEnumeratorInfo * Puma::CEnumInfo::Enumerator |
( |
unsigned |
n |
) |
const [inline] |
Get the n-th enumerator info.
- Parameters:
-
| n | The number of the enumerator. |
- Returns:
- The enumerator info or
NULL
if n is invalid.
Get the info of the enumerator with the given name.
- Parameters:
-
| name | The name of the enumerator. |
- Returns:
- The enumerator info or
NULL
if no enumerator with that name.
CEnumInfo * Puma::CEnumInfo::BaseObject |
( |
|
) |
const [inline] |
Get the base info object of the info object. The corresponding information is not yet set!
- Returns:
- This method always returns
NULL
.
- Warning:
- Do not use this method.
Reimplemented from Puma::CObjectInfo.
CEnumInfo* Puma::CEnumInfo::DefObject |
( |
|
) |
const |
Get the info object of the enumeration definition.
- Returns:
- The info or this if the enumeration is not defined.
Reimplemented from Puma::CObjectInfo.
CTypeEnum * Puma::CEnumInfo::TypeInfo |
( |
|
) |
const [inline] |
Get the type information object for the enumeration.
Reimplemented from Puma::CObjectInfo.
Add a new enumerator to the enumeration.
- Parameters:
-
| ei | The enumerator info to add. |
Remove the given enumerator from the enumeration.
- Parameters:
-
| ei | The enumerator info to remove. |
Create a new enumerator info. The enumerator info is added to the enumeration.
Destroy the given enumerator info. The enumerator info is removed from the enumeration.
- Parameters:
-
| ei | The enumerator info to destroy. |
bool Puma::CEnumInfo::isDefined |
( |
|
) |
const |
Return true if the enumeration is defined.
bool Puma::CEnumInfo::isComplete |
( |
unsigned long |
pos = 0 |
) |
const |
Return true if the enumeration is complete (defined) at the given position.
- Parameters:
-
| pos | The current source code position. |
CTypeInfo * Puma::CEnumInfo::UnderlyingType |
( |
|
) |
const [inline] |
Return the underlying data type.
void Puma::CEnumInfo::UnderlyingType |
( |
CTypeInfo * |
type |
) |
[inline] |
Set the underlying data type.
- Parameters:
-
| type | The underlying type. |