Inheritance diagram for DtAbandonPlanCommand:

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
virtual const DtSimCommandMessageType &	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.
Public Member Functions inherited from DtSimCommand
virtual	~DtSimCommand ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual DtSimCommand *	clone () const
	Version of clone that preserves the existing name, and assigns a null parent registry.
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual char *	netRep ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtSimCommand *	creator ()
Static Public Member Functions inherited from DtSimCommand
static DtSimCommand *	createSimCommand (DtlObjPtr mtlStream)
	Static functions.
static DtSimCommand *	createSimCommand (const DtSimCommandMessageType &simCommandType)
static void	addSimCommandCreatorFcn (const DtSimCommandMessageType &simCommandName, DtSimCommandCreatorFcn fcn)
	Adds a simCommand creator member function to the simCommand factory.
static void	setFactory (DtSimCommandFactory *factory)
static DtSimCommandFactory *	factory ()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.

Protected Attributes
DtRwString	myObjectName
Protected Attributes inherited from DtSimCommand
char *	myNetRep
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Member Functions inherited from DtSimCommand
	DtSimCommand ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSimCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a command 'put' itself, the write name will preface the command.
	DtSimCommand (const DtString &writeName, const DtSimCommand &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimCommand &	operator= (const DtSimCommand &orig)
	assignment operator; same as copy constructor
virtual char *	createNetworkBuffer ()
virtual bool	isTypeRegistered (const DtSimCommandMessageType &commandType)
Static Protected Attributes inherited from DtSimCommand
static DtSimCommandFactory *	myFactory

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

virtual const DtSimCommandMessageType& 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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation