DtConsoleMessageCommand Class Reference

DtConsoleMessageCommand. More...

Inheritance diagram for DtConsoleMessageCommand:

List of all members.

Public Member Functions
	DtConsoleMessageCommand ()
	Default constructor.
	DtConsoleMessageCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor.
	DtConsoleMessageCommand (const DtString &writeName, const DtConsoleMessageCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtConsoleMessageCommand ()
	destructor
DtConsoleMessageCommand &	operator= (const DtConsoleMessageCommand &orig)
	assignment operator
int	type () const
virtual DtSimCommand *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	stringRep () const
	Text representation of this command.
virtual int	netRepSize () const
	Returns the size in bytes of the network representation of the class.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).
virtual bool	setToNet ()
	Calls netRep() to create the network buffer.
virtual DtString	messageText () const
	Name of the object to delete.
virtual void	setMessageText (const DtString &text)
	Name of the object to delete.
virtual DtNotifyLevelType	notifyLevel () const
	The notification level of the message.
virtual void	setNotifyLevel (DtNotifyLevelType level)
	The notification level of the message.
Static Public Member Functions
static DtSimCommand *	creator ()
	Returns a new instance of this class.
Protected Attributes
DtRwString	myMessageText
DtRwInt	myNotifyLevel

---

Detailed Description

DtConsoleMessageCommand.

DtSimCommand which causes a console message to be printed. When used from an entity/object plan, the message is sent to the objectConsole. When used from a global plan, the message is sent to the sim engine console. The notification level of the message is configurable.

---

Constructor & Destructor Documentation

DtConsoleMessageCommand::DtConsoleMessageCommand

(

)

Default constructor.

DtConsoleMessageCommand::DtConsoleMessageCommand	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Usual constructor.

DtConsoleMessageCommand::DtConsoleMessageCommand	(	const DtString &	writeName,
		const DtConsoleMessageCommand &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtConsoleMessageCommand::~DtConsoleMessageCommand

(

)

[virtual]

destructor

---

Member Function Documentation

DtConsoleMessageCommand& DtConsoleMessageCommand::operator=

(

const DtConsoleMessageCommand &

orig

)

assignment operator

int DtConsoleMessageCommand::type

(

)

const [virtual]

Returns:

DtConsoleMessageCommandType.

Implements DtSimCommand.

virtual DtSimCommand* DtConsoleMessageCommand::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Returns:

A new instance of this class, copied from the original.

Implements DtSimCommand.

virtual DtString DtConsoleMessageCommand::messageText

(

)

const [virtual]

Name of the object to delete.

virtual void DtConsoleMessageCommand::setMessageText

(

const DtString &

text

)

[virtual]

Name of the object to delete.

virtual DtNotifyLevelType DtConsoleMessageCommand::notifyLevel

(

)

const [virtual]

The notification level of the message.

This determines whether the message is printed or not, depending on the notification level for either the entity (for entity plans) or the overall application (for global plans).

virtual void DtConsoleMessageCommand::setNotifyLevel

(

DtNotifyLevelType

level

)

[virtual]

The notification level of the message.

This determines whether the message is printed or not, depending on the notification level for either the entity (for entity plans) or the overall application (for global plans).

virtual DtString DtConsoleMessageCommand::stringRep

(

)

const [virtual]

Text representation of this command.

Implements DtSimCommand.

virtual int DtConsoleMessageCommand::netRepSize

(

)

const [virtual]

Returns the size in bytes of the network representation of the class.

This is the size in bytes of the DtNetSimSimCommand structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimCommand.

virtual bool DtConsoleMessageCommand::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).

Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual bool DtConsoleMessageCommand::setToNet

(

)

[virtual]

Calls netRep() to create the network buffer.

Casts the resulting myNetRep to type DtNetSimSimCommand*, and then sets the mySubsimCommand member in the DtNetSimSimCommand from mySubsimCommand. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

static DtSimCommand* DtConsoleMessageCommand::creator

(

)

[static]

Returns a new instance of this class.

---

Member Data Documentation

DtRwString DtConsoleMessageCommand::myMessageText [protected]

DtRwInt DtConsoleMessageCommand::myNotifyLevel [protected]

---

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

• include/vrfplan/consoleMessageCommand.h