WsfLocalTrackStatus Class Reference

An auxiliary class for storing decision-making data that pertains to a local track. More...

#include <WsfLocalTrackStatus.hpp>

Public Member Functions
	WsfLocalTrackStatus ()=default
	WsfLocalTrackStatus (double aSimTime, WsfSimulation &aSimulation, const WsfLocalTrack *aLocalTrackPtr)
virtual	~WsfLocalTrackStatus ()=default

Static Public Member Functions
static std::unique_ptr< UtScriptClass >	CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)

State management methods.
int	GetStateIndex () const
	Get the state index within the state machine.
WsfStringId	GetStateName () const
	Get the state name that is associated with the above state index (diagnostic use only).
double	GetLastStateChangeTime () const
void	SetState (double aSimTime, int aStateIndex, WsfStringId aStateName)
bool	TransitionPending () const
	Is a transition pending into the current state.
void	SetTransitionPending (bool aTransitionPending)
	Set or clear the 'transition pending' status.
unsigned int	EvaluationEpoch () const
	Periodic evaluation control.
void	UpdateEvaluationEpoch ()

Local Track ID methods.
const WsfTrackId &	GetLocalTrackId () const
	the track ID of the local track with which this status is associated.

Target Name methods.
WsfStringId	GetTargetName () const
	Get the string ID of the target that is associated with the local track.
void	UpdateTargetName (WsfSimulation &aSimulation, const WsfLocalTrack *aLocalTrackPtr)

Detailed Description

An auxiliary class for storing decision-making data that pertains to a local track.

Constructor & Destructor Documentation

WsfLocalTrackStatus() [1/2]

WsfLocalTrackStatus::WsfLocalTrackStatus ( )

default

References WsfLocalTrackStatus().

Referenced by WsfLocalTrackStatus().

WsfLocalTrackStatus() [2/2]

WsfLocalTrackStatus::WsfLocalTrackStatus	(	double	aSimTime,
		WsfSimulation &	aSimulation,
		const WsfLocalTrack *	aLocalTrackPtr )

References GetTrackId(), and UpdateTargetName().

~WsfLocalTrackStatus()

virtual WsfLocalTrackStatus::~WsfLocalTrackStatus ( )

virtualdefault

References CreateScriptClass().

Member Function Documentation

CreateScriptClass()

std::unique_ptr< UtScriptClass > WsfLocalTrackStatus::CreateScriptClass ( const std::string & aClassName, UtScriptTypes * aScriptTypesPtr )

static

Create the 'class' object for the script system. This is invoked once by WsfScriptManager to create the 'class' object that defines the interface to instances of this class from the script system.

Referenced by WsfScriptManager::RegisterTypes(), and ~WsfLocalTrackStatus().

EvaluationEpoch()

unsigned int WsfLocalTrackStatus::EvaluationEpoch ( ) const

inline

Periodic evaluation control.

Referenced by WsfTrackStateController::EvaluationComplete(), and WsfTrackStateController::RequestEvaluation().

GetLastStateChangeTime()

double WsfLocalTrackStatus::GetLastStateChangeTime ( ) const

inline

GetLocalTrackId()

const WsfTrackId & WsfLocalTrackStatus::GetLocalTrackId ( ) const

inline

the track ID of the local track with which this status is associated.

Referenced by WsfTrackStateController::EvaluateTrack(), and WsfTrackStateController::TracksInState().

GetStateIndex()

int WsfLocalTrackStatus::GetStateIndex ( ) const

inline

Get the state index within the state machine.

Referenced by WsfTrackStateController::DeleteTrack(), WsfTrackStateController::EnterState(), WsfTrackStateController::EvaluateTrack(), WsfTrackStateController::EvaluationComplete(), WsfTrackStateController::ProcessMessage(), WsfTrackStateController::SubmitRequest(), and WsfTrackStateController::TracksInState().

GetStateName()

WsfStringId WsfLocalTrackStatus::GetStateName ( ) const

inline

Get the state name that is associated with the above state index (diagnostic use only).

Referenced by WsfTrackStateController::StateOfTrack().

GetTargetName()

WsfStringId WsfLocalTrackStatus::GetTargetName ( ) const

inline

Get the string ID of the target that is associated with the local track.

Referenced by WsfTrackStateController::DeleteTrack().

SetState()

void WsfLocalTrackStatus::SetState ( double aSimTime, int aStateIndex, WsfStringId aStateName )

inline

Set the state index and name of the current state of the associated local track.

Parameters

aSimTime	The current simulation time.
aStateIndex	The index of the state within the state machine.
aStateName	The name of the state within the state machine.

Referenced by WsfTrackStateController::EnterState(), and WsfTrackStateController::EvaluateTrack().

SetTransitionPending()

void WsfLocalTrackStatus::SetTransitionPending ( bool aTransitionPending )

inline

Set or clear the 'transition pending' status.

Referenced by WsfTrackStateController::EnterState(), and WsfTrackStateController::EvaluateTrack().

TransitionPending()

bool WsfLocalTrackStatus::TransitionPending ( ) const

inline

Is a transition pending into the current state.

Referenced by WsfTrackStateController::EnterState(), WsfTrackStateController::EvaluateTrack(), WsfTrackStateController::EvaluationComplete(), and WsfTrackStateController::SubmitRequest().

UpdateEvaluationEpoch()

void WsfLocalTrackStatus::UpdateEvaluationEpoch ( )

inline

Referenced by WsfTrackStateController::EnterState(), and WsfTrackStateController::ProcessMessage().

UpdateTargetName()

void WsfLocalTrackStatus::UpdateTargetName	(	WsfSimulation &	aSimulation,
		const WsfLocalTrack *	aTrackPtr )

Update the truth target name that is associated with the specified track. This should be called to maintain the name of the target that is associated with the track.

Parameters

aSimulation	The simulation
aTrackPtr	Pointer to the local track.

References WsfSimulation::GetPlatformByIndex(), WsfTrack::GetTargetIndex(), WsfTrack::GetTargetName(), and platformPtr.

Referenced by WsfTrackStateController::EnterState(), WsfTrackStateController::EvaluateTrack(), and WsfLocalTrackStatus().

---

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

• WsfLocalTrackStatus.hpp
• WsfLocalTrackStatus.cpp