 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
Public Member Functions | |
| DtPlan () | |
| constructor for use from within a front-end application, or when creating a plan to be assigned through DtCgf's assignPlan() function. | |
| DtPlan (const DtString &planName, DtPlanExecutor *planExecutor, const DtString &name="Plan", DtReaderWriterRegistry *parentRegistry=NULL) | |
| constructor for use from within a back-end application | |
| DtPlan (const DtString &name, const DtString &planName, const DtPlan &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| virtual | ~DtPlan () |
| destructor | |
| virtual void | init () |
| The init function must be called after any non-copy constructor! | |
| virtual DtPlan * | clone (const DtString &name, const DtString &planName, DtReaderWriterRegistry *parentRegistry=NULL) const |
| Returns a newly created copy of ourself. | |
| DtPlan & | operator= (const DtPlan &orig) |
| Note: this will NOT copy the DtSimPlanManager pointer, and will only copy the planName if *this is not currently registered with a DtSimPlanManager (because either the DtSimPlanManager pointer is NULL or the current planName is empty). | |
| virtual bool | operator== (const DtPlan &orig) const |
| Equality operator. | |
| virtual DtString | planName () const |
| virtual void | setPlanName (const DtString &name) |
| virtual const DtString & | objectName () const |
| Get/set the object name of entity associated with this plan. | |
| virtual void | setObjectName (const DtString &objectName) |
| virtual bool | objectNameSpecified () const |
| true if the object name was specified in the RW structure. | |
| virtual void | setPlanExecutor (DtPlanExecutor *planExecutor) |
| Get a pointer to the sim manager. | |
| virtual DtPlanExecutor * | planExecutor () const |
| virtual void | enableExecutionState () |
| Enable/disable plan execution state. | |
| virtual void | disableExecutionState () |
| virtual bool | executionState () const |
| virtual void | awaitingTask () |
| Sets our awaiting task flag (it will be handled in processAwaitingTask(), called from tick if/when plan execution state is enabled. | |
| virtual bool | isAwatingTask () const |
| virtual void | pushExecutionStack () |
| When a retasking trigger fires, it first calls pushExecutionStack on the DtPlan. | |
| virtual void | popExecutionStack (bool forceStep=false) |
| When a retasking trigger completes, it calls popExecutionStack on the DtPlan. | |
| virtual void | executeTrigger (DtWhenBlock *whenBlock) |
| When a DtSimTrigger gets executed, it calls the executeTrigger function which begins execution of the whenBlock. | |
| virtual void | executeBlock (DtSimBlock *block) |
| Begin execution of a block of tasks. | |
| virtual bool | taskRequestPending () const |
| Get the TaskRequestPending flag. | |
| virtual void | setTaskRequestPending (bool newValue=true) |
| Set or clear the TaskRequestPending flag. | |
| virtual bool | executeTask (const DtSimTask &taskToSend) const |
| Uses the plan executor to execute the specified task in the context of this plan. | |
| virtual bool | executeSetDataRequest (const DtSetDataRequest &setToSend) const |
| Uses the plan executor to execute the specified set data request in the context of this plan. | |
| virtual bool | executeSimCommand (const DtSimCommand &command) const |
| Uses the plan executor to execute the specified simulation command in the context of this plan. | |
| virtual bool | evaluateConditional (const DtSimCondExpr *condExpr) const |
| Uses myPlanExecutor to evaluate the conditional expression. | |
| virtual DtStmtIndex | firstStmt () const |
| Get the index of the first statement in the plan. | |
| virtual DtPlanBlock * | mainBlock () const |
| Get a pointer to the Plan's main Block. | |
| virtual bool | isEmpty () const |
| True if the Plan is considered "Empty" (containing no statements). | |
| virtual DtList * | triggerList () |
| Get a pointer to the list of pending triggers. | |
| virtual const DtList * | triggerList () const |
| virtual void | addTrigger (DtSimTrigger *trigger) |
| Add a trigger to the pending trigger list. | |
| virtual void | removeTrigger (DtSimTrigger *trigger) |
| Remove a trigger from the pending trigger list. | |
| virtual DtList * | executionStack () |
| Get a pointer to the execution stack. | |
| virtual const DtList * | executionStack () const |
| virtual bool | validatePlan () |
| Checks, and potentially fixes, the plan. | |
| virtual const DtStmtIndex & | currentStmt () const |
| Get the index of the Plan's "current" statement. | |
| virtual void | setCurrentStmt (const DtStmtIndex &nextStatement) |
| Set the Plan's "current" statement. | |
| virtual void | setCurrentStatementExecutionId (int id) |
| Sets the current task execution ID to the value specified. | |
| virtual bool | isComplete () const |
| True if the Plan is considered "Complete" and no longer active. | |
| virtual void | setIsComplete (bool completeFlag=true) |
| Set the Plan's completion flag, if true, further execution of the Plan is disabled. | |
| virtual bool | isAbandoned () const |
| virtual void | setIsAbandoned (bool v) |
| Sets whether or not the plan is abandoned. | |
| virtual bool | isExecuting () const |
| virtual DtPlanStatus | currentStatus () const |
| virtual void | reset () |
| Clear all registered triggers and reset the Plan to its initial state. | |
| virtual void | abandonPlan (bool sendWaitTask) |
| Reset the plan, but then set isComplete and set the current statement to the last one in the Main Block. | |
| virtual void | restartPlan (bool sendWaitTask=true) |
| Reset sthe plan. | |
| virtual bool | translateIndex (DtStmtIndex &stmtIndex) const |
| If you have a DtStmtIndex object that used to point into the original DtPlan before it was copied/cloned into this one, use the translateIndex function to convert it to point into this DtPlan. | |
| virtual void | translateIndices (DtList &stmtIndexList) const |
| If you have a list of DtStmtIndex objects that used to point into the original DtPlan before it was copied/cloned into this one, use the translateIndicies function to convert them to point into this DtPlan. | |
| virtual void | tick () |
| The Plan tick function. Presently this ticks all the Plan's triggers. | |
| virtual void | mergeEditedPlanWith (const DtPlan &oldPlan) |
| This plan is an edited version of an old one, copy and/or translate over any information that we want to preserve when we replace the old plan with this one (e.g. | |
| virtual DtRecursiveSimBlockIterator * | spawnRecursiveIterator () const |
| Spawns an iterator that iterates over the statements in the plan. | |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath()) |
| This is the top-level reader-writer member function for saving self to file. | |
| virtual void | getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| This is the top-level reader-writer member function for reading in self from file. | |
| virtual void | addStatementChangedCallback (DtCurrentStatementChangedCallbackFcn fcn, void *usrData) |
| Adds a callback which is called whenever the current statement changes or whenever the status of the plan changes. | |
| virtual void | removeStatementChangedCallback (DtCurrentStatementChangedCallbackFcn fcn, void *usrData) |
| Removes a statement changed callback. | |
Protected Member Functions | |
| virtual void | processAwaitingTask () |
| Awaiting task then (re)starts execution of plan. | |
| virtual void | createMainBlock () |
| Create the Main Block. | |
| virtual void | copyMainBlock (const DtPlan &otherPlan) |
| Copy the main block (and all nested blocks) and the Execution Stack from another Plan, and translate any/all DtStmtIndex objects to point into the new main block structure. | |
| virtual void | copyAndTranslateExecutionStack (const DtPlan &otherPlan) |
| Copy the other Plan's execution stack and translate all DtStmtIndex objects in the execution stack to point into the new main block. | |
| virtual void | copyAndTranslateTriggers (const DtPlan &otherPlan) |
| Copy the other Plan's pending triggers and translate all DtStmtIndex objects in the triggers to point into the new main block. | |
| virtual void | curStmtChanged () |
| Whenever a change is made that changes the effective current statement, this function is called so that the front end can be told of the change. | |
| virtual void | continuePlan () |
| ContinuePlan will continue the Plan execution until either the task request pending flag is cleared, or the plan complete flag is set. | |
| virtual void | stepStatement () |
| StepStatement will step to the next statement in the Plan. | |
| virtual void | executeStatement () |
| ExecuteStatement will execute the current statement in the Plan. | |
| virtual void | clearTriggerList () |
| ClearTriggerList deletes the registered triggers and clears the pending trigger list. | |
| virtual void | clearExecutionStack () |
| ClearExecutionStack clears the execution stack and resets the Plan. | |
| virtual void | emtpyExecutionStack () |
| Removes and deletes all DtStmtIndex* entries from the execution stack. | |
| virtual int | statementIdToCursor (DtStmtIdType statementId) |
| Maps statementId to cursor and vice-versa. | |
| virtual DtStmtIdType | cursorToStatementId (int cursor) |
| virtual DtSimStatement * | lookupStatementByCursor (int cursor) |
| Look up statement at the given cursor location (an integer identifying the overall position of a statement in a plan. | |
| virtual void | mapExecutionStackToRwExecutionStack (DtRwPlanExecutionStack &rwExecutionStack) |
| Called by putSelf(). | |
| virtual void | mapPendingTriggersToPendingTriggerDataList () |
| Called by putSelf(). | |
| virtual void | mapOldExecutionCursorStackToExecutionStack (const DtRwIntegerList &executionCursorStack) |
| Called by getSelf(). | |
| virtual void | mapRwExecutionStackToExecutionStack (const DtRwPlanExecutionStack &rwExecutionStack) |
| Fills myExecutionStack with the data from rwExecutionStack. | |
| virtual void | mapPendingTriggerDataToPendingTriggers () |
| Called by getSelf(). | |
Protected Attributes | |
| DtRwBoolean | myTaskRequestPending |
| The TaskRequestPending flag is set to true when an Entity requests a new task, and is cleared when a new task is sent by the Plan engine. | |
| DtPlanBlock * | myMainBlock |
| The main Block is the top-level Block of the plan and is the only Block that is considered to be "owned" by this DtPlan object. | |
| DtList | myExecutionStack |
| The top of the execution stack is the Plan's current statement (fetched with currentStmt()). | |
| DtRwBoolean | myIsComplete |
| myIsComplete Disables awaitingTask() and causes it to emit continuous Wait tasks. | |
| DtRwBoolean | myAbandoned |
| True if this plan has been abandoned. | |
| DtList | myPendingTriggers |
| A list of all registered DtSimTriggers. | |
| DtCallbackList< const DtPlan & > | myStatementChangedCbs |
| A list of all the DtCurrentStatementChangedCallbackFcn callbacks. | |
| DtRwTriggerDataList | myPendingTriggerDataList |
| Reader-writer members used to hold checkpoint information about the plan. | |
| bool | myExecutionIsEnabled |
| Flag indication whether execution is enabled (can we start or advance through plan statements?). | |
| bool | myAwaitingTaskFlag |
| Flag indicating we've received an awaiting task request. | |
| DtRwString | myPlanName |
| bool | myContinuePlan |
| DtPlanExecutor * | myPlanExecutor |
| DtPlanStatus | myLastSentStatus |
| The status that was last sent out though the curretStatement callbacks. | |
| DtPlan::DtPlan | ( | ) |
constructor for use from within a front-end application, or when creating a plan to be assigned through DtCgf's assignPlan() function.
Note: the init function must be called after using this constructor.
| DtPlan::DtPlan | ( | const DtString & | planName, |
| DtPlanExecutor * | planExecutor, | ||
| const DtString & | name = "Plan", |
||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
constructor for use from within a back-end application
Note: the init function must be called after using this constructor.
| DtPlan::DtPlan | ( | const DtString & | name, |
| const DtString & | planName, | ||
| const DtPlan & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
copy constructor
This is a copy constructor that can register as a Readable-Writable member.
| virtual DtPlan::~DtPlan | ( | ) | [virtual] |
destructor
| virtual void DtPlan::init | ( | ) | [virtual] |
The init function must be called after any non-copy constructor!
| virtual DtPlan* DtPlan::clone | ( | const DtString & | name, |
| const DtString & | planName, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) | const [virtual] |
Returns a newly created copy of ourself.
name is the DtReaderWriter name of the plan.
Note: this will NOT copy the DtSimPlanManager pointer, and will only copy the planName if *this is not currently registered with a DtSimPlanManager (because either the DtSimPlanManager pointer is NULL or the current planName is empty).
| virtual DtString DtPlan::planName | ( | ) | const [virtual] |
| virtual void DtPlan::setPlanName | ( | const DtString & | name | ) | [virtual] |
| virtual const DtString& DtPlan::objectName | ( | ) | const [virtual] |
Get/set the object name of entity associated with this plan.
| virtual void DtPlan::setObjectName | ( | const DtString & | objectName | ) | [virtual] |
| virtual bool DtPlan::objectNameSpecified | ( | ) | const [virtual] |
true if the object name was specified in the RW structure.
| virtual void DtPlan::setPlanExecutor | ( | DtPlanExecutor * | planExecutor | ) | [virtual] |
Get a pointer to the sim manager.
| virtual DtPlanExecutor* DtPlan::planExecutor | ( | ) | const [virtual] |
| virtual void DtPlan::enableExecutionState | ( | ) | [virtual] |
Enable/disable plan execution state.
Plan will not start or advance through statements unless execution state is enabled.
| virtual void DtPlan::disableExecutionState | ( | ) | [virtual] |
| virtual bool DtPlan::executionState | ( | ) | const [virtual] |
| virtual void DtPlan::awaitingTask | ( | ) | [virtual] |
Sets our awaiting task flag (it will be handled in processAwaitingTask(), called from tick if/when plan execution state is enabled.
| virtual bool DtPlan::isAwatingTask | ( | ) | const [virtual] |
| virtual void DtPlan::pushExecutionStack | ( | ) | [virtual] |
When a retasking trigger fires, it first calls pushExecutionStack on the DtPlan.
This has the effect of duplicating the currentStmt index at the top of the stack. It does not, of itself, cause any new statements to get executed or sent to the entity. It is assumed that this call will be followed by a call to executeTrigger(), or at least setCurrentStmt().
| virtual void DtPlan::popExecutionStack | ( | bool | forceStep = false | ) | [virtual] |
When a retasking trigger completes, it calls popExecutionStack on the DtPlan.
This has the effect of popping the execution stack back to the statement that was interrupted by the trigger. If the forceStep parameter is true, this will step to the statement following the one on the stack. If false, then the plan will check to see if the new top statement is still executing. If so, it will continue with that statement, otherwise it will step to the next statement.
| virtual void DtPlan::executeTrigger | ( | DtWhenBlock * | whenBlock | ) | [virtual] |
When a DtSimTrigger gets executed, it calls the executeTrigger function which begins execution of the whenBlock.
| virtual void DtPlan::executeBlock | ( | DtSimBlock * | block | ) | [virtual] |
Begin execution of a block of tasks.
| virtual bool DtPlan::taskRequestPending | ( | ) | const [virtual] |
Get the TaskRequestPending flag.
| virtual void DtPlan::setTaskRequestPending | ( | bool | newValue = true | ) | [virtual] |
Set or clear the TaskRequestPending flag.
| virtual bool DtPlan::executeTask | ( | const DtSimTask & | taskToSend | ) | const [virtual] |
Uses the plan executor to execute the specified task in the context of this plan.
| virtual bool DtPlan::executeSetDataRequest | ( | const DtSetDataRequest & | setToSend | ) | const [virtual] |
Uses the plan executor to execute the specified set data request in the context of this plan.
| virtual bool DtPlan::executeSimCommand | ( | const DtSimCommand & | command | ) | const [virtual] |
Uses the plan executor to execute the specified simulation command in the context of this plan.
| virtual bool DtPlan::evaluateConditional | ( | const DtSimCondExpr * | condExpr | ) | const [virtual] |
Uses myPlanExecutor to evaluate the conditional expression.
False is returned if there is not plan executor.
| virtual DtStmtIndex DtPlan::firstStmt | ( | ) | const [virtual] |
Get the index of the first statement in the plan.
| virtual DtPlanBlock* DtPlan::mainBlock | ( | ) | const [virtual] |
Get a pointer to the Plan's main Block.
| virtual bool DtPlan::isEmpty | ( | ) | const [virtual] |
True if the Plan is considered "Empty" (containing no statements).
| virtual DtList* DtPlan::triggerList | ( | ) | [virtual] |
Get a pointer to the list of pending triggers.
| virtual const DtList* DtPlan::triggerList | ( | ) | const [virtual] |
| virtual void DtPlan::addTrigger | ( | DtSimTrigger * | trigger | ) | [virtual] |
Add a trigger to the pending trigger list.
| virtual void DtPlan::removeTrigger | ( | DtSimTrigger * | trigger | ) | [virtual] |
Remove a trigger from the pending trigger list.
| virtual DtList* DtPlan::executionStack | ( | ) | [virtual] |
Get a pointer to the execution stack.
| virtual const DtList* DtPlan::executionStack | ( | ) | const [virtual] |
| virtual bool DtPlan::validatePlan | ( | ) | [virtual] |
Checks, and potentially fixes, the plan.
| virtual const DtStmtIndex& DtPlan::currentStmt | ( | ) | const [virtual] |
Get the index of the Plan's "current" statement.
This is either zero (if the Plan has not yet begun to execute), or indicates the last statement executed.
| virtual void DtPlan::setCurrentStmt | ( | const DtStmtIndex & | nextStatement | ) | [virtual] |
Set the Plan's "current" statement.
| virtual void DtPlan::setCurrentStatementExecutionId | ( | int | id | ) | [virtual] |
Sets the current task execution ID to the value specified.
| virtual bool DtPlan::isComplete | ( | ) | const [virtual] |
True if the Plan is considered "Complete" and no longer active.
| virtual void DtPlan::setIsComplete | ( | bool | completeFlag = true | ) | [virtual] |
Set the Plan's completion flag, if true, further execution of the Plan is disabled.
| virtual bool DtPlan::isAbandoned | ( | ) | const [virtual] |
| virtual void DtPlan::setIsAbandoned | ( | bool | v | ) | [virtual] |
Sets whether or not the plan is abandoned.
This should not normally be called from outside this class.
| virtual bool DtPlan::isExecuting | ( | ) | const [virtual] |
| virtual DtPlanStatus DtPlan::currentStatus | ( | ) | const [virtual] |
| virtual void DtPlan::reset | ( | ) | [virtual] |
Clear all registered triggers and reset the Plan to its initial state.
| virtual void DtPlan::abandonPlan | ( | bool | sendWaitTask | ) | [virtual] |
Reset the plan, but then set isComplete and set the current statement to the last one in the Main Block.
| sendWaitTask | indicates whether or not a wait task will be sent to the entity when its plan is abandoned. This will stop its current task, if true. |
| virtual void DtPlan::restartPlan | ( | bool | sendWaitTask = true | ) | [virtual] |
Reset sthe plan.
| sendWaitTask | indicates whether or not a wait task will be sent to the entity when its plan is abandoned. This will stop its current task, if true. |
| virtual bool DtPlan::translateIndex | ( | DtStmtIndex & | stmtIndex | ) | const [virtual] |
If you have a DtStmtIndex object that used to point into the original DtPlan before it was copied/cloned into this one, use the translateIndex function to convert it to point into this DtPlan.
Returns true if a match was found, false otherwise.
| virtual void DtPlan::translateIndices | ( | DtList & | stmtIndexList | ) | const [virtual] |
If you have a list of DtStmtIndex objects that used to point into the original DtPlan before it was copied/cloned into this one, use the translateIndicies function to convert them to point into this DtPlan.
| virtual void DtPlan::tick | ( | ) | [virtual] |
The Plan tick function. Presently this ticks all the Plan's triggers.
| virtual void DtPlan::mergeEditedPlanWith | ( | const DtPlan & | oldPlan | ) | [virtual] |
This plan is an edited version of an old one, copy and/or translate over any information that we want to preserve when we replace the old plan with this one (e.g.
current statement subscriber).
| virtual DtRecursiveSimBlockIterator* DtPlan::spawnRecursiveIterator | ( | ) | const [virtual] |
Spawns an iterator that iterates over the statements in the plan.
The caller MUST DELETE the iterator when doen using it!
| virtual void DtPlan::putSelf | ( | FILE * | fp, |
| int | indentLevel = 0, |
||
| bool | writeUnspecified = false, |
||
| const DtFilename & | path = DtReaderWriter::appPath() |
||
| ) | [virtual] |
This is the top-level reader-writer member function for saving self to file.
Override to get a chance to set reader-writer member variables before saving.
Reimplemented from DtReaderWriter.
| virtual void DtPlan::getSelf | ( | DtlObjPtr | args, |
| const DtFilename & | searchPath, | ||
| const DtVariableBindingsList & | variableBindings | ||
| ) | [virtual] |
This is the top-level reader-writer member function for reading in self from file.
Override to get a chance to initialize plan from reader-writer members.
| virtual void DtPlan::addStatementChangedCallback | ( | DtCurrentStatementChangedCallbackFcn | fcn, |
| void * | usrData | ||
| ) | [virtual] |
Adds a callback which is called whenever the current statement changes or whenever the status of the plan changes.
(abandoned, complete, executing)
| virtual void DtPlan::removeStatementChangedCallback | ( | DtCurrentStatementChangedCallbackFcn | fcn, |
| void * | usrData | ||
| ) | [virtual] |
Removes a statement changed callback.
| virtual void DtPlan::processAwaitingTask | ( | ) | [protected, virtual] |
Awaiting task then (re)starts execution of plan.
| virtual void DtPlan::createMainBlock | ( | ) | [protected, virtual] |
Create the Main Block.
This is only called by init(), and should only be called once.
| virtual void DtPlan::copyMainBlock | ( | const DtPlan & | otherPlan | ) | [protected, virtual] |
Copy the main block (and all nested blocks) and the Execution Stack from another Plan, and translate any/all DtStmtIndex objects to point into the new main block structure.
| virtual void DtPlan::copyAndTranslateExecutionStack | ( | const DtPlan & | otherPlan | ) | [protected, virtual] |
Copy the other Plan's execution stack and translate all DtStmtIndex objects in the execution stack to point into the new main block.
(Called by copyMainBlock.)
| virtual void DtPlan::copyAndTranslateTriggers | ( | const DtPlan & | otherPlan | ) | [protected, virtual] |
Copy the other Plan's pending triggers and translate all DtStmtIndex objects in the triggers to point into the new main block.
(Called by copyMainBlock.)
| virtual void DtPlan::curStmtChanged | ( | ) | [protected, virtual] |
Whenever a change is made that changes the effective current statement, this function is called so that the front end can be told of the change.
| virtual void DtPlan::continuePlan | ( | ) | [protected, virtual] |
ContinuePlan will continue the Plan execution until either the task request pending flag is cleared, or the plan complete flag is set.
| virtual void DtPlan::stepStatement | ( | ) | [protected, virtual] |
StepStatement will step to the next statement in the Plan.
This is usually the first half of an execution cycle. Note: this assumes that !isComplete() and !myCurrentStmt.isNull().
| virtual void DtPlan::executeStatement | ( | ) | [protected, virtual] |
ExecuteStatement will execute the current statement in the Plan.
This is usually the second half of an execution cycle. Note: this assumes that !isComplete() and !myCurrentStmt.isNull().
| virtual void DtPlan::clearTriggerList | ( | ) | [protected, virtual] |
ClearTriggerList deletes the registered triggers and clears the pending trigger list.
| virtual void DtPlan::clearExecutionStack | ( | ) | [protected, virtual] |
ClearExecutionStack clears the execution stack and resets the Plan.
Adds a single NULL DtStmtIndex item to its list (indicating the start of the plan).
| virtual void DtPlan::emtpyExecutionStack | ( | ) | [protected, virtual] |
Removes and deletes all DtStmtIndex* entries from the execution stack.
| virtual void DtPlan::mapExecutionStackToRwExecutionStack | ( | DtRwPlanExecutionStack & | rwExecutionStack | ) | [protected, virtual] |
Called by putSelf().
Fills the specified rwExecutionStack with the data from myExecutionStack.
| virtual void DtPlan::mapPendingTriggersToPendingTriggerDataList | ( | ) | [protected, virtual] |
Called by putSelf().
Fills the specified rwExecutionStack with the data from myExecutionStack.
| virtual void DtPlan::mapOldExecutionCursorStackToExecutionStack | ( | const DtRwIntegerList & | executionCursorStack | ) | [protected, virtual] |
Called by getSelf().
Fills myExecutionStack with the data from the Pre VRF 3.12 style executionCursorStack.
| virtual void DtPlan::mapRwExecutionStackToExecutionStack | ( | const DtRwPlanExecutionStack & | rwExecutionStack | ) | [protected, virtual] |
Fills myExecutionStack with the data from rwExecutionStack.
| virtual void DtPlan::mapPendingTriggerDataToPendingTriggers | ( | ) | [protected, virtual] |
Called by getSelf().
Fills myExecutionStack with the data from the Pre VRF 3.12 style executionCursorStack.
| virtual int DtPlan::statementIdToCursor | ( | DtStmtIdType | statementId | ) | [protected, virtual] |
Maps statementId to cursor and vice-versa.
Cursor is the overall position of a statement in the plan.
| virtual DtStmtIdType DtPlan::cursorToStatementId | ( | int | cursor | ) | [protected, virtual] |
| virtual DtSimStatement* DtPlan::lookupStatementByCursor | ( | int | cursor | ) | [protected, virtual] |
Look up statement at the given cursor location (an integer identifying the overall position of a statement in a plan.
DtRwBoolean DtPlan::myTaskRequestPending [protected] |
The TaskRequestPending flag is set to true when an Entity requests a new task, and is cleared when a new task is sent by the Plan engine.
There may be any number of non-task statements processed between these two events. Further processing of the entity's plan is paused when this flag is cleared.
DtPlanBlock* DtPlan::myMainBlock [protected] |
The main Block is the top-level Block of the plan and is the only Block that is considered to be "owned" by this DtPlan object.
DtList DtPlan::myExecutionStack [protected] |
The top of the execution stack is the Plan's current statement (fetched with currentStmt()).
Whenever a retasking trigger fires, it pushes this stack down so that the Plan can pick up where it left off at the end of the trigger.
DtRwBoolean DtPlan::myIsComplete [protected] |
myIsComplete Disables awaitingTask() and causes it to emit continuous Wait tasks.
DtRwBoolean DtPlan::myAbandoned [protected] |
True if this plan has been abandoned.
If the plan is abandoned, it will also show as "complete", since it is not running.
DtList DtPlan::myPendingTriggers [protected] |
A list of all registered DtSimTriggers.
DtCallbackList<const DtPlan&> DtPlan::myStatementChangedCbs [protected] |
A list of all the DtCurrentStatementChangedCallbackFcn callbacks.
DtRwTriggerDataList DtPlan::myPendingTriggerDataList [protected] |
Reader-writer members used to hold checkpoint information about the plan.
These variables only contain valid data just before writing to file, and just after reading from file. List of DtTriggerData items, representing the list of pending triggers.
bool DtPlan::myExecutionIsEnabled [protected] |
Flag indication whether execution is enabled (can we start or advance through plan statements?).
bool DtPlan::myAwaitingTaskFlag [protected] |
Flag indicating we've received an awaiting task request.
DtRwString DtPlan::myPlanName [protected] |
bool DtPlan::myContinuePlan [protected] |
DtPlanExecutor* DtPlan::myPlanExecutor [protected] |
DtPlanStatus DtPlan::myLastSentStatus [protected] |
The status that was last sent out though the curretStatement callbacks.