DtSimTrigger Class Reference

class DtSimTrigger:

Instances of DtSimTrigger represent pending triggers (triggers that have been registered by execution of a "When" statement).

Public Member Functions
	DtSimTrigger ()
	DtSimTrigger (const DtStmtIndex &triggerStmt, DtPlan *plan)
	DtSimTrigger (const DtSimTrigger &orig, DtPlan *plan=NULL)
virtual	~DtSimTrigger ()
DtSimTrigger &	operator= (const DtSimTrigger &orig)
virtual void	tick ()
virtual bool	testCondition ()
virtual void	activate ()
virtual const DtSimCondExpr *	condition () const
virtual DtTriggerBlock *	triggerBlock () const
virtual DtString	triggerOption () const
virtual const DtRegisterTriggerStatement *	triggerStmt () const
virtual void	setTriggerStmt (const DtRegisterTriggerStatement *arg)
virtual void	translateInto (const DtSimBlock &newBlock)
virtual DtPlan *	plan () const
virtual void	setPlan (DtPlan *arg)
virtual bool	enabled () const
virtual void	setEnabled (bool arg)
virtual bool	isDone () const
virtual void	setIsDone (bool arg)
virtual char *	netRep ()
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()

Protected Member Functions
virtual char *	createNetworkBuffer ()
virtual void	reregisterIfNeeded ()

Protected Attributes
DtStmtIndex	myTriggerStmt
DtPlan *	myPlan
bool	myEnabled
bool	myIsDone
char *	myNetRep

Constructor & Destructor Documentation

DtSimTrigger::DtSimTrigger

(

)

default constructor

DtSimTrigger::DtSimTrigger	(	const DtStmtIndex &	triggerStmt,
		DtPlan *	plan
	)

initializing constructor

DtSimTrigger::DtSimTrigger	(	const DtSimTrigger &	orig,
		DtPlan *	plan = NULL
	)

copy constructor

virtual DtSimTrigger::~DtSimTrigger ( )

virtual

destructor

Member Function Documentation

DtSimTrigger& DtSimTrigger::operator=

(

const DtSimTrigger &

orig

)

Assignment operator (Note: this will NOT copy the plan pointer, and they had better not match!)

virtual void DtSimTrigger::tick ( )

virtual

Test the condition, and activate the trigger if true.

virtual bool DtSimTrigger::testCondition ( )

virtual

Check the current state of the When statement's test.

virtual void DtSimTrigger::activate ( )

virtual

Unconditionally fire the trigger, and set the isDone flag.

virtual const DtSimCondExpr* DtSimTrigger::condition ( ) const

virtual

Used by testCondition() to look up the DtRegisterTriggerStatement's conditional expression and return a pointer to it.

virtual DtTriggerBlock* DtSimTrigger::triggerBlock ( ) const

virtual

Looks up the DtRegisterTriggerStatement's triggerBlock() and returns a pointer to it.

virtual DtString DtSimTrigger::triggerOption ( ) const

virtual

Looks up the DtRegisterTriggerStatement's option() string and returns it.

virtual const DtRegisterTriggerStatement* DtSimTrigger::triggerStmt ( ) const

virtual

Gets or sets a pointer to the DtRegisterTriggerStatement that created this trigger.

virtual void DtSimTrigger::setTriggerStmt ( const DtRegisterTriggerStatement *  arg )

virtual

virtual void DtSimTrigger::translateInto ( const DtSimBlock &  newBlock )

virtual

Translate the When statement index to point into the new block.

virtual DtPlan* DtSimTrigger::plan ( ) const

virtual

virtual void DtSimTrigger::setPlan ( DtPlan *  arg )

virtual

When the Plan is set, this Trigger will be registered with the new Plan.

virtual bool DtSimTrigger::enabled ( ) const

virtual

virtual void DtSimTrigger::setEnabled ( bool  arg )

virtual

virtual bool DtSimTrigger::isDone ( ) const

virtual

This function indicates that the trigger will not fire again and should be deleted by the Plan at the earliest opportunity.

virtual void DtSimTrigger::setIsDone ( bool  arg )

virtual

virtual char* DtSimTrigger::netRep ( )

virtual

virtual int DtSimTrigger::netRepSize ( ) const

virtual

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

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

virtual

Fills in the request from the network buffer.

virtual bool DtSimTrigger::setToNet ( )

virtual

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

virtual char* DtSimTrigger::createNetworkBuffer ( )

protectedvirtual

virtual void DtSimTrigger::reregisterIfNeeded ( )

protectedvirtual

Member Data Documentation

DtStmtIndex DtSimTrigger::myTriggerStmt

protected

DtPlan* DtSimTrigger::myPlan

protected

bool DtSimTrigger::myEnabled

protected

bool DtSimTrigger::myIsDone

protected

char* DtSimTrigger::myNetRep

protected

---

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

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