DtDeleteObjectCommand Class Reference

DtSimCommand subclass for deleting a named object. More...

Inheritance diagram for DtDeleteObjectCommand:

List of all members.

Public Member Functions
	DtDeleteObjectCommand ()
	Default constructor.
	DtDeleteObjectCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor.
	DtDeleteObjectCommand (const DtString &writeName, const DtDeleteObjectCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtDeleteObjectCommand (const DtDeleteObjectCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	An override for the default constructor.
virtual	~DtDeleteObjectCommand ()
	destructor
DtDeleteObjectCommand &	operator= (const DtDeleteObjectCommand &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	objectName () const
	Name of the object to delete.
virtual void	setObjectName (const DtString &name)
	Name of the object to delete.
virtual bool	doDeleteSelf () const
	Flag indicating whether this command is to delete self, rather than an object in myObjectName.
virtual void	setDoDeleteSelf (const bool doDelete)
	Flag indicating whether this command is to delete self, rather than an object in myObjectName.
Static Public Member Functions
static DtSimCommand *	creator ()
	Returns a new instance of this class.
Protected Attributes
DtRwString	myObjectName
DtRwBoolean	myDeleteSelf

---

Detailed Description

DtSimCommand subclass for deleting a named object.

---

Constructor & Destructor Documentation

DtDeleteObjectCommand::DtDeleteObjectCommand

(

)

Default constructor.

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

Usual constructor.

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

copy constructor

DtDeleteObjectCommand::DtDeleteObjectCommand	(	const DtDeleteObjectCommand &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

An override for the default constructor.

virtual DtDeleteObjectCommand::~DtDeleteObjectCommand

(

)

[virtual]

destructor

---

Member Function Documentation

DtDeleteObjectCommand& DtDeleteObjectCommand::operator=

(

const DtDeleteObjectCommand &

orig

)

assignment operator

int DtDeleteObjectCommand::type

(

)

const [virtual]

Returns:

DtDeleteObjectCommandType.

Implements DtSimCommand.

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

Returns:

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

Implements DtSimCommand.

virtual DtString DtDeleteObjectCommand::objectName

(

)

const [virtual]

Name of the object to delete.

virtual void DtDeleteObjectCommand::setObjectName

(

const DtString &

name

)

[virtual]

Name of the object to delete.

virtual bool DtDeleteObjectCommand::doDeleteSelf

(

)

const [virtual]

Flag indicating whether this command is to delete self, rather than an object in myObjectName.

virtual void DtDeleteObjectCommand::setDoDeleteSelf

(

const bool

doDelete

)

[virtual]

Flag indicating whether this command is to delete self, rather than an object in myObjectName.

virtual DtString DtDeleteObjectCommand::stringRep

(

)

const [virtual]

Text representation of this command.

Implements DtSimCommand.

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

(

)

[static]

Returns a new instance of this class.

---

Member Data Documentation

DtRwString DtDeleteObjectCommand::myObjectName [protected]

DtRwBoolean DtDeleteObjectCommand::myDeleteSelf [protected]

---

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

• include/vrfplan/deleteObjectCommand.h