Xrtti::Enumeration Class Reference

#include <Xrtti.h>

List of all members.

Public Member Functions
virtual	~Enumeration ()
bool	operator== (const Enumeration &other) const
bool	operator!= (const Enumeration &other) const
virtual AccessType	GetAccessType () const =0
virtual const Context &	GetContext () const =0
virtual const char *	GetName () const =0
virtual u32	GetValueCount () const =0
virtual const EnumerationValue &	GetValue (u32 index) const =0

---

Detailed Description

************************************************************************** Enumeration describes a C++ enum.

---

Constructor & Destructor Documentation

virtual Xrtti::Enumeration::~Enumeration

(

)

[inline, virtual]

Destructor

---

Member Function Documentation

bool Xrtti::Enumeration::operator==

(

const Enumeration &

other

)

const

Equality operator - returns true if this object is "functionally equivalent" to [other]. The two objects don't have to be exactly identical, but do have to be identical in every meaningful way. Note also that this doesn't test for equality of any base class members; it is a test only at this level of the inheritence hierarcy. To test if an object is completely equals, including for all of its subclasses defined in the Xrtti hierarchy, you must cast this class to its most derived class and call that method.

Parameters:

other

is the other object to compare against

Returns:

true if this object is functionally equal to the other, false if not

bool Xrtti::Enumeration::operator!=

(

const Enumeration &

other

)

const [inline]

Inequality operator - returns false when the == operator would return true, and vice versa.

Parameters:

other

is the other object to compare against

Returns:

false when the == operator would return true, and vice versa.

virtual AccessType Xrtti::Enumeration::GetAccessType

(

)

const [pure virtual]

Returns the access type of the Enuimeration within the context in which it is defined.

Returns:

the access type of the Enumeration within the context in which it is defined.

virtual const Context& Xrtti::Enumeration::GetContext

(

)

const [pure virtual]

Returns the Context in which this Enumeration is defined.

Returns:

the Context in which this Enumeration is defined

virtual const char* Xrtti::Enumeration::GetName

(

)

const [pure virtual]

Returns the name of this Enumeration.

Returns:

the name of this Enumeration

virtual u32 Xrtti::Enumeration::GetValueCount

(

)

const [pure virtual]

Returns the number of EnumerationValues of this Enumeration.

Returns:

the number of EnumerationValues of this Enumeration.

virtual const EnumerationValue& Xrtti::Enumeration::GetValue

(

u32

index

)

const [pure virtual]

Returns an EnumerationValue of this Enumeration.

Parameters:

index

is the number of the EnumerationValue to return

Returns:

an EnumerationValue of this Enumeration

---

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

• Xrtti.h