CP_SDEFParsing::CP_ClassDefinition Class Reference

List of all members.


Public Member Functions
Constructor / Destructor
	CP_ClassDefinition (CP_SDEFParser *inOwnerParser)
	Constructor.
	CP_ClassDefinition (const CP_ClassDefinition &inClassDefinition)
virtual	~CP_ClassDefinition () throw ()
	Destructor.
Elements
void	AddElementDefinition (CP_ElementDefinition *inElementDefinition)
UInt32	GetNumberElementDefinitions ()
CP_ElementDefinition *	GetNthElementDefinition (UInt32 inIndex)
Events
void	AddEventDefinition (CP_EventDefinition *inEventDefinition)
UInt32	GetNumberEventDefinitions ()
CP_EventDefinition *	GetNthEventDefinition (UInt32 inIndex)
Getters
DescType	GetCode () const
CP_String	GetInherits () const
CP_String	GetName () const
CP_String	GetPlural () const
operators
CP_ClassDefinition &	operator= (const CP_ClassDefinition &inClassDefinition)
Properties
void	AddPropertyDefinition (CP_PropertyDefinition *inPropertyDefinition)
UInt32	GetNumberPropertyDefinitions ()
CP_PropertyDefinition *	GetNthPropertyDefinition (UInt32 inIndex)
bool	IsClassPropertyDefined (DescType inPropertyID)
Setters
void	SetCode (const DescType &inCode)
void	SetInherits (const CP_String &inInherits)
void	SetName (const CP_String &inName)
void	SetPlural (const CP_String &inPlural)
Private Member Functions
Properties
void	AddPropertyListEnding ()
Private Attributes
CP_SDEFParser *	fOwnerParser
CP_String	fName
CP_String	fPlural
DescType	fCode
CP_String	fInherits
CP_ElementDefinition_Array	fElementDefinitions
CP_PropertyDefinition_Array	fPropertyDefinitions
CP_EventDefinition_Array	fEventDefinitions

Constructor & Destructor Documentation

CP_SDEFParsing::CP_ClassDefinition::CP_ClassDefinition ( CP_SDEFParser * inOwnerParser )

Constructor.

Exceptions:

none

CP_SDEFParsing::CP_ClassDefinition::CP_ClassDefinition ( const CP_ClassDefinition & inClassDefinition )

Copy constructor.

Parameters:

inClassDefinition The object to copy the data from.

Exceptions:

none

CP_SDEFParsing::CP_ClassDefinition::~CP_ClassDefinition ( ) throw () [virtual]

Destructor.

Exceptions:

none

Member Function Documentation

void CP_SDEFParsing::CP_ClassDefinition::AddElementDefinition ( CP_ElementDefinition * inElementDefinition )

Adds the passed in CP_ElementDefinition to the list of definitions in this object.

Parameters:

inElementDefinition The CP_ElementDefinition to add.

Exceptions:

none

Returns:
void

UInt32 CP_SDEFParsing::CP_ClassDefinition::GetNumberElementDefinitions ( )

Returns the number of CP_ElementDefinition in the list of definitions.

Exceptions:

none

Returns:
UInt32 The number of definitions.

CP_ElementDefinition * CP_SDEFParsing::CP_ClassDefinition::GetNthElementDefinition ( UInt32 inIndex )

Returns the nth CP_ElementDefinition in the list of definitions.

Parameters:

inIndex The index of the item to return.

Exceptions:

none

Returns:
CP_ElementDefinition * The element definition to return.

void CP_SDEFParsing::CP_ClassDefinition::AddEventDefinition ( CP_EventDefinition * inEventDefinition )

Adds the passed in CP_EventDefinition to the list of definitions in this object.

Parameters:

inElementDefinition The CP_EventDefinition to add.

Exceptions:

none

Returns:
void

UInt32 CP_SDEFParsing::CP_ClassDefinition::GetNumberEventDefinitions ( )

Returns the number of CP_EventDefinitions in the list of definitions.

Exceptions:

none

Returns:
UInt32 The number of definitions.

CP_EventDefinition * CP_SDEFParsing::CP_ClassDefinition::GetNthEventDefinition ( UInt32 inIndex )

Returns the nth CP_EventDefinition in the list of definitions.

Parameters:

inIndex The index of the item to return.

Exceptions:

none

Returns:
CP_ElementDefinition * The element definition to return.

DescType CP_SDEFParsing::CP_ClassDefinition::GetCode ( ) const

Returns the code of this class definition.

Exceptions:

none

Returns:
DescType The code of this class definition.

CP_String CP_SDEFParsing::CP_ClassDefinition::GetInherits ( ) const

Returns the inherits form of this class definition.

Exceptions:

none

Returns:
CP_String The inherits of this class definition.

CP_String CP_SDEFParsing::CP_ClassDefinition::GetName ( ) const

Returns the name of this class definition.

Exceptions:

none

Returns:
CP_String The name of this class definition.

CP_String CP_SDEFParsing::CP_ClassDefinition::GetPlural ( ) const

Returns the plural form of this class definition.

Exceptions:

none

Returns:
CP_String The plural form of this class definition.

CP_ClassDefinition & CP_SDEFParsing::CP_ClassDefinition::operator= ( const CP_ClassDefinition & inClassDefinition )

Assignment operator.

Parameters:

inClassDefinition The CP_ClassDefinition to copy the fields from.

Exceptions:

none

Returns:
CP_ClassDefinition& Returns a reference to ourselves.

void CP_SDEFParsing::CP_ClassDefinition::AddPropertyDefinition ( CP_PropertyDefinition * inPropertyDefinition )

Adds the passed in CP_PropertyDefinition to the list of definitions in this object.

Parameters:

inPropertyDefinition The CP_PropertyDefinition to add.

Exceptions:

none

Returns:
void

UInt32 CP_SDEFParsing::CP_ClassDefinition::GetNumberPropertyDefinitions ( )

Returns the number of CP_PropertyDefinitions in the list of definitions.

Exceptions:

none

Returns:
UInt32 The number of definitions.

CP_PropertyDefinition * CP_SDEFParsing::CP_ClassDefinition::GetNthPropertyDefinition ( UInt32 inIndex )

Returns the nth CP_PropertyDefinition in the list of definitions.

Parameters:

inIndex The index of the item to return.

Exceptions:

none

Returns:
CP_PropertyDefinition * The element definition to return.

bool CP_SDEFParsing::CP_ClassDefinition::IsClassPropertyDefined ( DescType inPropertyID )

Returns true if the class property with the passed in DescType is defined.

Parameters:

inPropertyID The property id of the property we are checking for.

Exceptions:

none

Returns:
bool Returns true if the property is defined.

void CP_SDEFParsing::CP_ClassDefinition::SetCode ( const DescType & inCode )

Sets the code of this class definition.

Parameters:

inCode The code for this class definition.

Exceptions:

none

Returns:
void

void CP_SDEFParsing::CP_ClassDefinition::SetInherits ( const CP_String & inInherits )

Sets the inherited version of this class definition.

Parameters:

inCode The inherited version for this class definition.

Exceptions:

none

Returns:
void

void CP_SDEFParsing::CP_ClassDefinition::SetName ( const CP_String & inName )

Sets the name of this class definition.

Parameters:

inname The name for this class definition.

Exceptions:

none

Returns:
void

void CP_SDEFParsing::CP_ClassDefinition::SetPlural ( const CP_String & inPlural )

Sets the plural version of this class definition.

Parameters:

inPlural The plural version for this class definition.

Exceptions:

none

Returns:
void