PropertyClass Class Reference

Base class for all property classes, providing reflection and serialization functionality. More...

#include <PropertyClass.h>

Inheritance diagram for PropertyClass:

Public Member Functions
virtual char *	getClassName ()=0
	Gets the class name of the derived class in the format class T[*].
virtual void *	getPropertyList ()=0
	Constructs and caches the PropertyList for the derived class, adding all reflected members and member functions.
virtual bool	copy (uint32_t a1)=0
	Copies the property class data.
virtual void *	serialize (void *a2, uint32_t a3)=0
	Serializes the derived class's PropertyList as XML.
virtual bool	onCreated ()=0
	Called when the PropertyClass is created.
template<typename T >
CYRUS T *	as ()
	Casts this to a pointer of type T.
virtual void	onPostLoad ()=0
	Called when the PropertyClass is loaded, i.e., initialize is called and onCreated has finished.
virtual void	onFinalizeLoad ()=0
virtual bool	shouldNotSerialize ()=0
	Determines if the PropertyClass should not be serialized.

Detailed Description

Base class for all property classes, providing reflection and serialization functionality.

Member Function Documentation

as()

template<typename T >

CYRUS T * PropertyClass::as ( )

inline

Casts this to a pointer of type T.

Template Parameters

T	The type to cast to.

Returns

Pointer to this cast to type T.

copy()

virtual bool PropertyClass::copy ( uint32_t a1 )

pure virtual

Copies the property class data.

Parameters

a1	Parameter for copy operation.

Returns

True if the copy operation is successful, false otherwise.

getClassName()

virtual char * PropertyClass::getClassName ( )

pure virtual

Gets the class name of the derived class in the format class T[*].

Returns

Pointer to the class name string.

Implemented in ClassInfo, and PetTomePetTotal.

getPropertyList()

virtual void * PropertyClass::getPropertyList ( )

pure virtual

Constructs and caches the PropertyList for the derived class, adding all reflected members and member functions.

Returns

Pointer to the PropertyList.

Implemented in ClientCSRRegistryList.

onCreated()

virtual bool PropertyClass::onCreated ( )

pure virtual

Called when the PropertyClass is created.

Returns

True if the creation is successful, false otherwise.

onFinalizeLoad()

virtual void PropertyClass::onFinalizeLoad ( )

pure virtual

onPostLoad()

virtual void PropertyClass::onPostLoad ( )

pure virtual

Called when the PropertyClass is loaded, i.e., initialize is called and onCreated has finished.

serialize()

virtual void * PropertyClass::serialize ( void * a2, uint32_t a3 )

pure virtual

Serializes the derived class's PropertyList as XML.

Parameters

a2	Pointer to the XML data.
a3	Additional parameter for serialization.

Returns

Pointer to the serialized data.

shouldNotSerialize()

virtual bool PropertyClass::shouldNotSerialize ( )

pure virtual

Determines if the PropertyClass should not be serialized.

Returns

True if the PropertyClass should not be serialized, false otherwise.