WSF
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
WsfRadarSensor::RadarMode Class Reference

A 'mode' of the sensor. More...

#include <WsfRadarSensor.hpp>

Inheritance diagram for WsfRadarSensor::RadarMode:
Inheritance graph
[legend]
Collaboration diagram for WsfRadarSensor::RadarMode:
Collaboration graph
[legend]

Public Member Functions

 RadarMode ()
 RadarMode (const RadarMode &aSrc)
RadarMode & operator= (const RadarMode &aRhs)
 ~RadarMode () override
size_t GetBeamCount () const override
WsfSensorBeam * GetBeamEntry (size_t aIndex) override
WsfMode * Clone () const override
 Create an exact duplicate of this mode.
bool Initialize (double aSimTime) override
bool ProcessInput (UtInput &aInput) override
bool AttemptToDetect (double aSimTime, WsfPlatform *aTargetPtr, Settings &aSettings, WsfSensorResult &aResult) override
double GetAltFreqSelectDelay () const override
void ScheduleAltFreqChange (double aSimTime, int aAltFreqId=-1) override
bool IsAltFreqChangeScheduled () const override
double GetLastAltFreqSelectTime () const override
bool IsFrequencyAgile () const override
void Deselect (double aSimTime) override
void Select (double aSimTime) override
Public Member Functions inherited from WsfSensorMode
 WsfSensorMode ()
 WsfSensorMode (const WsfSensorMode &aSrc)
WsfSensorMode & operator= (const WsfSensorMode &aRhs)
 ~WsfSensorMode () override
WsfPlatform * GetPlatform () const
 Return the pointer to the platform to which the associated sensor is attached.
WsfSensor * GetSensor () const
 Return the pointer to the sensor with which this mode is associated.
const WsfScenario & GetScenario () const
WsfSimulation * GetSimulation () const
bool ProcessInput (UtInput &aInput) override
size_t GetOnSuccessModeIndex () const
size_t GetOnFailureModeIndex () const
int GetMessageLength () const
 Return the logical length (int bits) of report messages that originate from this sensor mode.
int GetMessagePriority () const
 Return the priority of report messages that originate from this sensor mode.
void UpdateTrackPosition (WsfTrack *aTrackPtr, WsfSensorResult &aResult, const double aTgtLocationWCS[3])
WsfSensor::SlewMode GetCueMode () const
virtual void ApplyMeasurementErrors (WsfSensorResult &aResult)
virtual WSF_DEPRECATED void ComputeMeasurementErrors (WsfSensorResult &aResult, double &aAzError, double &aElError, double &aRangeError, double &aRangeRateError) final
virtual void InitializeTrack (double aSimTime, WsfTrack *&aTrackPtr)
virtual void UpdateSensorCueingLimits ()
virtual void UpdateTrack (double aSimTime, WsfTrack *aTrackPtr, WsfPlatform *aTargetPtr, WsfSensorResult &aResult)
virtual void UpdateTrackReportingFlags (double aSimTime, WsfTrack *aTrackPtr)
virtual bool WithinDetectionRange (double aSimTime, WsfPlatform *aTargetPtr)
double GetMaximumRange () const
 Return the optimistic maximum range of the sensor mode.
int GetMaximumRequestCount () const
 Return the maximum number of cued-search or tracking requests the mode can support.
bool DisablesSearch () const
 Does using this mode prevent this or any other mode from searching?
bool CanSearchWhileTrack () const
 Can this mode continue to search while it is also performing tracking requests.
double GetFrameTime () const
void SetFrameTime (double aFrameTime)
double GetRevisitTime () const
double GetDwellTime () const
double GetRequiredPd () const
double EstablishTrackProbability () const
double MaintainTrackProbability () const
int HitsToEstablishTrack () const
 The number of hits (M) within the window (N) that are required to establish a track.
int EstablishTrackWindow () const
 The window size (N) for establishing a track.
int HitsToMaintainTrack () const
 The number of hits (M) within the window (N) that are required to maintain a track.
int MaintainTrackWindow () const
 The window size (N) for maintaining a track.
unsigned int EstablishTrackMask () const
unsigned int MaintainTrackMask () const
double GetTrackQuality () const
unsigned int GetReportingFlags () const
 Accessors for the reporting flags.
bool ReportsLocation () const
bool ReportsVelocity () const
bool ReportsRange () const
bool ReportsBearing () const
bool ReportsElevation () const
bool ReportsRangeRate () const
bool ReportsSide () const
bool ReportsType () const
bool ReportsIFF_Status () const
bool ReportsSignalToNoise () const
bool ReportsFrequency () const
bool ReportsPulseWidth () const
bool ReportsPulseRepititionInterval () const
const wsf::SensorErrorModelBase * GetErrorModel () const
wsf::SensorErrorModelBase * GetErrorModel ()
void SetErrorModel (std::unique_ptr< wsf::SensorErrorModelBase > aErrorModelPtr)
virtual WSF_DEPRECATED double GetAzErrorStdDev () final
virtual WSF_DEPRECATED double GetElErrorStdDev () final
virtual WSF_DEPRECATED double GetRangeErrorStdDev () final
virtual WSF_DEPRECATED double GetRangeRateErrorStdDev () final
virtual WSF_DEPRECATED void SetAzErrorStdDev (double aAzErrorStdDev) final
virtual WSF_DEPRECATED void SetElErrorStdDev (double aElErrorStdDev) final
virtual WSF_DEPRECATED void SetRangeErrorStdDev (double aRangeErrorStdDev) final
virtual WSF_DEPRECATED void SetRangeRateErrorStdDev (double aRangeRateErrorStdDev) final
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)

Public Attributes

bool mCanTransmit
bool mCanReceive
bool mImplicitBeamUsed
bool mExplicitBeamUsed
std::vector< RadarBeam * > mBeamList

Protected Member Functions

void SelectAlternateFrequency (double aSimTime, int aAltFreqId=-1) override
bool InitializeReporting ()
void SetCapabilities (unsigned int aFlags)
void SetReportingFlags (unsigned int aFlags)

Protected Attributes

double mAltFreqSelectDelay
bool mAltFreqChangeScheduled
double mLastAltFreqSelectTime
bool mIsFrequencyAgile
WsfSensor * mSensorPtr
 Pointer to the sensor with which the mode is associated.
WsfPlatform * mPlatformPtr
 Pointer to the platform with which the sensor is associated.
double mMaximumRange
double mAzCueRate
double mElCueRate
double mMinAzCue
double mMaxAzCue
double mMinElCue
double mMaxElCue
WsfSensor::SlewMode mCueMode
int mMaximumRequestCount
bool mCanSearchWhileTrack
bool mDisablesSearch
double mFrameTime
double mRevisitTime
double mDwellTime
double mRequiredPd
double mEstablishTrackProbability
 When the M/N establish track criteria is met, this is the probability that a track will be established.
double mMaintainTrackProbability
int mHitsToEstablishTrack
 The number of hits (M) within the window (N) that are required to establish a track.
int mEstablishTrackWindow
 The window size (N) for establishing a track.
unsigned int mEstablishTrackMask
int mHitsToMaintainTrack
 The number of hits (M) within the window (N) that are required to maintain a track.
int mMaintainTrackWindow
 The window size (N) for maintaining a track.
unsigned int mMaintainTrackMask
double mTrackQuality
 Base line track quality (0..1].
double mAzErrorStdDev
double mElErrorStdDev
double mRangeErrorStdDev
double mRangeRateErrorStdDev
 Range rate error standard deviation.
ut::CloneablePtr< wsf::SensorErrorModelBase > mErrorModelPtr {nullptr}
 The model that calculates and applies errors to sensor detection results.
WsfStringId mOnSuccessModeName
size_t mOnSuccessModeIndex
WsfStringId mOnFailureModeName
size_t mOnFailureModeIndex
int mMessageLength
 The length of messages originating from this sensor mode.
int mMessagePriority
 The priority of messages originating from this sensor mode.
WsfSpatialDomain mReportsSpatialDomain
ReportingFlags mReportingFlags
ReportingFlags mCapabilitiesFlags

Additional Inherited Members

static const unsigned int cNONE = 0
 The following are flags/masks meant to be combined and used in the SetCapabilities method.
static const unsigned int cLOCATION = 1
static const unsigned int cVELOCITY = 2
static const unsigned int cRANGE = 4
static const unsigned int cBEARING = 8
static const unsigned int cELEVATION = 16
static const unsigned int cRANGE_RATE = 32
static const unsigned int cSIDE = 64
static const unsigned int cTYPE = 128
static const unsigned int cIFF_STATUS = 256
static const unsigned int cSIGNAL_TO_NOISE = 512
static const unsigned int cFREQUENCY = 1024
static const unsigned int cPULSEWIDTH = 2048
static const unsigned int cPULSE_REPITITION_INTERVAL = 4096
static const unsigned int cSTATE_COVARIANCE = 8192
static const unsigned int cOTHER = 16384
static const unsigned int cALL = 0xFFFFFFFF
 Catch-all for anything other than the above.

Detailed Description

A 'mode' of the sensor.

Constructor & Destructor Documentation

◆ RadarMode() [1/2]

WsfRadarSensor::RadarMode::RadarMode ( )

References mAltFreqChangeScheduled, mAltFreqSelectDelay, mBeamList, mCanReceive, mCanTransmit, mExplicitBeamUsed, mImplicitBeamUsed, mIsFrequencyAgile, mLastAltFreqSelectTime, WsfRadarSensor::RadarBeam, WsfSensorMode::SetErrorModel(), and WsfSensorMode::WsfSensorMode().

Referenced by operator=(), and RadarMode().

◆ RadarMode() [2/2]

WsfRadarSensor::RadarMode::RadarMode ( const RadarMode & aSrc)

References mAltFreqChangeScheduled, mAltFreqSelectDelay, mBeamList, mCanReceive, mCanTransmit, mExplicitBeamUsed, mImplicitBeamUsed, mIsFrequencyAgile, mLastAltFreqSelectTime, WsfRadarSensor::RadarBeam, RadarMode(), and WsfSensorMode::WsfSensorMode().

◆ ~RadarMode()

WsfRadarSensor::RadarMode::~RadarMode ( )
override

References mBeamList.

Member Function Documentation

◆ AttemptToDetect()

bool WsfRadarSensor::RadarMode::AttemptToDetect ( double aSimTime,
WsfPlatform * aTargetPtr,
Settings & aSettings,
WsfSensorResult & aResult )
overridevirtual

Attempt to detect the specified target.

Parameters
aSimTime[input] The current simulation time.
aTargetPtr[input] The platform that will be attempted to be detected.
aSettings[input] The sensor settings.
aResult[output] The results of the detection attempt.
Returns
'true' if the target was detected or 'false' if it was not detected.

Implements WsfSensorMode.

References WsfSensorResult::BeginGenericInteraction(), WsfSensorResult::cCONCEALMENT, WsfEM_Interaction::cRCVR_TERRAIN_MASKING, WsfEM_Interaction::cXMTR_TERRAIN_MASKING, WsfPlatformPart::DebugEnabled(), WsfPlatform::GetConcealmentFactor(), WsfRadarSensor::GetEM_Rcvr(), WsfRadarSensor::GetEM_Xmtr(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfSensorMode::GetSensor(), WsfEM_Interaction::GetTransmitter(), WsfSensor::GetZoneAttenuationModifier(), WsfEM_Interaction::MaskedByTerrain(), WsfSensorResult::mBeamIndex, mBeamList, WsfEM_Interaction::mBistatic, mCanReceive, mCanTransmit, WsfEM_Interaction::mCheckedStatus, WsfEM_Interaction::mFailedStatus, WsfEM_Interaction::mSignalToNoise, WsfEM_Xmtr::NotifyListeners(), WsfSensorComponent::PostAttemptToDetect(), WsfEM_Interaction::Print(), WsfSensorResult::Reset(), WsfEM_Interaction::SetCategory(), and WsfPlatform::Update().

◆ Clone()

WsfMode * WsfRadarSensor::RadarMode::Clone ( ) const
overridevirtual

Create an exact duplicate of this mode.

Implements WsfSensorMode.

References WsfRadarSensor::RadarMode, and WsfMode::WsfMode().

◆ Deselect()

void WsfRadarSensor::RadarMode::Deselect ( double aSimTime)
overridevirtual

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

Parameters
aSimTime[input] The current simulation time.

Implements WsfSensorMode.

References WsfSensorMode::GetSensor(), mBeamList, mCanReceive, mCanTransmit, WsfRadarSensor::UpdateXmtrRcvrLists(), and WsfRadarSensor::WsfRadarSensor().

◆ GetAltFreqSelectDelay()

double WsfRadarSensor::RadarMode::GetAltFreqSelectDelay ( ) const
inlineoverridevirtual

Reimplemented from WsfSensorMode.

References mAltFreqSelectDelay.

◆ GetBeamCount()

size_t WsfRadarSensor::RadarMode::GetBeamCount ( ) const
inlineoverridevirtual

Return the number of beams in the mode. Derived classes should return the number of beams that are defined.

Returns
The number of beams defined. The result will be 0 if the derived class does not support beams.

Reimplemented from WsfSensorMode.

References mBeamList.

◆ GetBeamEntry()

WsfSensorBeam * WsfRadarSensor::RadarMode::GetBeamEntry ( size_t aIndex)
inlineoverridevirtual

Return a pointer to the beam with the specified index. A derived class will return a pointer

Parameters
aIndexThe index of the beam to be retrieved. The index is NOT checked for validity. It MUST be in the range [0..GetBeamCount()].
Returns
A pointer to the beam. The results are undefined if an invalid index is provided or if the derived class does not support beams.

Reimplemented from WsfSensorMode.

References mBeamList.

◆ GetLastAltFreqSelectTime()

double WsfRadarSensor::RadarMode::GetLastAltFreqSelectTime ( ) const
inlineoverridevirtual

Reimplemented from WsfSensorMode.

References mLastAltFreqSelectTime.

◆ Initialize()

bool WsfRadarSensor::RadarMode::Initialize ( double aSimTime)
overridevirtual

Initialize the sensor mode.

Parameters
aSimTimeThe current simulation time.
Returns
'true' if the mode was successfully initialize or 'false' if not.

Reimplemented from WsfSensorMode.

References WsfRadarSensor::RadarBeam::Initialize(), WsfSensorMode::Initialize(), WsfRadarSensor::RadarBeam::mAntennaPtr, mBeamList, mCanReceive, mCanTransmit, WsfSensorMode::mFrameTime, mIsFrequencyAgile, WsfSensorMode::mMaximumRange, WsfSensorMode::mReportingFlags, WsfSensorMode::mSensorPtr, WsfRadarSensor::RadarBeam::mXmtrPtr, ok, WsfSimulation::RandomizeFrequency(), and SelectAlternateFrequency().

◆ IsAltFreqChangeScheduled()

bool WsfRadarSensor::RadarMode::IsAltFreqChangeScheduled ( ) const
inlineoverridevirtual

Reimplemented from WsfSensorMode.

References mAltFreqChangeScheduled.

◆ IsFrequencyAgile()

bool WsfRadarSensor::RadarMode::IsFrequencyAgile ( ) const
inlineoverridevirtual

Reimplemented from WsfSensorMode.

References mIsFrequencyAgile.

Referenced by WsfEW_SimpleFT_Effect::UpdateEffects().

◆ operator=()

WsfRadarSensor::RadarMode & WsfRadarSensor::RadarMode::operator= ( const RadarMode & aRhs)

References mAltFreqChangeScheduled, mAltFreqSelectDelay, mBeamList, mCanReceive, mCanTransmit, mExplicitBeamUsed, mImplicitBeamUsed, mIsFrequencyAgile, mLastAltFreqSelectTime, WsfSensorMode::operator=(), WsfRadarSensor::RadarBeam, and RadarMode().

◆ ProcessInput()

bool WsfRadarSensor::RadarMode::ProcessInput ( UtInput & aInput)
overridevirtual

Reimplemented from WsfMode.

References mAltFreqSelectDelay, mBeamList, mCanReceive, mCanTransmit, mExplicitBeamUsed, mImplicitBeamUsed, WsfRadarSensor::ProcessInput(), WsfSensorMode::ProcessInput(), and WsfRadarSensor::RadarBeam.

◆ ScheduleAltFreqChange()

void WsfRadarSensor::RadarMode::ScheduleAltFreqChange ( double aSimTime,
int aAltFreqId = -1 )
overridevirtual

Reimplemented from WsfSensorMode.

References WsfSimulation::AddEvent(), WsfPlatformPart::GetSimulation(), mAltFreqChangeScheduled, mAltFreqSelectDelay, and mLastAltFreqSelectTime.

◆ Select()

void WsfRadarSensor::RadarMode::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 WsfSensorMode.

References WsfPlatformPart::GetPlatform(), WsfSensorMode::GetSensor(), mBeamList, mCanReceive, mCanTransmit, WsfRadarSensor::UpdateXmtrRcvrLists(), and WsfRadarSensor::WsfRadarSensor().

◆ SelectAlternateFrequency()

void WsfRadarSensor::RadarMode::SelectAlternateFrequency ( double aSimTime,
int aAltFreqId = -1 )
overrideprotectedvirtual

Changes to the next alternate frequency set for the current mode for all beams.

Parameters
aSimTimeThe current simulation time.
aAltFreqIdThe ID of the frequency set to change to.

Reimplemented from WsfSensorMode.

References WsfPlatformPart::GetPlatform(), WsfSensorMode::GetSensor(), WsfPlatformPart::GetSimulation(), mAltFreqChangeScheduled, mBeamList, mLastAltFreqSelectTime, and WsfObserver::SensorFrequencyChanged().

Referenced by Initialize().

Member Data Documentation

◆ mAltFreqChangeScheduled

bool WsfRadarSensor::RadarMode::mAltFreqChangeScheduled
protected

Referenced by IsAltFreqChangeScheduled(), operator=(), RadarMode(), RadarMode(), ScheduleAltFreqChange(), and SelectAlternateFrequency().

◆ mAltFreqSelectDelay

double WsfRadarSensor::RadarMode::mAltFreqSelectDelay
protected

Referenced by GetAltFreqSelectDelay(), operator=(), ProcessInput(), RadarMode(), RadarMode(), and ScheduleAltFreqChange().

◆ mBeamList

std::vector<RadarBeam*> WsfRadarSensor::RadarMode::mBeamList

Referenced by AttemptToDetect(), WsfRF_Jammer::ComputeReceiverGains(), Deselect(), GetBeamCount(), GetBeamEntry(), WsfRadarSensor::GetEM_Rcvr(), WsfRadarSensor::GetEM_Rcvr(), WsfRadarSensor::GetEM_RcvrCount(), WsfRadarSensor::GetEM_RcvrCount(), WsfRadarSensor::GetEM_Xmtr(), WsfRadarSensor::GetEM_Xmtr(), WsfRadarSensor::GetEM_XmtrCount(), WsfRadarMTI_AdjSignalProcessor::Initialize(), Initialize(), WsfRadarSTC_SignalProcessor::Initialize(), operator=(), ProcessInput(), RadarMode(), RadarMode(), Select(), SelectAlternateFrequency(), WsfEW_RPJ_Effect::UpdateEffects(), WsfEW_SimpleFT_Effect::UpdateEffects(), WsfEW_FalseTargetEffect::UpdateFT(), WsfEW_FalseTargetEffect::UpdateJammerPulseDensity(), WsfEW_SimpleFT_Effect::UpdateJammerPulseDensity(), and ~RadarMode().

◆ mCanReceive

bool WsfRadarSensor::RadarMode::mCanReceive

Referenced by AttemptToDetect(), Deselect(), Initialize(), operator=(), ProcessInput(), RadarMode(), RadarMode(), and Select().

◆ mCanTransmit

bool WsfRadarSensor::RadarMode::mCanTransmit

Referenced by AttemptToDetect(), Deselect(), Initialize(), operator=(), ProcessInput(), RadarMode(), RadarMode(), and Select().

◆ mExplicitBeamUsed

bool WsfRadarSensor::RadarMode::mExplicitBeamUsed

Referenced by operator=(), ProcessInput(), RadarMode(), and RadarMode().

◆ mImplicitBeamUsed

bool WsfRadarSensor::RadarMode::mImplicitBeamUsed

Referenced by operator=(), ProcessInput(), RadarMode(), and RadarMode().

◆ mIsFrequencyAgile

bool WsfRadarSensor::RadarMode::mIsFrequencyAgile
protected

Referenced by Initialize(), IsFrequencyAgile(), operator=(), RadarMode(), and RadarMode().

◆ mLastAltFreqSelectTime

double WsfRadarSensor::RadarMode::mLastAltFreqSelectTime
protected

Referenced by GetLastAltFreqSelectTime(), operator=(), RadarMode(), RadarMode(), ScheduleAltFreqChange(), and SelectAlternateFrequency().

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