#include <WsfMode.hpp>

Inheritance diagram for WsfMode:

[legend]

Collaboration diagram for WsfMode:

Public Member Functions
	WsfMode ()
	~WsfMode () override=default
virtual WsfMode *	Clone () const =0
virtual bool	ProcessInput (UtInput &aInput)
virtual void	Select (double aSimTime)
virtual void	Deselect (double aSimTime)
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)

Friends
class	WsfModeList

Detailed Description

An abstract base class that represents the operating mode of a platform subsystem.

Many platform subsystems (sensors, interferers, radios) have a concept of 'modes'. A mode would be specific set of subsystem parameters (frequency, PRF, power, etc.) that would typically be selected by the 'operator' using some sort of switch.

A derived class implements the actions that are associated with selecting and de-selecting the mode.

WsfModeList is used to maintain a collection of modes.

Constructor & Destructor Documentation

◆ WsfMode()

WsfMode::WsfMode ( )

References WsfNamed::WsfNamed().

Referenced by WsfAcousticSensor::AcousticMode::Clone(), WsfCompositeSensor::CompositeMode::Clone(), WsfEOIR_Sensor::EOIR_Mode::Clone(), WsfESM_Sensor::ESM_Mode::Clone(), WsfGeometricSensor::GeometricMode::Clone(), WsfIRST_Sensor::IRST_Mode::Clone(), WsfLADAR_Sensor::LADAR_Mode::Clone(), WsfLaserDesignator::LaserDesignationMode::Clone(), WsfLaserTracker::LaserTrackMode::Clone(), Clone(), WsfMoverMode::Clone(), WsfOpticalSensor::OpticalMode::Clone(), WsfOTH_RadarSensor::OTH_Mode::Clone(), WsfPassiveSensor::PassiveMode::Clone(), WsfRadarSensor::RadarMode::Clone(), WsfRF_Jammer::JammerMode::Clone(), WsfRotorcraftMover::RotorcraftMode::Clone(), WsfSAR_Sensor::SAR_Mode::Clone(), WsfSensorMode::Clone(), WsfSOSM_Sensor::SOSM_Mode::Clone(), WsfSurfaceWaveRadarSensor::RadarMode::Clone(), WsfWeapon::WsfWeaponMode::Clone(), WsfAcousticSensor::AcousticMode::operator=(), WsfLADAR_Sensor::LADAR_Mode::operator=(), WsfLaserDesignator::LaserDesignationMode::operator=(), WsfLaserTracker::LaserTrackMode::operator=(), WsfRF_Jammer::JammerMode::operator=(), WsfSOSM_Sensor::SOSM_Mode::operator=(), WsfModeList, WsfMoverMode::WsfMoverMode(), WsfMoverMode::WsfMoverMode(), WsfSensorMode::WsfSensorMode(), WsfWeapon::WsfWeaponMode::WsfWeaponMode(), WsfWeapon::WsfWeaponMode::WsfWeaponMode(), WsfCompositeSensor::CompositeMode::~CompositeMode(), WsfEOIR_Sensor::EOIR_Mode::~EOIR_Mode(), WsfESM_Sensor::ESM_Mode::~ESM_Mode(), WsfIRST_Sensor::IRST_Mode::~IRST_Mode(), WsfOpticalSensor::OpticalMode::~OpticalMode(), and WsfRotorcraftMover::RotorcraftMode::~RotorcraftMode().

◆ ~WsfMode()

WsfMode::~WsfMode ( )

overridedefault

Member Function Documentation

◆ Clone()

virtual WsfMode * WsfMode::Clone ( ) const

pure virtual

◆ Deselect()

virtual void WsfMode::Deselect ( double aSimTime )

inlinevirtual

Perform any actions necessary to de-select this mode.

Parameters

aSimTime The current simulation time.

Note: This called ONLY by WsfModeList. Any other use is undefined.

Reimplemented in WsfAcousticSensor::AcousticMode, WsfBeamDirector::WsfBeamDirectorMode, WsfCompositeSensor::CompositeMode, WsfEOIR_Sensor::EOIR_Mode, WsfGeometricSensor::GeometricMode, WsfIRST_Sensor::IRST_Mode, WsfLADAR_Sensor::LADAR_Mode, WsfLaserDesignator::LaserDesignationMode, WsfLaserTracker::LaserTrackMode, WsfMoverMode, WsfOpticalSensor::OpticalMode, WsfOTH_RadarSensor::OTH_Mode, WsfPassiveSensor::PassiveMode, WsfRadarSensor::RadarMode, WsfRF_Jammer::JammerMode, WsfRotorcraftMover::RotorcraftMode, WsfSAR_Sensor::SAR_Mode, WsfSensorMode, WsfSOSM_Sensor::SOSM_Mode, WsfSurfaceWaveRadarSensor::RadarMode, and WsfWeapon::WsfWeaponMode.

Referenced by WsfModeList::DeselectP().

◆ GetModeIndex()

size_t WsfMode::GetModeIndex ( ) const

inline

Return the index of this mode within its associated mode list.

◆ IsSelected()

bool WsfMode::IsSelected ( ) const

inline

Returns 'true' if the mode is selected.

Referenced by WsfDefaultSensorScheduler::CheckSearchModeAvailability(), WsfPhysicalScanSensorScheduler::CheckSearchModeAvailability(), WsfModeList::DeselectP(), WsfXIO_PlatformInfoService::FillPartState(), WsfXIO_WeaponComponent::FillPartState(), WsfEW_SensorComponent::PrePerformScheduledDetections(), WsfDefaultSensorScheduler::SelectMode(), WsfModeList::SelectP(), and WsfSensor::TurnOn().

◆ ProcessInput()

bool WsfMode::ProcessInput ( UtInput & aInput )

virtual

◆ Select()

virtual void WsfMode::Select ( double aSimTime )

inlinevirtual

Perform any actions necessary to select this mode.

Parameters

aSimTime The current simulation time.

Note: This called ONLY by WsfModeList. Any other use is undefined.

Reimplemented in WsfAcousticSensor::AcousticMode, WsfBeamDirector::WsfBeamDirectorMode, WsfCompositeSensor::CompositeMode, WsfEOIR_Sensor::EOIR_Mode, WsfGeometricSensor::GeometricMode, WsfIRST_Sensor::IRST_Mode, WsfLADAR_Sensor::LADAR_Mode, WsfLaserDesignator::LaserDesignationMode, WsfLaserTracker::LaserTrackMode, WsfMoverMode, WsfOpticalSensor::OpticalMode, WsfOTH_RadarSensor::OTH_Mode, WsfPassiveSensor::PassiveMode, WsfRadarSensor::RadarMode, WsfRF_Jammer::JammerMode, WsfRotorcraftMover::RotorcraftMode, WsfSAR_Sensor::SAR_Mode, WsfSensorMode, WsfSOSM_Sensor::SOSM_Mode, WsfSurfaceWaveRadarSensor::RadarMode, and WsfWeapon::WsfWeaponMode.

Referenced by WsfModeList::SelectP(), and WsfDisEmission::UpdateSensor().

◆ WsfModeList

friend class WsfModeList

friend

References WsfMode(), and WsfModeList.

Referenced by WsfSensorMode::Initialize(), and WsfModeList.

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

Public Member Functions

Friends