MySimCommand Class Reference

Inheritance diagram for MySimCommand:

List of all members.

Public Member Functions
	MySimCommand ()
	MySimCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	MySimCommand (const DtString &writeName, const MySimCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~MySimCommand ()
MySimCommand &	operator= (const MySimCommand &orig)
int	type () const
virtual DtSimCommand *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Make a copy of this sim command.
virtual DtString	stringRep () const
	Returns a human-readable string representation of the 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
virtual void	setMessageText (const DtString &text)
Static Public Member Functions
static DtSimCommand *	creator ()
Protected Attributes
DtRwString	myMessageText

---

Constructor & Destructor Documentation

MySimCommand::MySimCommand

(

)

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

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

virtual MySimCommand::~MySimCommand

(

)

[virtual]

---

Member Function Documentation

MySimCommand& MySimCommand::operator=

(

const MySimCommand &

orig

)

int MySimCommand::type

(

)

const [virtual]

Returns:

An integer the kind of simulation command. Derived classes must implement this member function to return a unique string representing the type of simCommand. The set of standard simCommand types supplied with VR-Forces is in radioMsgsTypes.h.

Implements DtSimCommand.

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

Make a copy of this sim command.

Returns a newly allocated instance of a DtSimCommand. Override this member function to return a pointer to a newly allocated instance of the derived class.

Implements DtSimCommand.

virtual DtString MySimCommand::messageText

(

)

const [virtual]

virtual void MySimCommand::setMessageText

(

const DtString &

text

)

[virtual]

virtual DtString MySimCommand::stringRep

(

)

const [virtual]

Returns a human-readable string representation of the command.

This string representation is used to display information about the command in the plan editor and viewer. The type and parameters for the command are typically encoded in the string. The format of the string is up to you.

Implements DtSimCommand.

virtual int MySimCommand::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 MySimCommand::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 MySimCommand::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* MySimCommand::creator

(

)

[static]

---

Member Data Documentation

DtRwString MySimCommand::myMessageText [protected]

---

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

• examples/addSimCommand/addSimCommandSim/mySimCommand.h