Xrtti::Constructor Class Reference

#include <Xrtti.h>

Inheritance diagram for Xrtti::Constructor:

Xrtti::Member

List of all members.

Public Member Functions

virtual ~Constructor ()
bool operator== (const Constructor &other) const
bool operator!= (const Constructor &other) const
virtual const
ConstructorSignature
GetSignature () const =0
virtual const char * GetArgumentName (u32 index) const =0
virtual bool IsInvokeable () const =0
virtual void * Invoke (void **pArgumentValues) const =0


Detailed Description

************************************************************************** Constructor represents a C++ constructor.

Constructor & Destructor Documentation

virtual Xrtti::Constructor::~Constructor (  )  [inline, virtual]


Member Function Documentation

bool Xrtti::Constructor::operator== ( const Constructor 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::Constructor::operator!= ( const Constructor 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 const ConstructorSignature& Xrtti::Constructor::GetSignature (  )  const [pure virtual]

Returns an object describing the signature of this constructor.

Returns:
an object describing the signature of this constructor.

virtual const char* Xrtti::Constructor::GetArgumentName ( u32  index  )  const [pure virtual]

Additionally, a Constructor gives names to its arguments. This returns the name of argument at index [index].

Returns:
the name of argument at index [index]

virtual bool Xrtti::Constructor::IsInvokeable (  )  const [pure virtual]

Returns true if this method is invokeable. Only if this method returns true may the Invoke() method be called.

Returns:
true if this method is invokeable. Only if this method returns true may the Invoke() method be called.

virtual void* Xrtti::Constructor::Invoke ( void **  pArgumentValues  )  const [pure virtual]

Invokes this constructor and returns the constructed instance. The constructed instance must be deleted by the caller. If the containing Structure is anonymous, this method will return NULL, since anonymous Structures cannot be instantiated.

Parameters:
pArgumentValues is an array of pointers to the arguments to pass to this constructor. The number of pointers in pArguments must match the number of arguments to this constructor.
Returns:
a newly-constructed instance of the containing Structure; or NULL if the containing Structure is anonymous


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

Generated on Sat Feb 14 22:48:49 2009 by  doxygen 1.5.7.1