Enum Class Reference

#include <elm/rtti/Enum.h>

Inheritance diagram for Enum:

Classes
class	make
class	Value

Public Types
typedef Vector< Value >::Iter	Iter
Public Types inherited from Type
typedef HashMap< string, const Type * >::Iter	TypeIter

Public Member Functions
	Enum (const make &make)
	Enum (cstring name, const Value values[])
Iter	values (void) const
virtual const Type &	type (void) const
virtual int	valueFor (string text) const
virtual cstring	nameFor (int value) const
virtual bool	canCast (const Type *t) const
virtual bool	isEnum (void) const
virtual const Enumerable &	asEnum (void) const
Public Member Functions inherited from Type
	Type (string name="")
virtual	~Type (void)
string	name (void) const
const PointerType &	pointer (void) const
virtual bool	isVoid (void) const
virtual bool	isBool (void) const
virtual bool	isInt (void) const
virtual bool	isFloat (void) const
virtual bool	isPtr (void) const
virtual const PointerType &	asPtr (void) const
virtual bool	isClass (void) const
virtual const AbstractClass &	asClass (void) const
virtual bool	isSerial (void) const
virtual const Serializable &	asSerial (void) const
virtual const TemplateType *	asTemplate (void) const
virtual const InstanceType *	asInstance (void) const
virtual const ParamType *	asParam (void) const
void	initialize (void)
bool	operator== (const Type &t) const
bool	operator!= (const Type &t) const
Public Member Functions inherited from Enumerable
virtual	~Enumerable (void)

Additional Inherited Members
Static Public Member Functions inherited from Type
static const Type *	get (string name)
static TypeIter	types (void)
Static Public Attributes inherited from Type
static const Type &	param0
static const Type &	param1
static const Type &	param2
static const Type &	param3

Detailed Description

Type for an enumerated type. Recording an enumration in the RTTI system requires several actions:

• defining an Enum descriptor,
• link the Enum descriptor with the type itself,
• providing support for other facilities (input/output, etc).

To help providing this stuff, two macros are provided, DECLARE_ENUM is used in the header file and DEFINE_ENUM in the source file.

The code below represents an heade file where an enumerated type is provided:

#include <elm/rtti.h>
 
typedef enum my_enum {
   A,
   B,
   C
} my_enum;
DECLARE_ENUM(my_enum);

The code below shows the source corresponding part:

elm::rtti::Enum my_enum_type(elm::rtti::make("my_enum")
   .value("A", A)
   .value("B", B)
   .value("C", C));
DEFINE_ENUM(my_enum, my_enum_type);

Concrete representation of an enumerated type.

Member Typedef Documentation

Iter

typedef Vector<Value>::Iter Iter

Constructor & Destructor Documentation

Enum() [1/2]

Enum

(

const make &

make

)

Constructor using a make object.

Parameters

make	Object providing enumeration description.

Enum() [2/2]

Enum	(	cstring	name,
		const Value	values[]
	)

Old-style enumerated type builder.

Parameters

name	Full-qualified enumerated name.
values	Values of the enumerated type.

Old-style constructor only provided for backward compatibility.

References Enum::values().

Member Function Documentation

asEnum()

const Enumerable & asEnum ( void  ) const

virtual

Get the enumeration description corresponding to this type. If the type is not enumerated, an assertion failure is raised.

Returns

Corresponding class instance.

Reimplemented from Type.

canCast()

bool canCast ( const Type *  t ) const

virtual

Test if the type can be casted to the given type.

Parameters

t	Type to cast to.

Returns

True if the type can be casted to the given type, false else.

Reimplemented from Type.

References Type::isInt().

isEnum()

bool isEnum ( void  ) const

virtual

Test if the type is enumerated. Default implementation return false.

Returns

True if the type is a class, false else.

Reimplemented from Type.

nameFor()

cstring nameFor ( int  value ) const

virtual

Find the name corresponding to the gi en enumerated value.

Parameters

value

Value to look text for.

Returns

If found, corresponding name or empty string.

Implements Enumerable.

References elm::rtti::value(), and Enum::values().

type()

const Type & type ( void  ) const

virtual

Get the type corresponding to this enumerable interface.

Returns

Corresponding type.

Implements Enumerable.

valueFor()

int valueFor ( string  text ) const

virtual

Get the value for a text.

Parameters

text	Text to lookup.

Implements Enumerable.

values()

Iter values ( void  ) const

inline

Referenced by Enum::Enum(), and Enum::nameFor().

---

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

• include/elm/rtti/Enum.h
• src/rtti.cpp