DtRegisterTriggerStatement Class Reference

class DtRegisterTriggerStatement: More...

Inheritance diagram for DtRegisterTriggerStatement:

Public Member Functions
	DtRegisterTriggerStatement (DtReaderWriterRegistry *parentRegistry=NULL)
	default constructor More...
	DtRegisterTriggerStatement (const DtRegisterTriggerStatement &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
virtual	~DtRegisterTriggerStatement ()
	destructor More...
DtRegisterTriggerStatement &	operator= (const DtRegisterTriggerStatement &orig)
	assignment operator More...
virtual DtSimStatement *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
	virtual copy constructor More...
virtual void	setTriggerUUID (const DtUUID &)
	Name of the trigger to register/unregister. More...
virtual const DtUUID &	triggerUUID () const
virtual DtString	triggerName () const
	Name of trigger as provided by triggerStatement. More...
virtual void	setTriggerStatement (DtTriggerStmt *)
virtual DtTriggerStmt *	triggerStatement () const
virtual bool	registerTrigger () const
	Whether or not to register/unregister the trigger. More...
virtual int	subBlockCount () const
	Get the number of blocks nested inside this statement. More...
virtual DtSimBlock *	subBlock (int index)
	Get a pointer to any particular block nested inside this statement. More...
virtual bool	reregisterTrigger () const
	Return true if this is a re-registering trigger. More...
virtual void	mapTriggerStatement (DtPlan &planContext)
	Finds the trigger statement this trigger represents in the plan context. More...
virtual void	execute (DtPlan &planContext)
	Execute the current statement and make any changes to the Plan state as appropriate. More...
virtual DtString	stringRep (int) const
	Generates a readable string for this statement. More...
virtual int	type () const
	Returns DtRegisterStatementType (defined in simStmtTypes.h) More...
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary. More...
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the request from the network buffer. More...
virtual bool	setToNet ()
	Fills in the network buffer (created by base class sim statement) with the set data request contents. More...
virtual const DtSimCondExpr *	condExpr () const
	Conditional statement that is part of this register. More...
virtual const DtString &	option () const
	Option that is part of this trigger statement. More...
virtual DtTriggerBlock *	triggerBlock () const
	Trigger block. More...
virtual void	upgradeTriggerUUID (const boost::unordered_map< DtUUID, DtUUID > &)
	For those statements that need to, map from the old to new trigger UUID. More...
Public Member Functions inherited from DtSimStatement
	DtSimStatement ()
	Default constructor. More...
	DtSimStatement (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor NOTE: "name" should be the statement type string. More...
	DtSimStatement (const DtSimStatement &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Copy constructor. More...
virtual	~DtSimStatement ()
	Destructor. More...
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. More...
DtSimStatement &	operator= (const DtSimStatement &orig)
	Assignment operator (protected because this is an abstract base class). More...
virtual bool	validate ()
	Checks the statement for validity, and potentially fixes the statement to be valid. More...
virtual void	step (DtPlan &planContext, bool forceStep=false)
	Asks the statement to step the context DtPlan to the next statement. More...
DtSimStatement *	nextStmt () const
	Return next (previous) statements in the block, or NULL if hit the end (beginning) of the list. More...
DtSimStatement *	prevStmt () const
virtual DtStmtIdType	statementId () const
	Statement Id accessors. More...
virtual void	setStatementId (DtStmtIdType arg)
virtual DtSimBlock *	parentBlock () const
	The parent statement Block. More...
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. More...
virtual DtSimStatement *	lookupStatement (DtStmtIdType statementId)
	If statementId matches our statement, returns a pointer to us. More...
virtual void	setStatementDescription (const DtString &)
	If supported for display a description of this statement that can be used for display. More...
virtual const DtString &	statementDescription () const
virtual char *	netRep ()
virtual bool	isSameStatement (DtSimStatement *)
	Returns true if statements are equivalent. Will not check statementId. More...
virtual void	reset ()
	Called when the plan is reset, will iterate over all statements to reset as well. More...
Public Member Functions inherited from DtRwListedObj
	DtRwListedObj ()
	Default constructor. More...
	DtRwListedObj (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	Real constructor. More...
	DtRwListedObj (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwListedObj (const DtRwListedObj &orig)
	Copy constructor. More...
virtual	~DtRwListedObj ()
	Destructor. More...
DtRwListedObj &	operator= (const DtRwListedObj &orig)
	Assignment operator. More...
DtRwListedObj *	next () const
	Return next (previous) elements on the list, or NULL if hit the end (beginning) of the list. More...
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). More...
DtRwListedObj *	wrapPrev () const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...
bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor More...
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. More...
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...
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. More...
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...
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. More...
bool	isReadonly () const
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...
virtual void	setName (const DtString &)
	Set the name of the object. More...
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...
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. More...
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...
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. More...
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...
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. More...
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...
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. More...
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...
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. More...
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...
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. More...
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. More...
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtSimStatement *	creator (DtReaderWriterRegistry *parentRegistry=NULL)
	Creator function to be registered with DtStatementFactory. More...
Static Public Member Functions inherited from DtSimStatement
static DtStmtIdType	generateNewStmtId ()
static DtSimStatement *	createStatement (DtlObjPtr mtlStream, DtReaderWriterRegistry *parentRegistry=NULL)
	Static functions. More...
static DtSimStatement *	createStatement (int statementType, DtReaderWriterRegistry *parentRegistry=NULL)
static void	addStatementCreatorFcn (const DtString &type, int intType, DtStatementCreatorFcn fcn)
	Decodes a legacy stealth statement (VRF 3.9 and previous) and returns the proper statement for the current version. More...
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 ()
	The type that is used when archiving to an XML stream. More...
static const DtFilename &	appPath ()
	Gets the current working directory. More...
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...
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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Member Functions
	DtRegisterTriggerStatement (const DtString &statementType, DtReaderWriterRegistry *parentRegistry=NULL)
Protected Member Functions inherited from DtSimStatement
virtual char *	createNetworkBuffer ()
virtual bool	compare (DtSimStatement *)
	Called from isSameStatement. More...
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Attributes
DtRwUUID	myTriggerUUID
DtRwBoolean	myRegister
DtTriggerStmt *	myTriggerStatement
Protected Attributes inherited from DtSimStatement
DtStmtIdType	myStatementId
	A semi-unique Id value that helps trace the original identity of this statement if/when it gets copied. More...
DtSimBlock *	myParentBlock
	The containing DtSimBlock object (if any). More...
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
	Container for the aliases which represent alternative names for the object. More...
bool	myInvalid
	Set to true if there is a problem reading this item. More...
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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(). More...
Static Protected Attributes inherited from DtSimStatement
static DtStatementFactory *	myFactory
	Factory for this class. More...
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

Detailed Description

class DtRegisterTriggerStatement:

Registers a trigger (or unregisters) to be executed at the point of the trigger in the plan. Unregistering a trigger, if the trigger is currently being executed, will stop the execution of that trigger, else will simply remove from the trigger execution stack

Constructor & Destructor Documentation

DtRegisterTriggerStatement::DtRegisterTriggerStatement

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

default constructor

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

copy constructor

virtual DtRegisterTriggerStatement::~DtRegisterTriggerStatement ( )

virtual

destructor

DtRegisterTriggerStatement::DtRegisterTriggerStatement ( const DtString &  statementType, DtReaderWriterRegistry *  parentRegistry = NULL  )

protected

Member Function Documentation

DtRegisterTriggerStatement& DtRegisterTriggerStatement::operator=

(

const DtRegisterTriggerStatement &

orig

)

assignment operator

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

virtual

virtual copy constructor

Implements DtSimStatement.

Reimplemented in DtUnregisterTriggerStatement.

virtual void DtRegisterTriggerStatement::setTriggerUUID ( const DtUUID &  )

virtual

Name of the trigger to register/unregister.

virtual const DtUUID& DtRegisterTriggerStatement::triggerUUID ( ) const

virtual

virtual DtString DtRegisterTriggerStatement::triggerName ( ) const

virtual

Name of trigger as provided by triggerStatement.

virtual void DtRegisterTriggerStatement::setTriggerStatement ( DtTriggerStmt *  )

virtual

virtual DtTriggerStmt* DtRegisterTriggerStatement::triggerStatement ( ) const

virtual

virtual bool DtRegisterTriggerStatement::registerTrigger ( ) const

virtual

Whether or not to register/unregister the trigger.

virtual int DtRegisterTriggerStatement::subBlockCount ( ) const

virtual

Get the number of blocks nested inside this statement.

Reimplemented from DtSimStatement.

virtual DtSimBlock* DtRegisterTriggerStatement::subBlock ( int  index )

virtual

Get a pointer to any particular block nested inside this statement.

Sub-blocks are indexed as C arrays are (i.e. starting with block #0).

Reimplemented from DtSimStatement.

virtual bool DtRegisterTriggerStatement::reregisterTrigger ( ) const

virtual

Return true if this is a re-registering trigger.

virtual void DtRegisterTriggerStatement::mapTriggerStatement ( DtPlan &  planContext )

virtual

Finds the trigger statement this trigger represents in the plan context.

virtual void DtRegisterTriggerStatement::execute ( DtPlan &  planContext )

virtual

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

Implements DtSimStatement.

virtual DtString DtRegisterTriggerStatement::stringRep ( int  ) const

virtual

Generates a readable string for this statement.

Implements DtSimStatement.

virtual int DtRegisterTriggerStatement::type ( ) const

virtual

Returns DtRegisterStatementType (defined in simStmtTypes.h)

Implements DtSimStatement.

Reimplemented in DtUnregisterTriggerStatement.

virtual int DtRegisterTriggerStatement::netRepSize ( ) const

virtual

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

Reimplemented from DtSimStatement.

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

virtual

Fills in the request from the network buffer.

Reimplemented from DtSimStatement.

virtual bool DtRegisterTriggerStatement::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 const DtSimCondExpr* DtRegisterTriggerStatement::condExpr ( ) const

virtual

Conditional statement that is part of this register.

virtual const DtString& DtRegisterTriggerStatement::option ( ) const

virtual

Option that is part of this trigger statement.

virtual DtTriggerBlock* DtRegisterTriggerStatement::triggerBlock ( ) const

virtual

Trigger block.

virtual void DtRegisterTriggerStatement::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 DtSimStatement* DtRegisterTriggerStatement::creator ( DtReaderWriterRegistry *  parentRegistry = NULL )

static

Creator function to be registered with DtStatementFactory.

Member Data Documentation

DtRwUUID DtRegisterTriggerStatement::myTriggerUUID

protected

DtRwBoolean DtRegisterTriggerStatement::myRegister

protected

DtTriggerStmt* DtRegisterTriggerStatement::myTriggerStatement

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfplan/registerTriggerStatement.h