DtSetDataCommand Class Reference

DtSimCommand subclass sending DtSetDataRequests to an object. More...

Inheritance diagram for DtSetDataCommand:

List of all members.

Public Member Functions
	DtSetDataCommand ()
	Default constructor.
	DtSetDataCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor.
	DtSetDataCommand (const DtString &writeName, const DtSetDataCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtSetDataCommand ()
	destructor
DtSetDataCommand &	operator= (const DtSetDataCommand &orig)
	assignment operator
int	type () const
virtual DtSimCommand *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual const DtSetDataRequest *	setRequest () const
	The set request contained by the command.
virtual void	setSetRequest (const DtSetDataRequest *setReq)
	Sets the set request for this command. The set request will be cloned.
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	objectName () const
	Name of the object to delete.
virtual void	setObjectName (const DtString &name)
	Name of the object to delete.
Static Public Member Functions
static DtSimCommand *	creator ()
	Returns a new instance of this class.
Protected Member Functions
virtual void	putData (FILE *fp, int indentLevel=0)
	Overridden to manage the contained set request in the file.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Overridden to manage the contained set request in the file.
Protected Attributes
DtRwString	myObjectName
DtSetDataRequest *	mySetRequest

---

Detailed Description

DtSimCommand subclass sending DtSetDataRequests to an object.

This command contains a DtSetDataRequest, which is sent to the entity upon execution of this command.

---

Constructor & Destructor Documentation

DtSetDataCommand::DtSetDataCommand

(

)

Default constructor.

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

Usual constructor.

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

copy constructor

virtual DtSetDataCommand::~DtSetDataCommand

(

)

[virtual]

destructor

---

Member Function Documentation

DtSetDataCommand& DtSetDataCommand::operator=

(

const DtSetDataCommand &

orig

)

assignment operator

int DtSetDataCommand::type

(

)

const [virtual]

Returns:

DtSetDataCommandType.

Implements DtSimCommand.

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

Returns:

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

Implements DtSimCommand.

virtual DtString DtSetDataCommand::objectName

(

)

const [virtual]

Name of the object to delete.

virtual void DtSetDataCommand::setObjectName

(

const DtString &

name

)

[virtual]

Name of the object to delete.

virtual const DtSetDataRequest* DtSetDataCommand::setRequest

(

)

const [virtual]

The set request contained by the command.

virtual void DtSetDataCommand::setSetRequest

(

const DtSetDataRequest *

setReq

)

[virtual]

Sets the set request for this command. The set request will be cloned.

virtual DtString DtSetDataCommand::stringRep

(

)

const [virtual]

Text representation of this command.

Implements DtSimCommand.

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

(

)

[static]

Returns a new instance of this class.

virtual void DtSetDataCommand::putData	(	FILE *	fp,
		int	indentLevel = 0
	)		[protected, virtual]

Overridden to manage the contained set request in the file.

Reimplemented from DtSimCommand.

virtual DtlObjPtr DtSetDataCommand::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[protected, virtual]

Overridden to manage the contained set request in the file.

Reimplemented from DtSimCommand.

---

Member Data Documentation

DtRwString DtSetDataCommand::myObjectName [protected]

DtSetDataRequest* DtSetDataCommand::mySetRequest [protected]

---

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

• include/vrfplan/setDataCommand.h