WSF
WsfTrackStateController::TrackStateMachine Class Reference

#include <WsfTrackStateController.hpp>

Inheritance diagram for WsfTrackStateController::TrackStateMachine:
Collaboration diagram for WsfTrackStateController::TrackStateMachine:

Public Member Functions

 TrackStateMachine ()
 TrackStateMachine (WsfScriptContext &aContext, WsfTrackStateController *aControllerPtr)
 TrackStateMachine (const TrackStateMachine &aSrc, WsfScriptContext &aContext, WsfTrackStateController *aControllerPtr)
void EnterStateNotify (int aStateIndex) override
void ExitStateNotify (int aStateIndex) override
Public Member Functions inherited from WsfScriptStateMachine
 WsfScriptStateMachine ()=default
 WsfScriptStateMachine (WsfScriptContext &aContext, WsfScriptProcessor *aParentProcPtr=nullptr, WsfStringId aParentNameSpace=nullptr)
 WsfScriptStateMachine (const WsfScriptStateMachine &aSrc, WsfScriptContext &aContext, WsfScriptProcessor *aParentProcPtr=nullptr)
virtual ~WsfScriptStateMachine ()=default
const WsfScriptStateMachineoperator= (const WsfScriptStateMachine &aRhs)=delete
 WsfScriptStateMachine (const WsfScriptStateMachine &aSrc)=delete
const size_t Id () const
 Return the id for this state machine.
virtual int Evaluate (int aCurrentStateIndex)
virtual int EvaluateState (int aCurrentStateIndex, bool aDoNewStateEntry=true)
virtual void EnterState (int aStateIndex)
virtual void ExitState (int aStateIndex)
StateFindState (WsfStringId aStateName) const
int GetInitialStateIndex () const
StateGetState (int aStateIndex) const
int GetStateCount () const
 Return the number of states in the state machine.
int GetStateIndex (WsfStringId aStateName) const
WsfStringId GetStateName (int aStateIndex) const
 Return the name (ID) of a state given its state index.
virtual bool Initialize (double aSimTime)
virtual bool ProcessInput (UtInput &aInput)
void ShowStateEvaluations (bool aShowStateEvaluations)
bool ShowStateEvaluations () const
void ShowStateTransitions (bool aShowStateTransitions)
bool ShowStateTransitions () const
void SetProcessor (WsfScriptProcessor *aProcessor)
WsfScriptProcessorProcessor ()

Additional Inherited Members

Public Types inherited from WsfScriptStateMachine
using TransitionList = std::vector<std::unique_ptr<Transition>>
 A list of transitions.
using StateList = std::vector<std::unique_ptr<State>>
 A collection of states.
Static Public Member Functions inherited from WsfScriptStateMachine
static std::unique_ptr< UtScriptClass > CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
Protected Member Functions inherited from WsfScriptStateMachine
virtual void EnterState (State *aStatePtr)
virtual void ExitState (State *aStatePtr)
virtual std::unique_ptr< StateCreateState (WsfStringId aStateName, WsfScriptContext &aContext)
Protected Attributes inherited from WsfScriptStateMachine
WsfScriptContextmContextPtr {nullptr}
 The context used for compiling and executing scripts.
WsfStringId mParentNameSpace
StateList mStateList
 The list of states.
bool mShowStateEvaluations {false}
bool mShowStateTransitions {false}
WsfScriptProcessormParentProcessorPtr {nullptr}
size_t mId
 Unique integer id of this state machine.

Constructor & Destructor Documentation

◆ TrackStateMachine() [1/3]

WsfTrackStateController::TrackStateMachine::TrackStateMachine ( )
inline

Referenced by TrackStateMachine().

◆ TrackStateMachine() [2/3]

WsfTrackStateController::TrackStateMachine::TrackStateMachine ( WsfScriptContext & aContext,
WsfTrackStateController * aControllerPtr )
inline

◆ TrackStateMachine() [3/3]

WsfTrackStateController::TrackStateMachine::TrackStateMachine ( const TrackStateMachine & aSrc,
WsfScriptContext & aContext,
WsfTrackStateController * aControllerPtr )
inline

Member Function Documentation

◆ EnterStateNotify()

void WsfTrackStateController::TrackStateMachine::EnterStateNotify ( int aStateIndex)
inlineoverridevirtual

This method is invoked by the base class whenever a state is about to be entered.

Parameters
aStateIndexThe index of the state [1..N] that is about to be entered.

Reimplemented from WsfScriptStateMachine.

◆ ExitStateNotify()

void WsfTrackStateController::TrackStateMachine::ExitStateNotify ( int aStateIndex)
inlineoverridevirtual

This method is invoked by the base class whenever a state is about to be exited.

Parameters
aStateIndexThe index of the state [1..N] that is about to be exit.

Reimplemented from WsfScriptStateMachine.


The documentation for this class was generated from the following file:
Copyrights Multiple, All Rights Reserved