WsfMoverMode Class Reference

#include <WsfMoverMode.hpp>

Inheritance diagram for WsfMoverMode:

Collaboration diagram for WsfMoverMode:

Public Member Functions
	WsfMoverMode ()
	WsfMoverMode (const WsfMoverMode &aSrc)
WsfMoverMode &	operator= (const WsfMoverMode &aRhs)
	~WsfMoverMode () override=default
WsfPlatform *	GetPlatform () const
	Return the pointer to the platform to which the associated sensor is attached.
WsfMover *	GetMover () const
	Return the pointer to the Mover with which this mode is associated.
WsfMode *	Clone () const override=0
	Create an exact duplicate of this mode.
virtual bool	Initialize (double aSimTime, WsfMover *aMoverPtr)
	Initialize the Mover Mode.
bool	ProcessInput (UtInput &aInput) override
void	Deselect (double aSimTime) override=0
void	Select (double aSimTime) override=0
Public Member Functions inherited from WsfMode
	WsfMode ()
	~WsfMode () override=default
size_t	GetModeIndex () const
	Return the index of this mode within its associated mode list.
bool	IsSelected () const
	Returns 'true' if the mode is selected.
Public Member Functions inherited from WsfNamed
	WsfNamed ()
	WsfNamed (WsfStringId aName)
	WsfNamed (const WsfNamed &)=default
WsfNamed &	operator= (const WsfNamed &)=default
virtual	~WsfNamed ()=default
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Protected Attributes
WsfMover *	mMoverPtr
	Pointer to the Mover with which the mode is associated.
WsfPlatform *	mPlatformPtr
	Pointer to the platform with which the sensor is associated.

Detailed Description

A specialization of WsfMode for movers. A mover mode represents a particular set of motion characteristics for a mover. For instance, a mover may have climb, cruise, descent modes, each with particular speed and rate-of-climb constraints.

Constructor & Destructor Documentation

WsfMoverMode() [1/2]

WsfMoverMode::WsfMoverMode

(

)

References mMoverPtr, mPlatformPtr, and WsfMode::WsfMode().

Referenced by operator=(), WsfRotorcraftMover::RotorcraftMode::RotorcraftMode(), WsfRotorcraftMover::RotorcraftMode::RotorcraftMode(), and WsfMoverMode().

WsfMoverMode() [2/2]

WsfMoverMode::WsfMoverMode

(

const WsfMoverMode &

aSrc

)

References mMoverPtr, mPlatformPtr, WsfMode::WsfMode(), and WsfMoverMode().

~WsfMoverMode()

WsfMoverMode::~WsfMoverMode ( )

overridedefault

Member Function Documentation

Clone()

WsfMode * WsfMoverMode::Clone ( ) const

overridepure virtual

Create an exact duplicate of this mode.

Implements WsfMode.

Implemented in WsfRotorcraftMover::RotorcraftMode.

References Initialize(), and WsfMode::WsfMode().

Deselect()

void WsfMoverMode::Deselect ( double aSimTime )

overridepure virtual

The mode is being deselected. The specific implementation should perform whatever actions are associated with de-selecting the mode (e.g.: deactivating transmitters or receivers).

Parameters

aSimTime

[input] The current simulation time.

Reimplemented from WsfMode.

Implemented in WsfRotorcraftMover::RotorcraftMode.

GetMover()

WsfMover * WsfMoverMode::GetMover ( ) const

inline

Return the pointer to the Mover with which this mode is associated.

References mMoverPtr.

GetPlatform()

WsfPlatform * WsfMoverMode::GetPlatform ( ) const

inline

Return the pointer to the platform to which the associated sensor is attached.

References mPlatformPtr.

Initialize()

bool WsfMoverMode::Initialize ( double aSimTime, WsfMover * aMoverPtr )

virtual

Initialize the Mover Mode.

Initialize the Mover mode.

Parameters

aSimTime	The current simulation time.
aMoverPtr	The pointer to the Mover with which this mode is associated.

Returns

'true' if the mode was successfully initialize or 'false' if not.

References WsfPlatformPart::GetPlatform(), mMoverPtr, mPlatformPtr, and ok.

Referenced by Clone().

operator=()

WsfMoverMode & WsfMoverMode::operator=

(

const WsfMoverMode &

aRhs

)

References mMoverPtr, mPlatformPtr, WsfNamed::operator=(), and WsfMoverMode().

ProcessInput()

bool WsfMoverMode::ProcessInput ( UtInput & aInput )

overridevirtual

Reimplemented from WsfMode.

Referenced by WsfRotorcraftMover::RotorcraftMode::ProcessInput().

Select()

void WsfMoverMode::Select ( double aSimTime )

overridepure virtual

The mode is being activated. The specific implementation should perform whatever actions are associated with selecting the mode (e.g.: activating transmitters or receivers).

Parameters

aSimTime

[input] The current simulation time.

Reimplemented from WsfMode.

Implemented in WsfRotorcraftMover::RotorcraftMode.

Member Data Documentation

mMoverPtr

WsfMover* WsfMoverMode::mMoverPtr

protected

Pointer to the Mover with which the mode is associated.

Referenced by GetMover(), Initialize(), operator=(), WsfMoverMode(), and WsfMoverMode().

mPlatformPtr

WsfPlatform* WsfMoverMode::mPlatformPtr

protected

Pointer to the platform with which the sensor is associated.

Referenced by GetPlatform(), Initialize(), operator=(), WsfMoverMode(), and WsfMoverMode().

---

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

• WsfMoverMode.hpp
• WsfMoverMode.cpp