WSF
WsfRotorcraftMover::RotorcraftMode Class Reference

A 'mode' of the Rotorcraft Mover. More...

#include <WsfRotorcraftMover.hpp>

Inheritance diagram for WsfRotorcraftMover::RotorcraftMode:
Collaboration diagram for WsfRotorcraftMover::RotorcraftMode:

Public Member Functions

 RotorcraftMode ()
 RotorcraftMode (const RotorcraftMode &aSrc)
RotorcraftModeoperator= (const RotorcraftMode &)=delete
 ~RotorcraftMode () override=default
WsfModeClone () const override
 Create an exact duplicate of this mode.
bool ProcessInput (UtInput &aInput) override
void Deselect (double aSimTime) override
void Select (double aSimTime) override
Public Member Functions inherited from WsfMoverMode
 WsfMoverMode ()
 WsfMoverMode (const WsfMoverMode &aSrc)
WsfMoverModeoperator= (const WsfMoverMode &aRhs)
 ~WsfMoverMode () override=default
WsfPlatformGetPlatform () const
 Return the pointer to the platform to which the associated sensor is attached.
WsfMoverGetMover () const
 Return the pointer to the Mover with which this mode is associated.
virtual bool Initialize (double aSimTime, WsfMover *aMoverPtr)
 Initialize the Mover Mode.
bool ProcessInput (UtInput &aInput) override
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
WsfNamedoperator= (const WsfNamed &)=default
virtual ~WsfNamed ()=default
const std::string & GetName () const
WsfStringId GetNameId () const
void SetName (WsfStringId aName)

Public Attributes

double mWeathercockSpeed
double mMaximumAttitudeRate
double mMinimumUpwardAccel
double mBodyRatesGain
double mMaximumGroundSpeed
double mMaximumRateOfClimb
double mMaximumRateOfDescent
double mMaximumTotalAccel

Static Public Attributes

static const double cNOT_SET = -1.23456E-78

Additional Inherited Members

Protected Attributes inherited from WsfMoverMode
WsfMovermMoverPtr
 Pointer to the Mover with which the mode is associated.
WsfPlatformmPlatformPtr
 Pointer to the platform with which the sensor is associated.

Detailed Description

A 'mode' of the Rotorcraft Mover.

Constructor & Destructor Documentation

◆ RotorcraftMode() [1/2]

◆ RotorcraftMode() [2/2]

◆ ~RotorcraftMode()

WsfRotorcraftMover::RotorcraftMode::~RotorcraftMode ( )
overridedefault

Member Function Documentation

◆ Clone()

WsfMode * WsfRotorcraftMover::RotorcraftMode::Clone ( ) const
overridevirtual

Create an exact duplicate of this mode.

Implements WsfMoverMode.

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

Referenced by ~RotorcraftMode().

◆ Deselect()

void WsfRotorcraftMover::RotorcraftMode::Deselect ( double aSimTime)
overridevirtual

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.

Implements WsfMoverMode.

Referenced by ~RotorcraftMode().

◆ operator=()

RotorcraftMode & WsfRotorcraftMover::RotorcraftMode::operator= ( const RotorcraftMode & )
delete

References RotorcraftMode().

◆ ProcessInput()

bool WsfRotorcraftMover::RotorcraftMode::ProcessInput ( UtInput & aInput)
overridevirtual

◆ Select()

void WsfRotorcraftMover::RotorcraftMode::Select ( double aSimTime)
overridevirtual

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.

Implements WsfMoverMode.

Referenced by ~RotorcraftMode().

Member Data Documentation

◆ cNOT_SET

const double WsfRotorcraftMover::RotorcraftMode::cNOT_SET = -1.23456E-78
static

◆ mBodyRatesGain

double WsfRotorcraftMover::RotorcraftMode::mBodyRatesGain

◆ mMaximumAttitudeRate

double WsfRotorcraftMover::RotorcraftMode::mMaximumAttitudeRate

◆ mMaximumGroundSpeed

double WsfRotorcraftMover::RotorcraftMode::mMaximumGroundSpeed

◆ mMaximumRateOfClimb

double WsfRotorcraftMover::RotorcraftMode::mMaximumRateOfClimb

◆ mMaximumRateOfDescent

double WsfRotorcraftMover::RotorcraftMode::mMaximumRateOfDescent

◆ mMaximumTotalAccel

double WsfRotorcraftMover::RotorcraftMode::mMaximumTotalAccel

◆ mMinimumUpwardAccel

double WsfRotorcraftMover::RotorcraftMode::mMinimumUpwardAccel

◆ mWeathercockSpeed

double WsfRotorcraftMover::RotorcraftMode::mWeathercockSpeed

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