 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
Total: 8 bytes. More...
Public Member Functions | |
| DtIfPlanCurStatement () | |
| Default constructor. | |
| DtIfPlanCurStatement (const DtIfPlanCurStatement &orig) | |
| Copy constructor. | |
| virtual | ~DtIfPlanCurStatement () |
| Destructor. | |
| DtIfPlanCurStatement & | operator= (const DtIfPlanCurStatement &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 |
Total: 8 bytes.
class DtIfPlanCurStatement:
Instances of DtIfPlanCurStatement 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.
Default constructor.
| DtIfPlanCurStatement::DtIfPlanCurStatement | ( | const DtIfPlanCurStatement & | orig | ) |
Copy constructor.
| virtual DtIfPlanCurStatement::~DtIfPlanCurStatement | ( | ) | [virtual] |
Destructor.
| DtIfPlanCurStatement& DtIfPlanCurStatement::operator= | ( | const DtIfPlanCurStatement & | orig | ) |
Assignment operator.
| virtual int DtIfPlanCurStatement::type | ( | ) | const [virtual] |
Returns the type of Interface Content.
Implements DtSimInterfaceContent.
| virtual DtSimInterfaceContent* DtIfPlanCurStatement::clone | ( | ) | const [virtual] |
Clone this object.
Implements DtSimInterfaceContent.
| virtual const DtString& DtIfPlanCurStatement::name | ( | ) | const [virtual] |
Get the name.
| virtual void DtIfPlanCurStatement::setName | ( | const DtString & | name | ) | [virtual] |
Set the name.
| virtual bool DtIfPlanCurStatement::isGlobal | ( | ) | const [virtual] |
Indicates whether this refers to a global plan or an entity plan.
| virtual void DtIfPlanCurStatement::setIsGlobal | ( | bool | value | ) | [virtual] |
Indicates whether this refers to a global plan or an entity plan.
| virtual int DtIfPlanCurStatement::currentStmtId | ( | ) | const [virtual] |
Get the current statement's ID.
| virtual void DtIfPlanCurStatement::setCurrentStmtId | ( | int | arg | ) | [virtual] |
Set the current statement's ID.
| virtual bool DtIfPlanCurStatement::isComplete | ( | ) | const [virtual] |
Get the Plan Complete flag.
| virtual void DtIfPlanCurStatement::setIsComplete | ( | bool | arg | ) | [virtual] |
Set the Plan Complete flag.
| virtual bool DtIfPlanCurStatement::isExecuting | ( | ) | const [virtual] |
True if the plan is currently executing.
| virtual void DtIfPlanCurStatement::setIsExecuting | ( | bool | b | ) | [virtual] |
True if the plan is currently executing.
| virtual bool DtIfPlanCurStatement::isAbandoned | ( | ) | const [virtual] |
True if the plan has been abandoned.
| virtual void DtIfPlanCurStatement::setIsAbandoned | ( | bool | b | ) | [virtual] |
True if the plan has been abandoned.
| virtual int DtIfPlanCurStatement::netRepSize | ( | ) | const [virtual] |
returns the size of the full network representation (control object name included) padded to an 8-byte boundary.
Reimplemented from DtSimInterfaceContent.
| virtual bool DtIfPlanCurStatement::setFromNet | ( | const char * | contentBuffer, |
| unsigned | contentSize | ||
| ) | [virtual] |
Fills in the task from the network buffer.
Reimplemented from DtSimInterfaceContent.
| virtual bool DtIfPlanCurStatement::setToNet | ( | ) | [virtual] |
Fills in the network buffer (created by base class simTask) with the task contents.
Reimplemented from DtSimInterfaceContent.
| virtual void DtIfPlanCurStatement::printDataToString | ( | DtString & | str | ) | [virtual] |
Reimplemented from DtSimInterfaceContent.
| static DtSimInterfaceContent* DtIfPlanCurStatement::creator | ( | ) | [static] |
DtString DtIfPlanCurStatement::myName [protected] |
The name string associated with this subscription.
int DtIfPlanCurStatement::myCurrentStmtId [protected] |
The statement Id for the current statement.
bool DtIfPlanCurStatement::myIsComplete [protected] |
The Plan Complete Flag.
bool DtIfPlanCurStatement::myIsGlobal [protected] |
bool DtIfPlanCurStatement::myExecuting [protected] |
bool DtIfPlanCurStatement::myIsAbandoned [protected] |