DtIfPlanCurrentStatement Class Reference

class DtIfPlanCurrentStatement:

Instances of DtIfPlanCurrentStatement are updates of the statementId of a plan's current statement. If the Plan hasn't yet started to execute, statementId will be zero. This message also contains a flag that indicates whether the Plan is considered "Complete" (i.e. no longer executing), if this is true, the statementId value may be meaningless.

Content-Type: DtPlanCurStatementMessageType

Parameters: echelonId - The echelon ID DtString of the plan that has changed.

currentStmtId - The current statement ID (an integer). If the plan has not yet started to execute, the statement ID is zero.

isComplete - A bool flag that indicates whether the plan is considered "Complete" (that is, not currently executing). If this is true, the statement ID value may be undefined.

triggerStmtId - Since triggers can be registered multiple times, if registered, the statement id of the trigger being used

Inheritance diagram for DtIfPlanCurrentStatement:

Public Member Functions
	DtIfPlanCurrentStatement ()
	DtIfPlanCurrentStatement (const DtIfPlanCurrentStatement &orig)
virtual	~DtIfPlanCurrentStatement () override
DtIfPlanCurrentStatement &	operator= (const DtIfPlanCurrentStatement &orig)
virtual int	type () const override
virtual DtSimInterfaceContent *	clone () const override
virtual const DtUUID &	planName () const
virtual void	setPlanName (const DtUUID &)
virtual int	currentStmtId () const
virtual void	setCurrentStmtId (int arg)
virtual bool	isComplete () const
virtual void	setIsComplete (bool arg)
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
virtual void	printDataToString (DtString &str) override
virtual bool	isGlobal () const
virtual void	setIsGlobal (bool value)
virtual const std::vector< int > &	executingTriggerStmtIds () const
virtual void	addExecutingTriggerStmtId (int)
virtual void	setExecutingTriggerStmtIds (const std::vector< int > &)
virtual const std::vector < DtUUID > &	executingTriggerNames () const
virtual void	addExecutingTriggerName (const DtUUID &)
virtual void	setExecutingTriggerNames (const std::vector< DtUUID > &)
virtual const std::vector < DtUUID > &	registeredTriggerNames () const
virtual void	addRegisteredTriggerName (const DtUUID &)
virtual void	setRegisteredTriggerNames (const std::vector< DtUUID > &)
virtual bool	isExecuting () const
virtual void	setIsExecuting (bool b)
virtual bool	isAbandoned () const
virtual void	setIsAbandoned (bool b)
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtUUID	myPlanName
int	myCurrentStmtId
bool	myIsComplete
bool	myIsGlobal
bool	myExecuting
bool	myIsAbandoned
std::vector< int >	myExecutingTriggerStmtIds
std::vector< DtUUID >	myExecutingTriggerNames
std::vector< DtUUID >	myRegisteredTriggerNames
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Constructor & Destructor Documentation

DtIfPlanCurrentStatement::DtIfPlanCurrentStatement

(

)

Default constructor.

DtIfPlanCurrentStatement::DtIfPlanCurrentStatement

(

const DtIfPlanCurrentStatement &

orig

)

Copy constructor.

virtual DtIfPlanCurrentStatement::~DtIfPlanCurrentStatement ( )

overridevirtual

Destructor.

Member Function Documentation

DtIfPlanCurrentStatement& DtIfPlanCurrentStatement::operator=

(

const DtIfPlanCurrentStatement &

orig

)

Assignment operator.

virtual int DtIfPlanCurrentStatement::type ( ) const

overridevirtual

Returns the type of Interface Content.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfPlanCurrentStatement::clone ( ) const

overridevirtual

Clone this object.

Implements DtSimInterfaceContent.

virtual const DtUUID& DtIfPlanCurrentStatement::planName ( ) const

virtual

Get the uuid of the object this plan is for. Was: name.

virtual void DtIfPlanCurrentStatement::setPlanName ( const DtUUID &  )

virtual

Set the uuid this object is for. Was: setName.

virtual bool DtIfPlanCurrentStatement::isGlobal ( ) const

virtual

Indicates whether this refers to a global plan or an entity plan.

virtual void DtIfPlanCurrentStatement::setIsGlobal ( bool  value )

virtual

Indicates whether this refers to a global plan or an entity plan.

virtual int DtIfPlanCurrentStatement::currentStmtId ( ) const

virtual

Get the current statement's ID.

virtual void DtIfPlanCurrentStatement::setCurrentStmtId ( int  arg )

virtual

Set the current statement's ID.

virtual bool DtIfPlanCurrentStatement::isComplete ( ) const

virtual

Get the Plan Complete flag.

virtual void DtIfPlanCurrentStatement::setIsComplete ( bool  arg )

virtual

Set the Plan Complete flag.

virtual const std::vector<int>& DtIfPlanCurrentStatement::executingTriggerStmtIds ( ) const

virtual

If executing a trigger, the id of the trigger. The triggers are placed in the order of execution.

virtual void DtIfPlanCurrentStatement::addExecutingTriggerStmtId ( int  )

virtual

If executing a trigger, the id of the trigger. The triggers are placed in the order of execution.

virtual void DtIfPlanCurrentStatement::setExecutingTriggerStmtIds ( const std::vector< int > &  )

virtual

If executing a trigger, the id of the trigger. The triggers are placed in the order of execution.

virtual const std::vector<DtUUID>& DtIfPlanCurrentStatement::executingTriggerNames ( ) const

virtual

If executing a trigger, the name of the trigger. The triggers are placed in the order of execution.

virtual void DtIfPlanCurrentStatement::addExecutingTriggerName ( const DtUUID &  )

virtual

If executing a trigger, the name of the trigger. The triggers are placed in the order of execution.

virtual void DtIfPlanCurrentStatement::setExecutingTriggerNames ( const std::vector< DtUUID > &  )

virtual

If executing a trigger, the name of the trigger. The triggers are placed in the order of execution.

virtual const std::vector<DtUUID>& DtIfPlanCurrentStatement::registeredTriggerNames ( ) const

virtual

Name(s) of triggers that are currently pending execution.

virtual void DtIfPlanCurrentStatement::addRegisteredTriggerName ( const DtUUID &  )

virtual

Name(s) of triggers that are currently pending execution.

virtual void DtIfPlanCurrentStatement::setRegisteredTriggerNames ( const std::vector< DtUUID > &  )

virtual

Name(s) of triggers that are currently pending execution.

virtual bool DtIfPlanCurrentStatement::isExecuting ( ) const

virtual

True if the plan is currently executing.

virtual void DtIfPlanCurrentStatement::setIsExecuting ( bool  b )

virtual

True if the plan is currently executing.

virtual bool DtIfPlanCurrentStatement::isAbandoned ( ) const

virtual

True if the plan has been abandoned.

virtual void DtIfPlanCurrentStatement::setIsAbandoned ( bool  b )

virtual

True if the plan has been abandoned.

virtual int DtIfPlanCurrentStatement::netRepSize ( ) const

overridevirtual

returns the size of the full network representation (control object name included) padded to an 8-byte boundary.

Reimplemented from DtSimInterfaceContent.

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

overridevirtual

Fills in the task from the network buffer.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfPlanCurrentStatement::setToNet ( )

overridevirtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSimInterfaceContent.

virtual void DtIfPlanCurrentStatement::printDataToString ( DtString &  str )

overridevirtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfPlanCurrentStatement::creator ( )

static

Member Data Documentation

DtUUID DtIfPlanCurrentStatement::myPlanName

protected

The uuid associated with this subscription.

int DtIfPlanCurrentStatement::myCurrentStmtId

protected

The statement Id for the current statement.

bool DtIfPlanCurrentStatement::myIsComplete

protected

The Plan Complete Flag.

bool DtIfPlanCurrentStatement::myIsGlobal

protected

bool DtIfPlanCurrentStatement::myExecuting

protected

bool DtIfPlanCurrentStatement::myIsAbandoned

protected

std::vector<int> DtIfPlanCurrentStatement::myExecutingTriggerStmtIds

protected

std::vector<DtUUID> DtIfPlanCurrentStatement::myExecutingTriggerNames

protected

std::vector<DtUUID> DtIfPlanCurrentStatement::myRegisteredTriggerNames

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfmsgs/ifPlanCurrentStatement.h