CCommand Class Reference
[Parsing classes]

This class represents a command to execute with the parameters. More...

#include <CCommand.h>

List of all members.

Public Types
enum	TYPE_COMMAND {   COMMAND_HELP, COMMAND_RUN, COMMAND_SET, COMMAND_PRINT,   COMMAND_QUIT, COMMAND_END }
	This enum represents the command that can be called. More...
enum	TYPE_PARAMETER {   PARAMETER_FORMULASTRING, PARAMETER_SIGNINCREMENT, PARAMETER_NOSIGNINCREMENT, PARAMETER_NOSIGNPRECISION,   PARAMETER_ZOOM, PARAMETER_MINVECTOR, PARAMETER_MAXVECTOR, PARAMETER_VIEWERPOS,   PARAMETER_LIGHTDIRECTION, PARAMETER_SURFACEAMBIENTCOLOR, PARAMETER_SURFACEDIFFUSECOLOR, PARAMETER_SURFACESPECULARCOLOR,   PARAMETER_SURFACESPECULAREXPONENT, PARAMETER_BOXAMBIENTCOLOR, PARAMETER_BOXDIFFUSECOLOR, PARAMETER_BOXSPECULARCOLOR,   PARAMETER_BOXSPECULAREXPONENT, PARAMETER_BACKGROUNDCOLOR, PARAMETER_WIDTH, PARAMETER_HEIGHT,   PARAMETER_PERSPECTIVE, PARAMETER_BOUNDINGBOX, PARAMETER_SIGN, PARAMETER_OPENGLSPECULAR,   PARAMETER_END }
	This enum represents the different values that can be set by the user. More...
enum	TYPE_PARAMETERTYPE {   PARAMETERTYPE_STRING, PARAMETERTYPE_FLOAT, PARAMETERTYPE_VECTOR, PARAMETERTYPE_COLOR,   PARAMETERTYPE_INT, PARAMETERTYPE_END }
	This enum represents the type of parameter a "set" function needs. More...
Public Member Functions
	CCommand ()
	CCommand simple constructor.
TYPE_PARAMETERTYPE	GetParameterType () const
	This function returns the type of parameter needed by the command.
Public Attributes
TYPE_COMMAND	m_CommandID
TYPE_PARAMETER	m_ParameterID
union CCommand::DataUnion	m_pData
Static Public Attributes
static const std::string	s_CommandString [COMMAND_END]
static const std::string	s_ParameterString [PARAMETER_END]
Classes
union	DataUnion
	Union containing a pointer to the parameter of the command. More...

---

Detailed Description

This class represents a command to execute with the parameters.

Definition at line 21 of file CCommand.h.

---

Member Enumeration Documentation

enum CCommand::TYPE_COMMAND

This enum represents the command that can be called.

Enumerator:

COMMAND_HELP
COMMAND_RUN
COMMAND_SET
COMMAND_PRINT
COMMAND_QUIT
COMMAND_END

Definition at line 27 of file CCommand.h.

enum CCommand::TYPE_PARAMETER

This enum represents the different values that can be set by the user.

Enumerator:

PARAMETER_FORMULASTRING
PARAMETER_SIGNINCREMENT
PARAMETER_NOSIGNINCREMENT
PARAMETER_NOSIGNPRECISION
PARAMETER_ZOOM
PARAMETER_MINVECTOR
PARAMETER_MAXVECTOR
PARAMETER_VIEWERPOS
PARAMETER_LIGHTDIRECTION
PARAMETER_SURFACEAMBIENTCOLOR
PARAMETER_SURFACEDIFFUSECOLOR
PARAMETER_SURFACESPECULARCOLOR
PARAMETER_SURFACESPECULAREXPONENT
PARAMETER_BOXAMBIENTCOLOR
PARAMETER_BOXDIFFUSECOLOR
PARAMETER_BOXSPECULARCOLOR
PARAMETER_BOXSPECULAREXPONENT
PARAMETER_BACKGROUNDCOLOR
PARAMETER_WIDTH
PARAMETER_HEIGHT
PARAMETER_PERSPECTIVE
PARAMETER_BOUNDINGBOX
PARAMETER_SIGN
PARAMETER_OPENGLSPECULAR
PARAMETER_END

Definition at line 38 of file CCommand.h.

enum CCommand::TYPE_PARAMETERTYPE

This enum represents the type of parameter a "set" function needs.

Enumerator:

PARAMETERTYPE_STRING
PARAMETERTYPE_FLOAT
PARAMETERTYPE_VECTOR
PARAMETERTYPE_COLOR
PARAMETERTYPE_INT
PARAMETERTYPE_END

Definition at line 71 of file CCommand.h.

---

Constructor & Destructor Documentation

CCommand::CCommand

(

)

[inline]

CCommand simple constructor.

Union containing a pointer to the parameter of the command.

Definition at line 103 of file CCommand.h.

References COMMAND_END, CCommand::DataUnion::Int, m_CommandID, m_ParameterID, m_pData, and PARAMETER_END.

---

Member Data Documentation

TYPE_COMMAND CCommand::m_CommandID

String table corresponding to the different parameters.

Definition at line 86 of file CCommand.h.

Referenced by CCommand(), CCommandExecutor::Execute(), GetParameterType(), and CCommandParser::Parse().

TYPE_PARAMETER CCommand::m_ParameterID

ID of the command to exectute.

Definition at line 88 of file CCommand.h.

Referenced by CCommand(), CCommandExecutor::Execute(), GetParameterType(), and CCommandParser::Parse().

union CCommand::DataUnion CCommand::m_pData

Referenced by CCommand(), CCommandExecutor::Execute(), and CCommandParser::Parse().

---

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

• CCommand.h
• CCommand.cpp

---