Xrtti::Field Class Reference

#include <Xrtti.h>

Inheritance diagram for Xrtti::Field:

Xrtti::Member List of all members.

Public Member Functions

const TypeGetType () const
U32 GetOffset () const
void Get (void *pInstance, Value &returnValue) const
void Set (void *pInstance, const Value &value) const

Detailed Description

************************************************************************** Field represents a C++ field (i.e. member variable).


Member Function Documentation

const Type& Xrtti::Field::GetType  )  const [inline]
 

Returns the type of the Field.

Returns:
the type of the Field.

U32 Xrtti::Field::GetOffset  )  const [inline]
 

Returns the offset in bytes from the beginning of the containing Structure to this Field. This field's value is undefined for all static Fields, and for all bitfield Fields. NOTE that this method returns 0 for Fields of anonymous Structures.

Returns:
the offset in bytes from the beginning of the containing Structure to this Field, or 0 if the Field is a field of an anonymous Structure

void Xrtti::Field::Get void *  pInstance,
Value returnValue
const [inline]
 

Returns the current value of this Field within the given instance, which is an object of the type of the context containing this field. Returns an undefined value if the containing class is anonymous or the field is an anonymous structure.

Parameters:
pInstance is an object of the type of the context containing this field. NULL may be passed in if the field is static.
returnValue will return the value of this Field within the given instance. See the documentation for the Value union for an explanation of which union member will be set.

void Xrtti::Field::Set void *  pInstance,
const Value value
const [inline]
 

Sets the current value of this Field within the given instance, which is an object of the type of the context containing this field. Has no effect if the containing class is anonymous. This method must not be called for static Fields.

Parameters:
pInstance is an object of the type of the context containing this field. NULL may be passed in if the field is static.
value holds the value of this Field to set within the given instance. See the documentation for the Value union for an explanation of which union member to set.


The documentation for this class was generated from the following file:
Generated on Sun Apr 29 22:26:04 2007 by  doxygen 1.4.6