class DtDoUntilStmt:

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

Inheritance diagram for DtDoUntilStmt:

[legend]

Public Member Functions
	DtDoUntilStmt (DtReaderWriterRegistry *parentRegistry=NULL)

	DtDoUntilStmt (const DtDoUntilStmt &orig, DtReaderWriterRegistry *parentRegistry=NULL)

virtual	~DtDoUntilStmt ()

DtDoUntilStmt &	operator= (const DtDoUntilStmt &orig)

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

virtual int	type () const

virtual bool	validate ()

virtual void	execute (DtPlan &planContext)

virtual int	subBlockCount () const

virtual DtSimBlock *	subBlock (int index)

virtual DtString	stringRep (int subBlockIndex=DtSR_STMT) const

virtual const DtSimCondExpr *	condExpr () const

virtual void	setCondExpr (const DtSimCondExpr *arg)

virtual DtDoUntilBlock *	doUntilBlock () const

virtual void	setDoUntilBlock (DtDoUntilBlock *arg)

virtual int	netRepSize () const

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

virtual bool	setToNet ()

virtual void	upgradeTriggerUUID (const boost::unordered_map< DtUUID, DtUUID > &)

virtual void	reset ()

Public Member Functions inherited from DtSimConditionalStatement
	DtSimConditionalStatement (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtSimConditionalStatement (const DtSimConditionalStatement &orig, DtReaderWriterRegistry *parentRegistry=NULL)

virtual	~DtSimConditionalStatement ()

Public Member Functions inherited from DtSimStatement
	DtSimStatement ()

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

	DtSimStatement (const DtSimStatement &orig, DtReaderWriterRegistry *parentRegistry=NULL)

virtual	~DtSimStatement ()

virtual bool	init ()

DtSimStatement &	operator= (const DtSimStatement &orig)

virtual void	step (DtPlan &planContext, bool forceStep=false)

DtSimStatement *	nextStmt () const

DtSimStatement *	prevStmt () const

virtual DtStmtIdType	statementId () const

virtual void	setStatementId (DtStmtIdType arg)

virtual DtSimBlock *	parentBlock () const

virtual void	setParentBlock (DtSimBlock *arg)

virtual DtRecursiveSimStatementIterator *	spawnRecursiveIterator () const

virtual DtSimStatement *	lookupStatement (DtStmtIdType statementId)

virtual void	setStatementDescription (const DtString &)

virtual const DtString &	statementDescription () const

virtual char *	netRep ()

virtual bool	isSameStatement (DtSimStatement *)

Public Member Functions inherited from DtRwListedObj
	DtRwListedObj ()

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

	DtRwListedObj (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRwListedObj (const DtRwListedObj &orig)

virtual	~DtRwListedObj ()

DtRwListedObj &	operator= (const DtRwListedObj &orig)

DtRwListedObj *	next () const

DtRwListedObj *	prev () const

DtRwListedObj *	wrapNext () const

DtRwListedObj *	wrapPrev () const

virtual const char *	readerWriterType () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

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

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static void	evaluateCondExprCallback (DtPlan &plan, void *usrData)

static void	skipTaskCallback (void *usr)

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 DtSimStatement *	createStatement (int statementType, DtReaderWriterRegistry *parentRegistry=NULL)

static void	addStatementCreatorFcn (const DtString &type, int intType, DtStatementCreatorFcn fcn)

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)

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual bool	compare (DtSimStatement *rhs)

void	interrupt (DtPlan &planContext)

virtual void	evaluateConditional (DtPlan &planContext)

virtual void	skipTask ()

Protected Member Functions inherited from DtSimStatement
virtual char *	createNetworkBuffer ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwCondExpr	myCondExpr

DtDoUntilBlock *	myBlock

bool	myIsSkipped

Protected Attributes inherited from DtSimStatement
DtStmtIdType	myStatementId

DtSimBlock *	myParentBlock

char *	myNetRep

DtRwString	myStatementDescription

Protected Attributes inherited from DtRwListedObj
DtList *	myList

DtListItem *	myItem

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

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::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Static Public Attributes inherited from DtSimStatement
static const int	DtSR_STMT = -1

Static Protected Attributes inherited from DtSimStatement
static DtStatementFactory *	myFactory

static DtStringIntMapper	theStatementNameMapper

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtDoUntilStmt::DtDoUntilStmt ( DtReaderWriterRegistry * parentRegistry = NULL )

default constructor

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

copy constructor

virtual DtDoUntilStmt::~DtDoUntilStmt ( )

virtual

destructor

Member Function Documentation

DtDoUntilStmt& DtDoUntilStmt::operator= ( const DtDoUntilStmt & orig )

assignment operator

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

virtual

virtual copy constructor

Implements DtSimStatement.

virtual int DtDoUntilStmt::type ( ) const

virtual

Returns DtDoUntilStatementType (defined in simStmtTypes.h)

Implements DtSimStatement.

virtual bool DtDoUntilStmt::validate ( )

virtual

Checks to see if the do until block is empty, and if so, adds a noop statement to it. The plan executor cannot handle empty do until blocks.

Reimplemented from DtSimStatement.

virtual void DtDoUntilStmt::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 DtDoUntilStmt::subBlockCount ( ) const

virtual

Do until statements only support one block, so this always returns one.

Reimplemented from DtSimStatement.

virtual DtSimBlock* DtDoUntilStmt::subBlock ( int index )

virtual

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

Reimplemented from DtSimStatement.

virtual DtString DtDoUntilStmt::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 Do Until statement, the first (0) sub-block's prefix is the "do until (...)" 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* DtDoUntilStmt::condExpr ( ) const

virtual

Returns the conditional expression used to evaluate the while.

Implements DtSimConditionalStatement.

virtual void DtDoUntilStmt::setCondExpr ( const DtSimCondExpr * arg )

virtual

Sets the conditional expression used to evaluate the while.

Implements DtSimConditionalStatement.

virtual DtDoUntilBlock* DtDoUntilStmt::doUntilBlock ( ) const

virtual

virtual void DtDoUntilStmt::setDoUntilBlock ( DtDoUntilBlock * arg )

virtual

virtual int DtDoUntilStmt::netRepSize ( ) const

virtual

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

Reimplemented from DtSimStatement.

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

virtual

Fills in the request from the network buffer.

Reimplemented from DtSimStatement.

virtual bool DtDoUntilStmt::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.

virtual void DtDoUntilStmt::upgradeTriggerUUID ( const boost::unordered_map< DtUUID, DtUUID > & )

virtual

For those statements that need to, map from the old to new trigger UUID.

Reimplemented from DtSimStatement.

virtual void DtDoUntilStmt::reset ( )

virtual

Called when the plan is reset, will iterate over all statements to reset as well.

Reimplemented from DtSimStatement.

static void DtDoUntilStmt::evaluateCondExprCallback	(	DtPlan &	plan,
		void *	usrData
	)

static

Callback registered with plans for notification when the condition changes.

static void DtDoUntilStmt::skipTaskCallback ( void * usr )

static

The manager will register a callback with its simManager's msg executive requesting notification of Skip Task Interface Requests.

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

static

Creator function to be registered with DtStatementFactory.

virtual bool DtDoUntilStmt::compare ( DtSimStatement * )

protectedvirtual

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

Reimplemented from DtSimStatement.

void DtDoUntilStmt::interrupt ( DtPlan & planContext )

protected

Interrupt the Do Until statement execution by forcing the Plan to go to the next statement Called when skip task and when conditional evaluation is verified on each tick.

virtual void DtDoUntilStmt::evaluateConditional ( DtPlan & planContext )

protectedvirtual

Evaluate the condition expression. If true, it will manipulate the plan context execution stack to put itself as the current statement, thus terminating all lower level statements.

virtual void DtDoUntilStmt::skipTask ( )

protectedvirtual

Member Data Documentation

DtRwCondExpr DtDoUntilStmt::myCondExpr

protected

DtDoUntilBlock* DtDoUntilStmt::myBlock

protected

bool DtDoUntilStmt::myIsSkipped

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfplan/doUntilStmt.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation