DtIfPlanCurrentStatement Class Reference

Total: 8 bytes. More...

Inheritance diagram for DtIfPlanCurrentStatement:

Public Member Functions
	DtIfPlanCurrentStatement ()
	Default constructor.
	DtIfPlanCurrentStatement (const DtIfPlanCurrentStatement &orig)
	Copy constructor.
virtual	~DtIfPlanCurrentStatement ()
	Destructor.
DtIfPlanCurrentStatement &	operator= (const DtIfPlanCurrentStatement &orig)
	Assignment operator.
virtual int	type () const
	Returns the type of Interface Content.
virtual DtSimInterfaceContent *	clone () const
	Clone this object.
virtual const DtString &	name () const
	Get the name.
virtual void	setName (const DtString &name)
	Set the name.
virtual int	currentStmtId () const
	Get the current statement's ID.
virtual void	setCurrentStmtId (int arg)
	Set the current statement's ID.
virtual bool	isComplete () const
	Get the Plan Complete flag.
virtual void	setIsComplete (bool arg)
	Set the Plan Complete flag.
virtual int	netRepSize () const
	returns the size of the full network representation (control object name included) padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
virtual void	printDataToString (DtString &str)
virtual bool	isGlobal () const
	Indicates whether this refers to a global plan or an entity plan.
virtual void	setIsGlobal (bool value)
	Indicates whether this refers to a global plan or an entity plan.
virtual bool	isExecuting () const
	True if the plan is currently executing.
virtual void	setIsExecuting (bool b)
	True if the plan is currently executing.
virtual bool	isAbandoned () const
	True if the plan has been abandoned.
virtual void	setIsAbandoned (bool b)
	True if the plan has been abandoned.

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Protected Attributes
DtString	myName
	The name string associated with this subscription.
int	myCurrentStmtId
	The statement Id for the current statement.
bool	myIsComplete
	The Plan Complete Flag.
bool	myIsGlobal
bool	myExecuting
bool	myIsAbandoned

Detailed Description

Total: 8 bytes.

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.

Constructor & Destructor Documentation

DtIfPlanCurrentStatement::DtIfPlanCurrentStatement

(

)

Default constructor.

DtIfPlanCurrentStatement::DtIfPlanCurrentStatement

(

const DtIfPlanCurrentStatement &

orig

)

Copy constructor.

virtual DtIfPlanCurrentStatement::~DtIfPlanCurrentStatement ( )

virtual

Destructor.

Member Function Documentation

DtIfPlanCurrentStatement& DtIfPlanCurrentStatement::operator=

(

const DtIfPlanCurrentStatement &

orig

)

Assignment operator.

virtual int DtIfPlanCurrentStatement::type ( ) const

virtual

Returns the type of Interface Content.

virtual DtSimInterfaceContent* DtIfPlanCurrentStatement::clone ( ) const

virtual

Clone this object.

virtual const DtString& DtIfPlanCurrentStatement::name ( ) const

virtual

Get the name.

virtual void DtIfPlanCurrentStatement::setName ( const DtString &  name )

virtual

Set the name.

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

virtual

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

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

virtual

Fills in the task from the network buffer.

virtual bool DtIfPlanCurrentStatement::setToNet ( )

virtual

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

virtual void DtIfPlanCurrentStatement::printDataToString ( DtString &  str )

virtual

static DtSimInterfaceContent* DtIfPlanCurrentStatement::creator ( )

static

Member Data Documentation

DtString DtIfPlanCurrentStatement::myName

protected

The name string 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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfmsgs/ifPlanCurrentStatement.h