DtWaitUntilStmt Class Reference

class DtWaitUntilStmt:

Instances of DtWaitUntilStmt represent a statement that will wait at that statement, pausing the plan, until the statement evaluates to true.

Inheritance diagram for DtWaitUntilStmt:

Public Member Functions
	DtWaitUntilStmt (DtReaderWriterRegistry *parentRegistry=NULL)
	DtWaitUntilStmt (const DtWaitUntilStmt &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtWaitUntilStmt ()
DtWaitUntilStmt &	operator= (const DtWaitUntilStmt &orig)
virtual DtSimStatement *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual int	type () const
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 int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	step (DtPlan &planContext, bool forceStep=false)
bool	triggered () const
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 bool	validate ()
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 *)
virtual void	upgradeTriggerUUID (const boost::unordered_map< DtUUID, DtUUID > &)
virtual void	reset ()
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) const
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 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)
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
bool	myTriggered
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

DtWaitUntilStmt::DtWaitUntilStmt

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

default constructor

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

copy constructor

virtual DtWaitUntilStmt::~DtWaitUntilStmt ( )

virtual

destructor

Member Function Documentation

DtWaitUntilStmt& DtWaitUntilStmt::operator=

(

const DtWaitUntilStmt &

orig

)

assignment operator

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

virtual

virtual copy constructor

Implements DtSimStatement.

virtual int DtWaitUntilStmt::type ( ) const

virtual

Returns DtWaitUntilStatementType (defined in simStmtTypes.h)

Implements DtSimStatement.

virtual void DtWaitUntilStmt::execute ( DtPlan &  planContext )

virtual

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

Implements DtSimStatement.

virtual int DtWaitUntilStmt::subBlockCount ( ) const

virtual

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

Reimplemented from DtSimStatement.

virtual DtSimBlock* DtWaitUntilStmt::subBlock ( int  index )

virtual

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

Reimplemented from DtSimStatement.

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

virtual

Get a readable string representation of this wait until statement.

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

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

Implements DtSimStatement.

virtual const DtSimCondExpr* DtWaitUntilStmt::condExpr ( ) const

virtual

Returns the conditional expression used to evaluate the wait until.

Implements DtSimConditionalStatement.

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

virtual

Sets the conditional expression used to evaluate the wait until.

Implements DtSimConditionalStatement.

virtual int DtWaitUntilStmt::netRepSize ( ) const

virtual

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

Reimplemented from DtSimStatement.

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

virtual

Fills in the request from the network buffer.

Reimplemented from DtSimStatement.

virtual bool DtWaitUntilStmt::setToNet ( )

virtual

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

Reimplemented from DtSimStatement.

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

virtual

Steps to the next statement by setting the plan context’s current statement, based on the result of the test.

Reimplemented from DtSimStatement.

bool DtWaitUntilStmt::triggered ( ) const

inline

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

static

Creator function to be registered with DtStatementFactory.

virtual bool DtWaitUntilStmt::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 DtWaitUntilStmt::myCondExpr

protected

bool DtWaitUntilStmt::myTriggered

protected

---

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

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