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

Inheritance diagram for DtRegisterTriggerStatement:

[legend]

Public Member Functions
	DtRegisterTriggerStatement (DtReaderWriterRegistry *parentRegistry=NULL)

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

virtual	~DtRegisterTriggerStatement ()

DtRegisterTriggerStatement &	operator= (const DtRegisterTriggerStatement &orig)

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

virtual void	setTriggerUUID (const DtUUID &)

virtual const DtUUID &	triggerUUID () const

virtual DtString	triggerName () const

virtual void	setTriggerStatement (DtTriggerStmt *)

virtual DtTriggerStmt *	triggerStatement () const

virtual bool	registerTrigger () const

virtual int	subBlockCount () const

virtual DtSimBlock *	subBlock (int index)

virtual bool	reregisterTrigger () const

virtual void	mapTriggerStatement (DtPlan &planContext)

virtual void	execute (DtPlan &planContext)

virtual DtString	stringRep (int) const

virtual int	type () const

virtual int	netRepSize () const

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

virtual bool	setToNet ()

virtual const DtSimCondExpr *	condExpr () const

virtual const DtString &	option () const

virtual DtTriggerBlock *	triggerBlock () const

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

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 *)

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)

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
	DtRegisterTriggerStatement (const DtString &statementType, DtReaderWriterRegistry *parentRegistry=NULL)

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

virtual bool	compare (DtSimStatement *)

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

Protected Attributes
DtRwUUID	myTriggerUUID

DtRwBoolean	myRegister

DtTriggerStmt *	myTriggerStatement

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

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.vrf5-1-branch/include/vrfplan/registerTriggerStatement.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