DtAbandonPlanCommand Class Reference

class DtAbandonPlanCommand: More...

Inheritance diagram for DtAbandonPlanCommand:

List of all members.

Public Member Functions
	DtAbandonPlanCommand ()
	default constructor
	DtAbandonPlanCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor.
	DtAbandonPlanCommand (const DtString &writeName, const DtAbandonPlanCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtAbandonPlanCommand ()
	destructor
	DtAbandonPlanCommand (const DtAbandonPlanCommand &orig)
	copy constructor
DtAbandonPlanCommand &	operator= (const DtAbandonPlanCommand &orig)
	assignment operator
int	type () const
	Returns the type of Interface Content.
virtual DtSimCommand *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
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	stringRep () const
	Text representation of this command.
virtual const DtString &	objectName () const
	Name of the object to abandon the plan for.
virtual void	setObjectName (const DtString &name)
	Name of the object to abandon the plan for.
Static Public Member Functions
static DtSimCommand *	creator ()
Protected Attributes
DtRwString	myObjectName

---

Detailed Description

class DtAbandonPlanCommand:

Instances of DtAbandonPlanCommand are the content portion of requests to abandon the Plan associated with a given entity.

Content-Type: DtAbandonPlanCommandType

Parameters: object name - the name DtString that identifies the entity whose plan should be abandoned.

---

Constructor & Destructor Documentation

DtAbandonPlanCommand::DtAbandonPlanCommand

(

)

default constructor

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

Usual constructor.

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

copy constructor

virtual DtAbandonPlanCommand::~DtAbandonPlanCommand

(

)

[virtual]

destructor

DtAbandonPlanCommand::DtAbandonPlanCommand

(

const DtAbandonPlanCommand &

orig

)

copy constructor

---

Member Function Documentation

DtAbandonPlanCommand& DtAbandonPlanCommand::operator=

(

const DtAbandonPlanCommand &

orig

)

assignment operator

int DtAbandonPlanCommand::type

(

)

const [virtual]

Returns the type of Interface Content.

Implements DtSimCommand.

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

Returns:

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

Implements DtSimCommand.

virtual const DtString& DtAbandonPlanCommand::objectName

(

)

const [virtual]

Name of the object to abandon the plan for.

virtual void DtAbandonPlanCommand::setObjectName

(

const DtString &

name

)

[virtual]

Name of the object to abandon the plan for.

virtual int DtAbandonPlanCommand::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 DtAbandonPlanCommand::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 DtAbandonPlanCommand::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.

virtual DtString DtAbandonPlanCommand::stringRep

(

)

const [virtual]

Text representation of this command.

Implements DtSimCommand.

static DtSimCommand* DtAbandonPlanCommand::creator

(

)

[static]

---

Member Data Documentation

DtRwString DtAbandonPlanCommand::myObjectName [protected]

---

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

• include/vrfplan/abandonPlanCommand.h