MAKLogger::DtCommand Class Reference

The logger command which contains the command type and its parameters. More...

Collaboration diagram for MAKLogger::DtCommand:

Public Member Functions
	DtCommand (DtLgrDomainId domain, DtLgrProtocolId protocol, DtLgrCommandId command, const char *parametersBuffer=0)
	Pass in values for type and optional serialized parameters. More...
	DtCommand (DtLgrDomainId domain, DtLgrProtocolId protocol, const DtString &commandName)
	Pass in name of command. More...
	DtCommand (const DtLgrCommandType &type, DtLgrCommandId command)
	Simple command, no parameters. More...
	DtCommand (const DtCommand &type)
	Simple command, no parameters. More...
	~DtCommand ()
	Complex command, with base parameter class. More...
DtLgrCommandType	type () const
	Get the type. More...
DtLgrCommandId	id () const
	Get the command id. More...
void	setId (DtLgrCommandId id)
	Set the id. More...
const DtString *	name () const
	Get the name, this is null if not specified. More...
void	setParameter (const DtString &name, DtAnyValue *)
	Set a parameter. More...
const DtAnyValue *	parameter (const DtString &name) const
	Get a parameter. More...
void	serializeParameters (DtString &parameterBuffer) const
	Serialize the parameters into the given string buffer. More...
void	deserializeParameters (const char *parameterBuffer)
	Deserialize the parameters from the given string buffer. More...
bool	operator== (const DtCommand &) const
	Comparison operators, function only on myType and myCommand, Will compare myUnknownCommandName if myCommand is theUnknownCommand; NOT myParameters. More...
bool	operator!= (const DtCommand &) const
bool	operator< (const DtCommand &) const
bool	operator> (const DtCommand &) const

Static Public Attributes
static const DtLgrCommandId	theUnknownCommand = 0
	Unknown command, specific if commandName is used. More...

Protected Attributes
DtLgrCommandType	myType
DtLgrCommandId	myCommand
DtCommandParamsSP	myParameters
DtString *	myUnknownCommandName

Detailed Description

The logger command which contains the command type and its parameters.

Constructor & Destructor Documentation

MAKLogger::DtCommand::DtCommand	(	DtLgrDomainId	domain,
		DtLgrProtocolId	protocol,
		DtLgrCommandId	command,
		const char *	parametersBuffer = 0
	)

Pass in values for type and optional serialized parameters.

MAKLogger::DtCommand::DtCommand	(	DtLgrDomainId	domain,
		DtLgrProtocolId	protocol,
		const DtString &	commandName
	)

Pass in name of command.

MAKLogger::DtCommand::DtCommand	(	const DtLgrCommandType &	type,
		DtLgrCommandId	command
	)

Simple command, no parameters.

MAKLogger::DtCommand::DtCommand

(

const DtCommand &

type

)

Simple command, no parameters.

MAKLogger::DtCommand::~DtCommand

(

)

Complex command, with base parameter class.

Member Function Documentation

void MAKLogger::DtCommand::deserializeParameters

(

const char *

parameterBuffer

)

Deserialize the parameters from the given string buffer.

DtLgrCommandId MAKLogger::DtCommand::id

(

)

const

Get the command id.

const DtString* MAKLogger::DtCommand::name

(

)

const

Get the name, this is null if not specified.

bool MAKLogger::DtCommand::operator!=

(

const DtCommand &

)

const

bool MAKLogger::DtCommand::operator<

(

const DtCommand &

)

const

bool MAKLogger::DtCommand::operator==

(

const DtCommand &

)

const

Comparison operators, function only on myType and myCommand, Will compare myUnknownCommandName if myCommand is theUnknownCommand; NOT myParameters.

bool MAKLogger::DtCommand::operator>

(

const DtCommand &

)

const

const DtAnyValue* MAKLogger::DtCommand::parameter

(

const DtString &

name

)

const

Get a parameter.

void MAKLogger::DtCommand::serializeParameters

(

DtString &

parameterBuffer

)

const

Serialize the parameters into the given string buffer.

void MAKLogger::DtCommand::setId

(

DtLgrCommandId

id

)

Set the id.

void MAKLogger::DtCommand::setParameter	(	const DtString &	name,
		DtAnyValue *
	)

Set a parameter.

DtLgrCommandType MAKLogger::DtCommand::type

(

)

const

Get the type.

Member Data Documentation

DtLgrCommandId MAKLogger::DtCommand::myCommand

protected

DtCommandParamsSP MAKLogger::DtCommand::myParameters

protected

DtLgrCommandType MAKLogger::DtCommand::myType

protected

DtString* MAKLogger::DtCommand::myUnknownCommandName

protected

const DtLgrCommandId MAKLogger::DtCommand::theUnknownCommand = 0

static

Unknown command, specific if commandName is used.

---

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

• lgrCommand.h