A mode of the sensor. More...

#include <WsfGeometricSensor.hpp>

Inheritance diagram for WsfGeometricSensor::GeometricMode:

[legend]

Collaboration diagram for WsfGeometricSensor::GeometricMode:

[legend]

Classes
struct	PD_RangeTable
	A Probability vs Range table. More...
struct	TypeDetectionCriteria
	Detection range and PD range table for a target type. More...

Public Types
using	PD_RangeTablePtr = std::shared_ptr<PD_RangeTable>
typedef std::map< WsfStringId, TypeDetectionCriteria >	TypeCriteriaMap

Public Member Functions
	GeometricMode ()
	GeometricMode (const GeometricMode &aSrc)
GeometricMode &	operator= (const GeometricMode &aRhs)
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	Deselect (double aSimTime) override
void	Select (double aSimTime) override
double	GetRangeRate (WsfPlatform *aTargetPtr)
TypeDetectionCriteria &	GetDetectionCriteria (WsfPlatform *aTargetPtr)
	Returns the TypeDetectionCriteria struct for a target based on its platform type.
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 size_t	GetBeamCount () const
virtual WsfSensorBeam *	GetBeamEntry (size_t aIndex)
virtual double	GetAltFreqSelectDelay () const
virtual void	ScheduleAltFreqChange (double aSimTime, int aAltFreqId=-1)
virtual bool	IsAltFreqChangeScheduled () const
virtual double	GetLastAltFreqSelectTime () const
virtual bool	IsFrequencyAgile () 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
WsfEM_Antenna	mAntenna
WsfEM_Rcvr	mRcvr
double	mMinRangeRate
double	mMaxRangeRate
TypeCriteriaMap	mTypeCriteria
	A map of type vs detection criteria.

Additional Inherited Members
bool	InitializeReporting ()
virtual void	SelectAlternateFrequency (double aSimTime, int aAltFreqId=-1)
void	SetCapabilities (unsigned int aFlags)
void	SetReportingFlags (unsigned int aFlags)
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
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.

Member Typedef Documentation

◆ PD_RangeTablePtr

using WsfGeometricSensor::GeometricMode::PD_RangeTablePtr = std::shared_ptr<PD_RangeTable>

◆ TypeCriteriaMap

typedef std::map<WsfStringId, TypeDetectionCriteria> WsfGeometricSensor::GeometricMode::TypeCriteriaMap

Constructor & Destructor Documentation

◆ GeometricMode() [1/2]

WsfGeometricSensor::GeometricMode::GeometricMode ( )

References WsfSensorMode::cALL, WsfSensorMode::cFREQUENCY, WsfSensorMode::cPULSE_REPITITION_INTERVAL, WsfSensorMode::cPULSEWIDTH, WsfSensorMode::cSIGNAL_TO_NOISE, mAntenna, mMaxRangeRate, mMinRangeRate, mRcvr, WsfSensorMode::SetCapabilities(), and WsfSensorMode::WsfSensorMode().

Referenced by Clone(), GeometricMode(), and operator=().

◆ GeometricMode() [2/2]

WsfGeometricSensor::GeometricMode::GeometricMode ( const GeometricMode & aSrc )

References GeometricMode(), mAntenna, mMaxRangeRate, mMinRangeRate, mRcvr, mTypeCriteria, and WsfSensorMode::WsfSensorMode().

Member Function Documentation

◆ AttemptToDetect()

bool WsfGeometricSensor::GeometricMode::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.

◆ Clone()

WsfMode * WsfGeometricSensor::GeometricMode::Clone ( ) const

overridevirtual

Create an exact duplicate of this mode.

Implements WsfSensorMode.

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

◆ Deselect()

void WsfGeometricSensor::GeometricMode::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 mRcvr.

◆ GetDetectionCriteria()

WsfGeometricSensor::GeometricMode::TypeDetectionCriteria & WsfGeometricSensor::GeometricMode::GetDetectionCriteria ( WsfPlatform * aTargetPtr )

Returns the TypeDetectionCriteria struct for a target based on its platform type.

References WsfObject::GetTypeList(), and mTypeCriteria.

Referenced by AttemptToDetect().

◆ GetRangeRate()

double WsfGeometricSensor::GeometricMode::GetRangeRate ( WsfPlatform * aTargetPtr )

Get the range rate of the target relative to the sensor. This computes the relative speed of the target along the range vector from the sensor to the target.

Parameters

aTargetPtr [input] Pointer to target platform.

Returns: The range rate of the target relative to the sensor. The value is negative if the target is closing and positive when receding.

References mRcvr.

Referenced by AttemptToDetect().

◆ Initialize()

bool WsfGeometricSensor::GeometricMode::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 cLARGE_VALUE, WsfSensorMode::Initialize(), mAntenna, WsfGeometricSensor::GeometricMode::TypeDetectionCriteria::mMaximumRange, WsfSensorMode::mMaximumRange, mRcvr, WsfSensorMode::mSensorPtr, mTypeCriteria, and ok.

◆ operator=()

WsfGeometricSensor::GeometricMode & WsfGeometricSensor::GeometricMode::operator= ( const GeometricMode & aRhs )

References GeometricMode(), mAntenna, mMaxRangeRate, mMinRangeRate, mRcvr, mTypeCriteria, and WsfSensorMode::operator=().

◆ ProcessInput()

bool WsfGeometricSensor::GeometricMode::ProcessInput ( UtInput & aInput )

overridevirtual

Reimplemented from WsfMode.

References mAntenna, mMaxRangeRate, mMinRangeRate, mRcvr, mTypeCriteria, and WsfSensorMode::ProcessInput().

◆ Select()

void WsfGeometricSensor::GeometricMode::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 mRcvr.

Member Data Documentation

◆ mAntenna

WsfEM_Antenna WsfGeometricSensor::GeometricMode::mAntenna

Referenced by AttemptToDetect(), GeometricMode(), GeometricMode(), Initialize(), operator=(), and ProcessInput().

◆ mMaxRangeRate

double WsfGeometricSensor::GeometricMode::mMaxRangeRate

Referenced by AttemptToDetect(), GeometricMode(), GeometricMode(), operator=(), and ProcessInput().

◆ mMinRangeRate

double WsfGeometricSensor::GeometricMode::mMinRangeRate

Referenced by AttemptToDetect(), GeometricMode(), GeometricMode(), operator=(), and ProcessInput().

◆ mRcvr

WsfEM_Rcvr WsfGeometricSensor::GeometricMode::mRcvr

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

◆ mTypeCriteria

TypeCriteriaMap WsfGeometricSensor::GeometricMode::mTypeCriteria

A map of type vs detection criteria.

Referenced by GeometricMode(), GetDetectionCriteria(), Initialize(), operator=(), and ProcessInput().

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

Classes

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PD_RangeTablePtr

◆ TypeCriteriaMap

Constructor & Destructor Documentation

◆ GeometricMode() [1/2]

◆ GeometricMode() [2/2]

Member Function Documentation

◆ AttemptToDetect()

◆ Clone()

◆ Deselect()

◆ GetDetectionCriteria()

◆ GetRangeRate()

◆ Initialize()

◆ operator=()

◆ ProcessInput()

◆ Select()

Member Data Documentation

◆ mAntenna

◆ mMaxRangeRate

◆ mMinRangeRate

◆ mRcvr

◆ mTypeCriteria