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

#include <WsfOTH_RadarSensor.hpp>

Inheritance diagram for WsfOTH_RadarSensor::OTH_Mode:

[legend]

Collaboration diagram for WsfOTH_RadarSensor::OTH_Mode:

[legend]

Public Member Functions
	OTH_Mode ()
	OTH_Mode (const OTH_Mode &aSrc)
OTH_Mode &	operator= (const OTH_Mode &)=delete
	~OTH_Mode () override
size_t	GetBeamCount () const override
WsfSensorBeam *	GetBeamEntry (size_t aBeamIndex) 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
void	UpdateTrack (double aSimTime, WsfTrack aTrackPtr, WsfPlatform aTargetPtr, 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	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	mOverrideMeasurementWithTruth
bool	mCanTransmit
bool	mCanReceive
bool	mImplicitBeamUsed
bool	mExplicitBeamUsed
std::vector< OTH_Beam * >	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

◆ OTH_Mode() [1/2]

WsfOTH_RadarSensor::OTH_Mode::OTH_Mode ( )

◆ OTH_Mode() [2/2]

WsfOTH_RadarSensor::OTH_Mode::OTH_Mode ( const OTH_Mode & aSrc )

References mAltFreqChangeScheduled, mAltFreqSelectDelay, mBeamList, mCanReceive, mCanTransmit, mExplicitBeamUsed, mImplicitBeamUsed, mIsFrequencyAgile, mLastAltFreqSelectTime, mOverrideMeasurementWithTruth, WsfOTH_RadarSensor::OTH_Beam, OTH_Mode(), and WsfSensorMode::WsfSensorMode().

◆ ~OTH_Mode()

WsfOTH_RadarSensor::OTH_Mode::~OTH_Mode ( )

override

References mBeamList.

Member Function Documentation

◆ AttemptToDetect()

bool WsfOTH_RadarSensor::OTH_Mode::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, WsfPlatformPart::DebugEnabled(), WsfPlatform::GetConcealmentFactor(), WsfOTH_RadarSensor::GetEM_Rcvr(), WsfOTH_RadarSensor::GetEM_Xmtr(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfSensorMode::GetSensor(), WsfEM_Interaction::GetTransmitter(), WsfSensor::GetZoneAttenuationModifier(), WsfSensorResult::mBeamIndex, mBeamList, 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 * WsfOTH_RadarSensor::OTH_Mode::Clone ( ) const

overridevirtual

Create an exact duplicate of this mode.

Implements WsfSensorMode.

References WsfOTH_RadarSensor::OTH_Mode, and WsfMode::WsfMode().

◆ Deselect()

void WsfOTH_RadarSensor::OTH_Mode::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, WsfOTH_RadarSensor::UpdateXmtrRcvrLists(), and WsfOTH_RadarSensor::WsfOTH_RadarSensor().

◆ GetAltFreqSelectDelay()

double WsfOTH_RadarSensor::OTH_Mode::GetAltFreqSelectDelay ( ) const

inlineoverridevirtual

Reimplemented from WsfSensorMode.

References mAltFreqSelectDelay.

◆ GetBeamCount()

size_t WsfOTH_RadarSensor::OTH_Mode::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 * WsfOTH_RadarSensor::OTH_Mode::GetBeamEntry ( size_t aIndex )

inlineoverridevirtual

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

Parameters

aIndex The 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 WsfOTH_RadarSensor::OTH_Mode::GetLastAltFreqSelectTime ( ) const

inlineoverridevirtual

Reimplemented from WsfSensorMode.

References mLastAltFreqSelectTime.

◆ Initialize()

bool WsfOTH_RadarSensor::OTH_Mode::Initialize ( double aSimTime )

overridevirtual

Initialize the sensor mode.

Parameters

aSimTime The current simulation time.

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

Reimplemented from WsfSensorMode.

References WsfEW_EP::GetElectronicProtect(), WsfEW_EA_EP::HasFrequencyAgilityEffect(), WsfOTH_RadarSensor::OTH_Beam::Initialize(), WsfSensorMode::Initialize(), WsfOTH_RadarSensor::OTH_Beam::mAntennaPtr, mBeamList, mCanReceive, mCanTransmit, mIsFrequencyAgile, WsfSensorMode::mMaximumRange, WsfSensorMode::mReportingFlags, WsfSensorMode::mSensorPtr, WsfOTH_RadarSensor::OTH_Beam::mXmtrPtr, ok, WsfSimulation::RandomizeFrequency(), and SelectAlternateFrequency().

◆ IsAltFreqChangeScheduled()

bool WsfOTH_RadarSensor::OTH_Mode::IsAltFreqChangeScheduled ( ) const

inlineoverridevirtual

Reimplemented from WsfSensorMode.

References mAltFreqChangeScheduled.

◆ IsFrequencyAgile()

bool WsfOTH_RadarSensor::OTH_Mode::IsFrequencyAgile ( ) const

inlineoverridevirtual

Reimplemented from WsfSensorMode.

References mIsFrequencyAgile.

◆ operator=()

OTH_Mode & WsfOTH_RadarSensor::OTH_Mode::operator= ( const OTH_Mode & )

delete

References OTH_Mode().

◆ ProcessInput()

bool WsfOTH_RadarSensor::OTH_Mode::ProcessInput ( UtInput & aInput )

overridevirtual

Reimplemented from WsfMode.

References mAltFreqSelectDelay, mBeamList, mCanReceive, mCanTransmit, mExplicitBeamUsed, mImplicitBeamUsed, mOverrideMeasurementWithTruth, WsfOTH_RadarSensor::OTH_Beam, WsfOTH_RadarSensor::ProcessInput(), and WsfSensorMode::ProcessInput().

◆ ScheduleAltFreqChange()

void WsfOTH_RadarSensor::OTH_Mode::ScheduleAltFreqChange	(	double	aSimTime,
		int	aAltFreqId = -1 )

overridevirtual

Reimplemented from WsfSensorMode.

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

◆ Select()

void WsfOTH_RadarSensor::OTH_Mode::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, WsfOTH_RadarSensor::UpdateXmtrRcvrLists(), and WsfOTH_RadarSensor::WsfOTH_RadarSensor().

◆ SelectAlternateFrequency()

void WsfOTH_RadarSensor::OTH_Mode::SelectAlternateFrequency	(	double	aSimTime,
		int	aAltFreqId = -1 )

overrideprotectedvirtual

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

Parameters

aSimTime	The current simulation time.
aAltFreqId	The 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().

◆ UpdateTrack()

void WsfOTH_RadarSensor::OTH_Mode::UpdateTrack	(	double	aSimTime,
		WsfTrack *	aTrackPtr,
		WsfPlatform *	aTargetPtr,
		WsfSensorResult &	aResult )

overridevirtual

Update a track with the results from the current detection.

Parameters

aSimTime	The current simulation time.
aTrackPtr	A pointer to the track to be updated.
aTargetPtr	Pointer to the target.
aResult	The results of the current detection attempt

Reimplemented from WsfSensorMode.

References WsfAuxDataEnabled::GetAuxData(), WsfOTH_RadarSensor::OTH_Beam::GetReflectionLocationWCS(), WsfSensorResult::mBeamIndex, mBeamList, and WsfSensorMode::UpdateTrack().

Member Data Documentation

◆ mAltFreqChangeScheduled

bool WsfOTH_RadarSensor::OTH_Mode::mAltFreqChangeScheduled

protected

Referenced by IsAltFreqChangeScheduled(), OTH_Mode(), OTH_Mode(), ScheduleAltFreqChange(), and SelectAlternateFrequency().

◆ mAltFreqSelectDelay

double WsfOTH_RadarSensor::OTH_Mode::mAltFreqSelectDelay

protected

Referenced by GetAltFreqSelectDelay(), OTH_Mode(), OTH_Mode(), ProcessInput(), and ScheduleAltFreqChange().

◆ mBeamList

std::vector<OTH_Beam*> WsfOTH_RadarSensor::OTH_Mode::mBeamList

Referenced by AttemptToDetect(), Deselect(), GetBeamCount(), GetBeamEntry(), WsfOTH_RadarSensor::GetEM_Rcvr(), WsfOTH_RadarSensor::GetEM_Rcvr(), WsfOTH_RadarSensor::GetEM_RcvrCount(), WsfOTH_RadarSensor::GetEM_RcvrCount(), WsfOTH_RadarSensor::GetEM_Xmtr(), WsfOTH_RadarSensor::GetEM_Xmtr(), WsfOTH_RadarSensor::GetEM_XmtrCount(), Initialize(), OTH_Mode(), OTH_Mode(), ProcessInput(), Select(), SelectAlternateFrequency(), UpdateTrack(), and ~OTH_Mode().

◆ mCanReceive

bool WsfOTH_RadarSensor::OTH_Mode::mCanReceive

Referenced by Deselect(), Initialize(), OTH_Mode(), OTH_Mode(), ProcessInput(), and Select().

◆ mCanTransmit

bool WsfOTH_RadarSensor::OTH_Mode::mCanTransmit

Referenced by Deselect(), Initialize(), OTH_Mode(), OTH_Mode(), ProcessInput(), and Select().

◆ mExplicitBeamUsed

bool WsfOTH_RadarSensor::OTH_Mode::mExplicitBeamUsed

Referenced by OTH_Mode(), OTH_Mode(), and ProcessInput().

◆ mImplicitBeamUsed

bool WsfOTH_RadarSensor::OTH_Mode::mImplicitBeamUsed

Referenced by OTH_Mode(), OTH_Mode(), and ProcessInput().

◆ mIsFrequencyAgile

bool WsfOTH_RadarSensor::OTH_Mode::mIsFrequencyAgile

protected

Referenced by Initialize(), IsFrequencyAgile(), OTH_Mode(), and OTH_Mode().

◆ mLastAltFreqSelectTime

double WsfOTH_RadarSensor::OTH_Mode::mLastAltFreqSelectTime

protected

Referenced by GetLastAltFreqSelectTime(), OTH_Mode(), OTH_Mode(), ScheduleAltFreqChange(), and SelectAlternateFrequency().

◆ mOverrideMeasurementWithTruth

bool WsfOTH_RadarSensor::OTH_Mode::mOverrideMeasurementWithTruth

Referenced by OTH_Mode(), OTH_Mode(), and ProcessInput().

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OTH_Mode() [1/2]

◆ OTH_Mode() [2/2]

◆ ~OTH_Mode()

Member Function Documentation

◆ AttemptToDetect()

◆ Clone()

◆ Deselect()

◆ GetAltFreqSelectDelay()

◆ GetBeamCount()

◆ GetBeamEntry()

◆ GetLastAltFreqSelectTime()

◆ Initialize()

◆ IsAltFreqChangeScheduled()

◆ IsFrequencyAgile()

◆ operator=()

◆ ProcessInput()

◆ ScheduleAltFreqChange()

◆ Select()

◆ SelectAlternateFrequency()

◆ UpdateTrack()

Member Data Documentation

◆ mAltFreqChangeScheduled

◆ mAltFreqSelectDelay

◆ mBeamList

◆ mCanReceive

◆ mCanTransmit

◆ mExplicitBeamUsed

◆ mImplicitBeamUsed

◆ mIsFrequencyAgile

◆ mLastAltFreqSelectTime

◆ mOverrideMeasurementWithTruth