DtSimBlock Class Reference

class DtSimBlock: More...

Inheritance diagram for DtSimBlock:

Public Member Functions
	DtSimBlock ()
	default constructor
	DtSimBlock (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtSimBlock (const DtSimBlock &orig)
	default copy constructor NOTE: this does a deep copy of the statements.
	DtSimBlock (const DtString &name, const DtSimBlock &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	better copy constructor NOTE: this does a deep copy of the statements.
virtual	~DtSimBlock ()
	destructor NOTE: this DELETES the contained statements.
DtSimBlock &	operator= (const DtSimBlock &orig)
	assignment operator NOTE: this deletes the old statements and does a deep copy of the new ones.
virtual DtSimBlock *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const =0
	The normal clone function.
DtSimBlock *	clone () const
	This clone re-uses the current DtSimBlock's name, but does not register in its parent's plan or registry.
DtSimStatement *	firstStmt () const
	Same as firstObj(), except also downcasts.
DtSimStatement *	lastStmt () const
	Same as lastObj(), except also downcasts.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	This special version of getData creates the necessary list element object using the DtSimStatement::statementFactory, tells the statement to getSelf, and then adds the statement to the DtRwIntrusiveList.
virtual void	exitFromBlock (DtPlan &)=0
	This function is called by the last statement in the block so that the block can do whatever is appropriate at the end of this block.
virtual bool	translateIndex (DtStmtIndex &stmtIndex) const
	If you have a DtStmtIndex object that used to point into the original DtSimBlock before it was copied/cloned into this one, use the translateIndex function to convert it to point into this Block.
virtual void	translateIndices (DtList &stmtIndexList) const
	If you have a list of DtStmtIndex objects that used to point into the original DtSimBlock before it was copied/cloned into this one, use the translateIndicies function to convert them to point into this Block.
virtual DtSimStatement *	lookupStatement (DtStmtIdType statementId)
	Looks up a statement with the given Id.
virtual DtRecursiveSimBlockIterator *	spawnRecursiveIterator () const
	Spawns an iterator that iterates over the elements in this sim block, and all their children, sub children, etc.
virtual bool	validate ()
	Calls validate() on all statements within the block.
virtual bool	isSameBlock (DtSimBlock *rhs)
	Returns true if all sub statements are the same.
Public Member Functions inherited from DtRwIntrusiveList
	DtRwIntrusiveList ()
	default constructor
	DtRwIntrusiveList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwIntrusiveList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwIntrusiveList (const DtString &name, const DtRwIntrusiveList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor. Elements are not copied.
	DtRwIntrusiveList (const DtSymbolString &name, const DtRwIntrusiveList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwIntrusiveList ()
	destructor Note: for consistency with other list classes, this destructor will NOT delete the data objects contained by the list.
DtRwIntrusiveList &	operator= (const DtRwIntrusiveList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
DtRwListedObj *	firstObj () const
	Return first and last item on the list.
DtRwListedObj *	lastObj () const
DtListItem *	first () const
	Return first and last item on the list.
DtListItem *	last () const
unsigned	count () const
	Returns the number of elements in the list.
DtListItem *	add (DtRwListedObj *data)
	Add element to the end of the list.
DtListItem *	addToStart (DtRwListedObj *data)
	Add element to the beginning of the list.
DtListItem *	addToEnd (DtRwListedObj *data)
	Add element to the end of the list.
DtListItem *	addBefore (DtRwListedObj *data, DtRwListedObj *before)
	Add element to the list just before the indicated object.
DtListItem *	addAfter (DtRwListedObj *data, DtRwListedObj *after)
	Add element to the list just after the indicated object.
DtRwListedObj *	remove (DtRwListedObj *data)
	Remove an element from the list.
virtual DtRwListedObj *	remove (DtListItem *item)
	Remove an element from the list.
void	removeAndDelete (DtRwListedObj *data)
	Remove and delete an element from the list.
virtual void	removeAndDelete (DtListItem *item)
	Remove and delete an element from the list.
virtual void	removeAll ()
	Calls remove for all elements in the list.
virtual void	removeAllAndDelete ()
	Same as removeAll, except that this DOES delete the data in the list.
DtListItem *	itemLookup (DtRwListedObj *data) const
	Returns the DtListItem envelope object containing the indicated data element.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Reads the contents of the list, using the list-specific getData function below.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
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	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.

Protected Member Functions
virtual DtListItem *	addToList (DtRwListedObj *data, DtRwListedObj *after)
	Add element to the list just after the indicated item.
virtual void	cloneListFrom (const DtSimBlock &other)
	This function will clone the statements from the given statement list.
Protected Member Functions inherited from DtRwIntrusiveList
	DtRwIntrusiveList (const DtRwIntrusiveList &orig)
	C++ copy constructor Not implemented, do not call.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.

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 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.
static DtReaderWriterFactory *	factory ()
Protected Attributes inherited from DtRwIntrusiveList
DtList	myList
	The actual DtList used to store the items.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

class DtSimBlock:

Instances of DtSimBlock represents blocks of DtSimStatements.

Constructor & Destructor Documentation

DtSimBlock::DtSimBlock

(

)

default constructor

DtSimBlock::DtSimBlock	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

real constructor

DtSimBlock::DtSimBlock

(

const DtSimBlock &

orig

)

default copy constructor NOTE: this does a deep copy of the statements.

DtSimBlock::DtSimBlock	(	const DtString &	name,
		const DtSimBlock &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

better copy constructor NOTE: this does a deep copy of the statements.

virtual DtSimBlock::~DtSimBlock ( )

virtual

destructor NOTE: this DELETES the contained statements.

Member Function Documentation

DtSimBlock& DtSimBlock::operator=

(

const DtSimBlock &

orig

)

assignment operator NOTE: this deletes the old statements and does a deep copy of the new ones.

virtual DtSimBlock* DtSimBlock::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

pure virtual

The normal clone function.

Clones blocks. This is not normally done outside of the DtPlan or DtSimStatement that owns them.

Implemented in DtIfBlock, DtWhileBlock, DtWhenBlock, and DtPlanBlock.

DtSimBlock * DtSimBlock::clone ( ) const

inline

This clone re-uses the current DtSimBlock's name, but does not register in its parent's plan or registry.

Inline functions.

References DtReaderWriter::name().

DtSimStatement * DtSimBlock::firstStmt ( ) const

inline

Same as firstObj(), except also downcasts.

firstStmt() and lastStmt() are wrapper functions that make it easier to access the DtSimStatements inside the block without having to cast the pointers returned by the firstObj() and lastObj() member functions. Once you have a DtSimStatement pointer, you can loop through the list of statements using the DtSimStatement::nextStmt() and DtSimStatement::prevStmt() member functions.

References DtRwIntrusiveList::firstObj().

DtSimStatement * DtSimBlock::lastStmt ( ) const

inline

Same as lastObj(), except also downcasts.

References DtRwIntrusiveList::lastObj().

virtual DtlObjPtr DtSimBlock::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

This special version of getData creates the necessary list element object using the DtSimStatement::statementFactory, tells the statement to getSelf, and then adds the statement to the DtRwIntrusiveList.

The return value is ignored.

Implements DtRwIntrusiveList.

virtual void DtSimBlock::exitFromBlock ( DtPlan &  )

pure virtual

This function is called by the last statement in the block so that the block can do whatever is appropriate at the end of this block.

Called when the last statement in the block is asked to step to the next statement. Since there are no more statements in the block, the last statement asks the block to finish the step command for it. Any class derived from DtSimBlock must define its own exitFromBlock() member function and different blocks do different things on exit. This function, like the DtSimStatement::execute() and DtSimStatement::step(), takes a DtPlan reference argument for the execution context.

Implemented in DtPlanBlock, DtIfBlock, DtWhenBlock, and DtWhileBlock.

virtual bool DtSimBlock::translateIndex ( DtStmtIndex &  stmtIndex ) const

virtual

If you have a DtStmtIndex object that used to point into the original DtSimBlock before it was copied/cloned into this one, use the translateIndex function to convert it to point into this Block.

Returns true if a match was found, false otherwise.

Reimplemented in DtPlanBlock.

virtual void DtSimBlock::translateIndices ( DtList &  stmtIndexList ) const

virtual

If you have a list of DtStmtIndex objects that used to point into the original DtSimBlock before it was copied/cloned into this one, use the translateIndicies function to convert them to point into this Block.

virtual DtSimStatement* DtSimBlock::lookupStatement ( DtStmtIdType  statementId )

virtual

Looks up a statement with the given Id.

Calls lookupStatement() on each statement.

virtual DtRecursiveSimBlockIterator* DtSimBlock::spawnRecursiveIterator ( ) const

virtual

Spawns an iterator that iterates over the elements in this sim block, and all their children, sub children, etc.

. The caller MUST DELETE the iterator when doen using it!

virtual bool DtSimBlock::validate ( )

virtual

Calls validate() on all statements within the block.

Returns

True only if all statements were validated.

virtual bool DtSimBlock::isSameBlock ( DtSimBlock *  rhs )

virtual

Returns true if all sub statements are the same.

Calls isSameStatement on all sub statements

virtual DtListItem* DtSimBlock::addToList ( DtRwListedObj *  data, DtRwListedObj *  after  )

protectedvirtual

Add element to the list just after the indicated item.

Returns the DtListItem envelope object that contains your new element. NOTE: if this or any other DtRwIntrusiveList functions are used to add a statement to the block, the "data" argument MUST be a DtSimStatement!

Reimplemented from DtRwIntrusiveList.

virtual void DtSimBlock::cloneListFrom ( const DtSimBlock &  other )

protectedvirtual

This function will clone the statements from the given statement list.

Note: it is NOT acceptable to pass "*this" as "other" say, to deepen a shallow list copy. It assumes that this->myList is empty. This is used by the copy constructor(s) as well as by the assignment operator.

---

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

• include/vrfplan/simBlock.h