DtSimCommandStmt Class Reference

Instances of DtSimCommandStmt represent a single sim-command in a DtPlan. More...

Inheritance diagram for DtSimCommandStmt:

Public Member Functions
	DtSimCommandStmt (DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor.
	DtSimCommandStmt (const DtSimCommandStmt &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtSimCommandStmt ()
	destructor
DtSimCommandStmt &	operator= (const DtSimCommandStmt &orig)
	assignment operator
virtual DtSimStatement *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
	virtual copy constructor
virtual int	type () const
	Returns DtTaskStatementType (defined in simStmtTypes.h)
virtual void	execute (DtPlan &planContext)
	Execute the current statement and make any changes to the Plan state as appropriate.
virtual DtString	stringRep (int subBlockIndex=DtSR_STMT) const
	Get a readable string representation of this Task statement.
virtual DtSimCommand *	simCommand () const
	Get the current DtSimCommand.
virtual void	setSimCommand (DtSimCommand *arg)
	Set the DtSimCommand. This will clone() its own copy.
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Note: Task statements override putSelf and getSelf so that they can avoid an extra level of nesting in the save file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	DtReaderWriter member function that reads the task as if it were a statement object itself.
virtual int	netRepSize () const
	Returns the size of the full network representation.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the request from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class sim statement) with the set data request contents.
Public Member Functions inherited from DtSimStatement
	DtSimStatement ()
	Default constructor.
	DtSimStatement (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor NOTE: "name" should be the statement type string.
	DtSimStatement (const DtSimStatement &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor.
virtual	~DtSimStatement ()
	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.
DtSimStatement &	operator= (const DtSimStatement &orig)
	Assignment operator (protected because this is an abstract base class).
virtual bool	validate ()
	Checks the statement for validity, and potentially fixes the statement to be valid.
virtual void	step (DtPlan &planContext)
	Asks the statement to step the context DtPlan to the next statement.
virtual bool	translateIndex (DtStmtIndex &index)
	Translate an old statement index pointer to point to a statement in the current Plan.
virtual void	translateIndices (const DtList &indices)
	Same as translateIndex, except it operates on a DtList of DtStmtIndex's, and doesn't return a value.
DtSimStatement *	nextStmt () const
	Return next (previous) statements in the block, or NULL if hit the end (beginning) of the list.
DtSimStatement *	prevStmt () const
virtual DtStmtIdType	statementId () const
	Statement Id accessors.
virtual void	setStatementId (DtStmtIdType arg)
virtual DtSimBlock *	parentBlock () const
	The parent statement Block.
virtual void	setParentBlock (DtSimBlock *arg)
virtual int	subBlockCount () const
	Get the number of blocks nested inside this statement.
virtual DtSimBlock *	subBlock (int index)
	Get a pointer to any particular block nested inside this statement.
virtual DtRecursiveSimStatementIterator *	spawnRecursiveIterator () const
	Spawns an iterator that iterates over the subblocks in this statement, and all their children, sub children, etc.
virtual DtSimStatement *	lookupStatement (DtStmtIdType statementId)
	If statementId matches our statement, returns a pointer to us.
virtual char *	netRep ()
virtual bool	isSameStatement (DtSimStatement *)
	Returns true if statements are equivalent. Will not check statementId.
Public Member Functions inherited from DtRwListedObj
	DtRwListedObj ()
	Default constructor.
	DtRwListedObj (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Real constructor.
	DtRwListedObj (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwListedObj (const DtRwListedObj &orig)
	Copy constructor.
virtual	~DtRwListedObj ()
	Destructor.
DtRwListedObj &	operator= (const DtRwListedObj &orig)
	Assignment operator.
DtRwListedObj *	next () const
	Return next (previous) elements on the list, or NULL if hit the end (beginning) of the list.
DtRwListedObj *	prev () const
DtRwListedObj *	wrapNext () const
	Return next (previous) elements on the list, but wrap to the beginning (end) of the list when you hit the end (beginning).
DtRwListedObj *	wrapPrev () const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
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 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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
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 DtSimStatement *	creator (DtReaderWriterRegistry *parentRegistry=NULL)
Static Public Member Functions inherited from DtSimStatement
static DtStmtIdType	generateNewStmtId ()
static DtSimStatement *	createStatement (DtlObjPtr mtlStream, DtReaderWriterRegistry *parentRegistry=NULL)
	Static functions.
static DtSimStatement *	createStatement (int statementType, DtReaderWriterRegistry *parentRegistry=NULL)
static void	addStatementCreatorFcn (const DtString &type, int intType, DtStatementCreatorFcn fcn)
	Decodes a legacy stealth statement (VRF 3.9 and previous) and returns the proper statement for the current version.
static void	setFactory (DtStatementFactory *factory)
static DtStatementFactory *	factory ()
static bool	getStatementNameFromStatementType (int statementType, DtString &statementName)
static bool	getStatementTypeFromStatementName (const DtString &statementName, int &statementType)
static bool	addStatementTypeMapping (const DtString &statementName, int taskType)
static bool	removeStatementTypeMapping (const DtString &statementName, int statementType)

Protected Attributes
DtSimCommand *	mySimCommand
Protected Attributes inherited from DtSimStatement
DtStmtIdType	myStatementId
	A semi-unique Id value that helps trace the original identity of this statement if/when it gets copied.
DtSimBlock *	myParentBlock
	The containing DtSimBlock object (if any).
char *	myNetRep
Protected Attributes inherited from DtRwListedObj
DtList *	myList
DtListItem *	myItem
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
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Attributes inherited from DtSimStatement
static const int	DtSR_STMT = -1
	A constant for use as the subBlockIndex argument to stringRep().
Protected Member Functions inherited from DtSimStatement
virtual char *	createNetworkBuffer ()
virtual bool	compare (DtSimStatement *)
	Called from isSameStatement.
Static Protected Attributes inherited from DtSimStatement
static DtStatementFactory *	myFactory
	Factory for this class.
static DtStringIntMapper	theStatementNameMapper

Detailed Description

Instances of DtSimCommandStmt represent a single sim-command in a DtPlan.

Constructor & Destructor Documentation

DtSimCommandStmt::DtSimCommandStmt

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

Usual constructor.

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

copy constructor

virtual DtSimCommandStmt::~DtSimCommandStmt ( )

virtual

destructor

Member Function Documentation

DtSimCommandStmt& DtSimCommandStmt::operator=

(

const DtSimCommandStmt &

orig

)

assignment operator

virtual DtSimStatement* DtSimCommandStmt::clone ( DtReaderWriterRegistry *  parentRegistry = NULL ) const

virtual

virtual copy constructor

Implements DtSimStatement.

virtual int DtSimCommandStmt::type ( ) const

virtual

Returns DtTaskStatementType (defined in simStmtTypes.h)

Implements DtSimStatement.

virtual void DtSimCommandStmt::execute ( DtPlan &  planContext )

virtual

Execute the current statement and make any changes to the Plan state as appropriate.

Implements DtSimStatement.

virtual DtString DtSimCommandStmt::stringRep ( int  subBlockIndex = DtSR_STMT ) const

virtual

Get a readable string representation of this Task statement.

The subBlockIndex argument indicates which stringRep to get if this statement could have sub-blocks. Since a Task statement cannot have sub-blocks, a useful string representation will only be returned if the subBlockIndex argument has the value DtSimStatement::DtSR_STMT. See the documentation for DtSimStatement::stringRep for more details.

Implements DtSimStatement.

virtual DtSimCommand* DtSimCommandStmt::simCommand ( ) const

virtual

Get the current DtSimCommand.

virtual void DtSimCommandStmt::setSimCommand ( DtSimCommand *  arg )

virtual

Set the DtSimCommand. This will clone() its own copy.

virtual void DtSimCommandStmt::putSelf ( FILE *  fp, int  indentLevel = 0, bool  writeUnspecified = false, const DtFilename &  path = DtReaderWriter::appPath()  )

virtual

Note: Task statements override putSelf and getSelf so that they can avoid an extra level of nesting in the save file.

DtReaderWriter member function that writes the command as if it were a statement object itself. It calls DtSimTask::putself().

Reimplemented from DtReaderWriter.

virtual void DtSimCommandStmt::getSelf ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

DtReaderWriter member function that reads the task as if it were a statement object itself.

It calls DtSimCommand::createSimCommand().

virtual int DtSimCommandStmt::netRepSize ( ) const

virtual

Returns the size of the full network representation.

Reimplemented from DtSimStatement.

virtual bool DtSimCommandStmt::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Fills in the request from the network buffer.

Reimplemented from DtSimStatement.

virtual bool DtSimCommandStmt::setToNet ( )

virtual

Fills in the network buffer (created by base class sim statement) with the set data request contents.

Reimplemented from DtSimStatement.

static DtSimStatement* DtSimCommandStmt::creator ( DtReaderWriterRegistry *  parentRegistry = NULL )

static

Member Data Documentation

DtSimCommand* DtSimCommandStmt::mySimCommand

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfplan/simCommandStmt.h