Eaagles::Simulation::SteerpointAction Class Reference

Inherits Eaagles::Basic::LcComponent.

Inherited by Eaagles::Simulation::SteerpointActionCamouflageType, Eaagles::Simulation::SteerpointActionDecoyRelease, Eaagles::Simulation::SteerpointActionImaging, and Eaagles::Simulation::SteerpointActionWeaponRelease.

Inheritance diagram for Eaagles::Simulation::SteerpointAction:

[legend]Collaboration diagram for Eaagles::Simulation::SteerpointAction:

[legend]List of all members.

Public Member Functions
	SteerpointAction ()
virtual bool	isReadyToStart ()
virtual bool	isInProgress ()
virtual bool	isCompleted ()
virtual bool	trigger (Route *const route)
virtual bool	cancel ()
virtual void	process (const LCreal dt)
int	getRefId () const
virtual void	setRefId (const int id)
unsigned short	getSteerpointNumber () const
Protected Member Functions
Route *	getRouteManager ()
bool	setRouteManager (Route *const rm)
virtual void	setCompleted (const bool flg)
Private Attributes
SPtr< Route >	routeMgr
int	refId
unsigned short	stptNumber
bool	completed

---

Detailed Description

Actions that occur at steerpoints.

    Notes:

     1) use process() to process one action frame of delta time, 'dt'.  Follow
     standard real-time rules since process() may be called from updateTC().

     2) Actions that are not ready to start (isReadyToStart()) at steerpoint
        crossing may be skipped by the route manager.

     3) One shot action will complete during the call to trigger().

     4) Any action that will take time to complete must have a route manager
        passed via trigger().

    Guid: {F4772DC9-F695-4cdb-BBE2-6431B2D43A8B} 

---

Constructor & Destructor Documentation

Eaagles::Simulation::SteerpointAction::SteerpointAction

(

)

---

Member Function Documentation

bool Eaagles::Simulation::SteerpointAction::isReadyToStart

(

)

[virtual]

True if action is ready to start.

bool Eaagles::Simulation::SteerpointAction::isInProgress

(

)

[virtual]

True if action is in progress.

bool Eaagles::Simulation::SteerpointAction::isCompleted

(

)

[virtual]

True if action has been completed.

bool Eaagles::Simulation::SteerpointAction::trigger

(

Route *const

route

)

[virtual]

Starts this action.

Reimplemented in Eaagles::Simulation::SteerpointActionImaging, Eaagles::Simulation::SteerpointActionWeaponRelease, Eaagles::Simulation::SteerpointActionDecoyRelease, and Eaagles::Simulation::SteerpointActionCamouflageType.

bool Eaagles::Simulation::SteerpointAction::cancel

(

)

[virtual]

Cancels this action.

Reimplemented in Eaagles::Simulation::SteerpointActionImaging.

void Eaagles::Simulation::SteerpointAction::process

(

const LCreal

dt

)

[virtual]

Action processing.

Reimplemented in Eaagles::Simulation::SteerpointActionImaging, and Eaagles::Simulation::SteerpointActionDecoyRelease.

int Eaagles::Simulation::SteerpointAction::getRefId

(

)

const [inline]

Message Ref ID.

void Eaagles::Simulation::SteerpointAction::setRefId

(

const int

id

)

[virtual]

Sets the message ref ID.

unsigned short Eaagles::Simulation::SteerpointAction::getSteerpointNumber

(

)

const [inline]

Steerpoint number for this action.

Route* Eaagles::Simulation::SteerpointAction::getRouteManager

(

)

[inline, protected]

Our route manager.

bool Eaagles::Simulation::SteerpointAction::setRouteManager

(

Route *const

rm

)

[protected]

Set our route manager.

void Eaagles::Simulation::SteerpointAction::setCompleted

(

const bool

flg

)

[protected, virtual]

Sets the completed flag.

Reimplemented in Eaagles::Simulation::SteerpointActionImaging.

---

Member Data Documentation

SPtr<Route> Eaagles::Simulation::SteerpointAction::routeMgr [private]

Our route manager (only set while we're in progress).

int Eaagles::Simulation::SteerpointAction::refId [private]

Ref ID.

unsigned short Eaagles::Simulation::SteerpointAction::stptNumber [private]

Steerpoint number for this action.

bool Eaagles::Simulation::SteerpointAction::completed [private]

True if action has been completed.

---