DtTriggerStmt Class Reference

Inheritance diagram for DtTriggerStmt:

Public Member Functions
	DtTriggerStmt (DtReaderWriterRegistry *parentRegistry=NULL)
	default constructor
	DtTriggerStmt (const DtTriggerStmt &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtTriggerStmt ()
	destructor
DtTriggerStmt &	operator= (const DtTriggerStmt &orig)
	assignment operator
virtual DtSimStatement *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
	virtual copy constructor
virtual int	type () const
	Returns DtWhenStatementType (defined in simStmtTypes.h)
virtual void	execute (DtPlan &planContext)
	Execute the current statement and make any changes to the Plan state as appropriate.
virtual int	subBlockCount () const
	Get the number of blocks nested inside this statement.
virtual DtSimBlock *	subBlock (int index)
	Get the a pointer to each particular block nested inside this statement.
virtual DtString	stringRep (int subBlockIndex=DtSR_STMT) const
	Get a readable string representation of this When statement.
virtual void	exitFromTrigger (DtPlan &planContext)
	The exitFromTrigger function is called when the trigger "When" block is complete, handles popping the plan's trigger stack if the "ReTask" option is given.
virtual const DtUUID &	triggerUUID () const
virtual void	setTriggerUUID (const DtUUID &)
virtual DtString	triggerName () const
	Name of this trigger. Either short description or conditional full text.
virtual const DtSimCondExpr *	condExpr () const
	Returns the conditional expression used to evaluate the wait until.
virtual void	setCondExpr (const DtSimCondExpr *arg)
	Sets the conditional expression used to evaluate the wait until.
virtual const DtString &	option () const
	Get the option value, if any (ie.
virtual void	setOption (const DtString &arg)
	Set the option value (eg. "ReTask" or "").
virtual DtTriggerBlock *	triggerBlock () const
virtual void	setTriggerBlock (DtTriggerBlock *arg)
virtual void	setReregisterTrigger (bool)
	Whether or not to re-register trigger once trigger has fired. Default is false.
virtual bool	reregisterTrigger () const
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.
virtual void	upgradeTriggerUUID (const boost::unordered_map< DtUUID, DtUUID > &)
	For those statements that need to, map from the old to new trigger UUID.
Public Member Functions inherited from DtSimConditionalStatement
	DtSimConditionalStatement (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	default constructor
	DtSimConditionalStatement (const DtSimConditionalStatement &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
virtual	~DtSimConditionalStatement ()
	destructor
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, bool forceStep=false)
	Asks the statement to step the context DtPlan to the next statement.
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 void	setStatementDescription (const DtString &)
	If supported for display a description of this statement that can be used for display.
virtual const DtString &	statementDescription () const
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtSimStatement *	creator (DtReaderWriterRegistry *parentRegistry=NULL)

Protected Types
typedef boost::unordered_map < DtUUID, DtTriggerStatementUUIDMarkingTextProvider * >	NamedTriggers

Protected Member Functions
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	compare (DtSimStatement *)
	Called from isSameStatement.

Static Protected Member Functions
static void	addTriggerMarkingTextMapping (DtTriggerStmt *)
	Since triggers can be copied around and multiples with the same UUID can reference different triggers, keep track of overall registrations here to manage with main UUID marking text manager for adding/removing.
static void	removeTriggerMarkingTextMapping (DtTriggerStmt *)
static DtString	nextDefaultTriggerMarkingText ()
	Increase global variable count and append to "Trigger".

Protected Attributes
DtRwUUID	myTriggerUUID
DtRwCondExpr	myCondExpr
DtRwString	myOption
DtTriggerBlock *	myBlock
DtRwBoolean	myReregisterTrigger

Static Protected Attributes
static NamedTriggers	theNamedTriggers

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
	A constant for use as the subBlockIndex argument to stringRep().

Member Typedef Documentation

typedef boost::unordered_map<DtUUID, DtTriggerStatementUUIDMarkingTextProvider*> DtTriggerStmt::NamedTriggers

protected

Constructor & Destructor Documentation

DtTriggerStmt::DtTriggerStmt

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

default constructor

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

copy constructor

virtual DtTriggerStmt::~DtTriggerStmt ( )

virtual

destructor

Member Function Documentation

DtTriggerStmt& DtTriggerStmt::operator=

(

const DtTriggerStmt &

orig

)

assignment operator

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

virtual

virtual copy constructor

Implements DtSimStatement.

virtual int DtTriggerStmt::type ( ) const

virtual

Returns DtWhenStatementType (defined in simStmtTypes.h)

Implements DtSimStatement.

virtual void DtTriggerStmt::execute ( DtPlan &  planContext )

virtual

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

Implements DtSimStatement.

virtual int DtTriggerStmt::subBlockCount ( ) const

virtual

Get the number of blocks nested inside this statement.

Reimplemented from DtSimStatement.

virtual DtSimBlock* DtTriggerStmt::subBlock ( int  index )

virtual

Get the a pointer to each particular block nested inside this statement.

Reimplemented from DtSimStatement.

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

virtual

Get a readable string representation of this When statement.

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

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

Implements DtSimStatement.

virtual void DtTriggerStmt::exitFromTrigger ( DtPlan &  planContext )

virtual

The exitFromTrigger function is called when the trigger "When" block is complete, handles popping the plan's trigger stack if the "ReTask" option is given.

virtual const DtUUID& DtTriggerStmt::triggerUUID ( ) const

virtual

virtual void DtTriggerStmt::setTriggerUUID ( const DtUUID &  )

virtual

virtual DtString DtTriggerStmt::triggerName ( ) const

virtual

Name of this trigger. Either short description or conditional full text.

virtual const DtSimCondExpr* DtTriggerStmt::condExpr ( ) const

virtual

Returns the conditional expression used to evaluate the wait until.

Implements DtSimConditionalStatement.

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

virtual

Sets the conditional expression used to evaluate the wait until.

Implements DtSimConditionalStatement.

virtual const DtString& DtTriggerStmt::option ( ) const

virtual

Get the option value, if any (ie.

"ReTask" or ""). The option string is used to modify the behavior of the trigger. The VR-Forces front-end always uses an option string of “ReTask”. If it is unspecified (or “Replace”), the trigger considers the end of the trigger block to be the end of the plan.

virtual void DtTriggerStmt::setOption ( const DtString &  arg )

virtual

Set the option value (eg. "ReTask" or "").

virtual DtTriggerBlock* DtTriggerStmt::triggerBlock ( ) const

virtual

virtual void DtTriggerStmt::setTriggerBlock ( DtTriggerBlock *  arg )

virtual

virtual void DtTriggerStmt::setReregisterTrigger ( bool  )

virtual

Whether or not to re-register trigger once trigger has fired. Default is false.

virtual bool DtTriggerStmt::reregisterTrigger ( ) const

virtual

virtual int DtTriggerStmt::netRepSize ( ) const

virtual

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

Size is computed from the following:

sizeof(DtNetSimStatement) + sizeof(DtNetWhenStatement) + myTask->netRepSize()

Reimplemented from DtSimStatement.

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

virtual

Fills in the request from the network buffer.

Reimplemented from DtSimStatement.

virtual bool DtTriggerStmt::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 DtNetWhenStatment <statement data 1> . . . <statement data="" n>="">

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

Reimplemented from DtSimStatement.

virtual void DtTriggerStmt::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.

static void DtTriggerStmt::addTriggerMarkingTextMapping ( DtTriggerStmt *  )

staticprotected

Since triggers can be copied around and multiples with the same UUID can reference different triggers, keep track of overall registrations here to manage with main UUID marking text manager for adding/removing.

static void DtTriggerStmt::removeTriggerMarkingTextMapping ( DtTriggerStmt *  )

staticprotected

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

protectedvirtual

static DtString DtTriggerStmt::nextDefaultTriggerMarkingText ( )

staticprotected

Increase global variable count and append to "Trigger".

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

static

virtual bool DtTriggerStmt::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

DtRwUUID DtTriggerStmt::myTriggerUUID

protected

DtRwCondExpr DtTriggerStmt::myCondExpr

protected

DtRwString DtTriggerStmt::myOption

protected

DtTriggerBlock* DtTriggerStmt::myBlock

protected

DtRwBoolean DtTriggerStmt::myReregisterTrigger

protected

NamedTriggers DtTriggerStmt::theNamedTriggers

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfplan/triggerStmt.h