DtTriggerStmt Class Reference

Inheritance diagram for DtTriggerStmt:

Public Member Functions
	DtTriggerStmt (DtReaderWriterRegistry *parentRegistry=NULL)
	DtTriggerStmt (const DtTriggerStmt &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtTriggerStmt ()
DtTriggerStmt &	operator= (const DtTriggerStmt &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 void	exitFromTrigger (DtPlan &planContext)
virtual const DtUUID &	triggerUUID () const
virtual void	setTriggerUUID (const DtUUID &)
virtual DtString	triggerName () const
virtual const DtSimCondExpr *	condExpr () const
virtual void	setCondExpr (const DtSimCondExpr *arg)
virtual const DtString &	option () const
virtual void	setOption (const DtString &arg)
virtual DtTriggerBlock *	triggerBlock () const
virtual void	setTriggerBlock (DtTriggerBlock *arg)
virtual void	setReregisterTrigger (bool)
virtual bool	reregisterTrigger () const
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 bool	validate ()
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	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	wasUpdatedSince (DtTime t) 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 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 *)
Protected Member Functions inherited from DtSimStatement
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Member Functions
static void	addTriggerMarkingTextMapping (DtTriggerStmt *)
static void	removeTriggerMarkingTextMapping (DtTriggerStmt *)
static DtString	nextDefaultTriggerMarkingText ()

Protected Attributes
DtRwUUID	myTriggerUUID
DtRwCondExpr	myCondExpr
DtRwString	myOption
DtTriggerBlock *	myBlock
DtRwBoolean	myReregisterTrigger
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

Static Protected Attributes
static NamedTriggers	theNamedTriggers
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

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

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.

virtual void DtTriggerStmt::reset ( )

virtual

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

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

Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

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:

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