CP_SDEFParsing::CP_CommandDefinition Class Reference

List of all members.

Public Member Functions
Constructor / Destructor
	CP_CommandDefinition ()
	Constructor.
	CP_CommandDefinition (const CP_CommandDefinition &inCommandDefinition)
virtual	~CP_CommandDefinition () throw ()
	Destructor.
Getters
CP_String	GetCode () const
CP_String	GetHidden () const
CP_String	GetName () const
AEEventKey	GetEventKey ()
operators
CP_CommandDefinition &	operator= (const CP_CommandDefinition &inCommandDefinition)
Parameters
void	AddCommandParameterDefinition (CP_CommandParameterDefinition *inCommandParameterDefinition)
UInt32	GetNumberCommandParameterDefinitions ()
CP_CommandParameterDefinition *	GetNthCommandParameterDefinition (UInt32 inIndex)
Setters
void	SetCode (const CP_String &inCode)
void	SetHidden (const CP_String &inHidden)
void	SetName (const CP_String &inName)
Private Attributes
CP_CommandParameterDefinition_Array	fCommandParameters
CP_String	fCode
CP_String	fHidden
CP_String	fName

---

Constructor & Destructor Documentation

CP_SDEFParsing::CP_CommandDefinition::CP_CommandDefinition (   )

Constructor. Exceptions: none

CP_SDEFParsing::CP_CommandDefinition::CP_CommandDefinition (  const CP_CommandDefinition &  inCommandDefinition  )

Copy constructor. Parameters: inCommandDefinition  The command definition to copy the data from. Exceptions: none

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

Destructor. Exceptions: none

---

Member Function Documentation

CP_String CP_SDEFParsing::CP_CommandDefinition::GetCode (   )  const

CP_String CP_SDEFParsing::CP_CommandDefinition::GetHidden (   )  const

CP_String CP_SDEFParsing::CP_CommandDefinition::GetName (   )  const

AEEventKey CP_SDEFParsing::CP_CommandDefinition::GetEventKey (   )

Returns the AEEventKey for this definition. Exceptions: none  Returns: AEEventKey The event key for this definition.

CP_CommandDefinition & CP_SDEFParsing::CP_CommandDefinition::operator= (  const CP_CommandDefinition &  inCommandDefinition  )

Assignment operator. Parameters: inCommandDefinition  The command definition to copy the data from. Exceptions: none  Returns: CP_CommandDefinition& Returns a reference to ourselves.

void CP_SDEFParsing::CP_CommandDefinition::AddCommandParameterDefinition (  CP_CommandParameterDefinition *  inCommandParameterDefinition  )

Adds the passed in CP_CommandParameterDefinition to the list of definitions in this object. Parameters: inCommandDefinition  The CP_CommandParameterDefinition to add. Exceptions: none  Returns: void

UInt32 CP_SDEFParsing::CP_CommandDefinition::GetNumberCommandParameterDefinitions (   )

Returns the number of CP_CommandDefinitions in the list of definitions. Exceptions: none  Returns: UInt32 The number of definitions.

CP_CommandParameterDefinition * CP_SDEFParsing::CP_CommandDefinition::GetNthCommandParameterDefinition (  UInt32  inIndex  )

Returns the nth CP_CommandParameterDefinition in the list of definitions. Parameters: inIndex  The index of the item to return. Exceptions: none  Returns: CP_CommandParameterDefinition * The command definition to return.

void CP_SDEFParsing::CP_CommandDefinition::SetCode (  const CP_String &  inCode  )

void CP_SDEFParsing::CP_CommandDefinition::SetHidden (  const CP_String &  inHidden  )

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

---

Member Data Documentation

CP_CommandParameterDefinition_Array CP_SDEFParsing::CP_CommandDefinition::fCommandParameters [private]

CP_String CP_SDEFParsing::CP_CommandDefinition::fCode [private]

CP_String CP_SDEFParsing::CP_CommandDefinition::fHidden [private]

CP_String CP_SDEFParsing::CP_CommandDefinition::fName [private]

---

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

• CP_SDEFParser.h
• CP_SDEFParser.cpp

---