DtWhileStmt Class Reference

8 bytes total More...

Inheritance diagram for DtWhileStmt:

Public Member Functions
	DtWhileStmt (DtReaderWriterRegistry *parentRegistry=NULL)
	default constructor
	DtWhileStmt (const DtWhileStmt &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtWhileStmt ()
	destructor
DtWhileStmt &	operator= (const DtWhileStmt &orig)
	assignment operator
virtual DtSimStatement *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
	virtual copy constructor
virtual int	type () const
	Returns DtWhileStatementType (defined in simStmtTypes.h)
virtual bool	validate ()
	Checks to see if the while block is empty, and if so, adds a noop statement to it.
virtual void	execute (DtPlan &planContext)
	Evaluates the conditional expression and if true pushes the plan's execution stack and executes the while block.
virtual int	subBlockCount () const
	While statements only support one block, so this always returns one.
virtual DtSimBlock *	subBlock (int index)
	If the first block (index 0) is requested, myBlock is returned.
virtual DtString	stringRep (int subBlockIndex=DtSR_STMT) const
	Get a readable string representation of this While statement.
virtual const DtSimCondExpr *	condExpr () const
	Returns the conditional expression used to evaluate the while.
virtual void	setCondExpr (DtSimCondExpr *arg)
	Sets the conditional expression used to evaluate the while.
virtual DtWhileBlock *	whileBlock () const
virtual void	setWhileBlock (DtWhileBlock *arg)
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary.
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 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 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
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 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 DtSimStatement *	creator (DtReaderWriterRegistry *parentRegistry=NULL)
	Creator function to be registered with DtStatementFactory.
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 Member Functions
virtual bool	compare (DtSimStatement *rhs)
	Called from isSameStatement.
Protected Member Functions inherited from DtSimStatement
virtual char *	createNetworkBuffer ()

Protected Attributes
DtRwCondExpr	myCondExpr
DtWhileBlock *	myBlock
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
Static Public Attributes inherited from DtSimStatement
static const int	DtSR_STMT = -1
	A constant for use as the subBlockIndex argument to stringRep().
Static Protected Attributes inherited from DtSimStatement
static DtStatementFactory *	myFactory
	Factory for this class.
static DtStringIntMapper	theStatementNameMapper

Detailed Description

8 bytes total

class DtWhileStmt:

Instances of DtWhileStmt represent a while loop. They contain one conditional expression and one sub-block which will be executed as long as the condition evaluates to True.

Constructor & Destructor Documentation

DtWhileStmt::DtWhileStmt

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

default constructor

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

copy constructor

virtual DtWhileStmt::~DtWhileStmt ( )

virtual

destructor

Member Function Documentation

DtWhileStmt& DtWhileStmt::operator=

(

const DtWhileStmt &

orig

)

assignment operator

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

virtual

virtual copy constructor

Implements DtSimStatement.

virtual int DtWhileStmt::type ( ) const

virtual

Returns DtWhileStatementType (defined in simStmtTypes.h)

Implements DtSimStatement.

virtual bool DtWhileStmt::validate ( )

virtual

Checks to see if the while block is empty, and if so, adds a noop statement to it.

The plan executor cannot handle empty while blocks.

Reimplemented from DtSimStatement.

virtual void DtWhileStmt::execute ( DtPlan &  planContext )

virtual

Evaluates the conditional expression and if true pushes the plan's execution stack and executes the while block.

Implements DtSimStatement.

virtual int DtWhileStmt::subBlockCount ( ) const

virtual

While statements only support one block, so this always returns one.

Reimplemented from DtSimStatement.

virtual DtSimBlock* DtWhileStmt::subBlock ( int  index )

virtual

If the first block (index 0) is requested, myBlock is returned.

Reimplemented from DtSimStatement.

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

virtual

Get a readable string representation of this While statement.

The subBlockIndex argument indicates which stringRep to get as a prefix for a given sub-block. For a While statement, the first (0) sub-block's prefix is the "while (...) do" part, and if a subBlockIndex value of DtSimStatement::DtSR_STMT is given, the "endwhile" part is returned.

See the documentation for DtSimStatement::stringRep for more information.

Implements DtSimStatement.

virtual const DtSimCondExpr* DtWhileStmt::condExpr ( ) const

virtual

Returns the conditional expression used to evaluate the while.

virtual void DtWhileStmt::setCondExpr ( DtSimCondExpr *  arg )

virtual

Sets the conditional expression used to evaluate the while.

virtual DtWhileBlock* DtWhileStmt::whileBlock ( ) const

virtual

virtual void DtWhileStmt::setWhileBlock ( DtWhileBlock *  arg )

virtual

virtual int DtWhileStmt::netRepSize ( ) const

virtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSimStatement.

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

virtual

Fills in the request from the network buffer.

Reimplemented from DtSimStatement.

virtual bool DtWhileStmt::setToNet ( )

virtual

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

Network buffer is filled in as follows:

DtNetSimStatement DtNetWhileStatment <statement data 1> . . . <statement data="" n>="">

n is the number of top-level statements in the while block, and statement data is the net representation of a DtSimStatement.

Reimplemented from DtSimStatement.

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

static

Creator function to be registered with DtStatementFactory.

virtual bool DtWhileStmt::compare ( DtSimStatement *  )

protectedvirtual

Called from isSameStatement.

Compares net reps to see if they are the same. Override to do different comparrison

Reimplemented from DtSimStatement.

Member Data Documentation

DtRwCondExpr DtWhileStmt::myCondExpr

protected

DtWhileBlock* DtWhileStmt::myBlock

protected

---

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

• include/vrfplan/whileStmt.h