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

#include <WsfSurfaceWaveRadarSensor.hpp>

Inheritance diagram for WsfSurfaceWaveRadarSensor::RadarMode:

[legend]

Collaboration diagram for WsfSurfaceWaveRadarSensor::RadarMode:

[legend]

Public Member Functions
	RadarMode ()
	RadarMode (const RadarMode &aSrc)
RadarMode &	operator= (const RadarMode &)=delete
size_t	GetBeamCount () const override
WsfSensorBeam *	GetBeamEntry (size_t) override
WsfEM_Rcvr *	GetEM_Rcvr () override
WsfEM_Xmtr *	GetEM_Xmtr () 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	Deselect (double aSimTime) override
void	Select (double aSimTime) override
void	Calibrate ()
void	SetIntegrationGain (double aIntegrationGain) override
double	GetIntegrationGain () const override
double	GetDopplerResolution () const
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 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 Member Functions inherited from WsfSensorBeam
	WsfSensorBeam ()
	WsfSensorBeam (const WsfSensorBeam &aSrc)=default
WsfSensorBeam &	operator= (const WsfSensorBeam &aRhs)
virtual	~WsfSensorBeam ()=default
virtual int	GetNumberOfPulsesIntegrated () const
virtual WsfEM_Clutter *	GetClutter () const
void	SetBeamOwner (WsfSensorMode *aSensorModePtr)
	Set the beam owner (the parent mode).
void	SetBeamIndex (size_t aBeamIndex)
WsfSensorMode *	GetSensorMode () const
size_t	GetBeamIndex () const
WsfSensorSignalProcessor::List &	GetSignalProcessors ()

Protected Member Functions
void	AttemptToDetect (double aSimTime, WsfPlatform aTargetPtr, WsfEM_Xmtr aXmtrPtr, WsfSensorResult &aResult)
bool	InitializeReporting ()
virtual void	SelectAlternateFrequency (double aSimTime, int aAltFreqId=-1)
void	SetCapabilities (unsigned int aFlags)
void	SetReportingFlags (unsigned int aFlags)

Protected Attributes
double	mDopplerResolution
	Doppler resolution as velocity (m/s).
double	mAdjustmentFactor
	A term to represent a general adjustment (multiplier) to the radar range equation.
double	mIntegrationGain
	Integration gain for non-Swerling detector.
wsf::MarcumSwerling	mDetector
bool	mUseDetector
	If 'true' then used the detector.
WsfEM_Antenna	mAntenna
WsfEM_Xmtr	mXmtr
	The transmitter for a radar beam.
WsfEM_Rcvr	mRcvr
	The receiver for a radar beam.
WsfEM_Noise	mNoise
	the EM_noise for a radar beam
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]

WsfSurfaceWaveRadarSensor::RadarMode::RadarMode ( )

References mAdjustmentFactor, mAntenna, mDetector, mDopplerResolution, mIntegrationGain, mNoise, mRcvr, mUseDetector, mXmtr, WsfSensorBeam::WsfSensorBeam(), and WsfSensorBeam::WsfSensorMode.

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

◆ RadarMode() [2/2]

WsfSurfaceWaveRadarSensor::RadarMode::RadarMode ( const RadarMode & aSrc )

References mAdjustmentFactor, mAntenna, mDetector, mDopplerResolution, mIntegrationGain, mNoise, mRcvr, mUseDetector, mXmtr, RadarMode(), WsfSensorBeam::WsfSensorBeam(), and WsfSensorBeam::WsfSensorMode.

Member Function Documentation

◆ AttemptToDetect() [1/2]

bool WsfSurfaceWaveRadarSensor::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 WsfSensor::AttemptToDetect(), WsfSensorResult::BeginGenericInteraction(), WsfSensorResult::cCONCEALMENT, WsfEM_Interaction::cSIGNAL_LEVEL, WsfPlatformPart::DebugEnabled(), WsfPlatform::GetConcealmentFactor(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfSensorMode::GetSensor(), WsfEM_Interaction::mCheckedStatus, WsfEM_Interaction::mFailedStatus, WsfSensorResult::mPd, mRcvr, WsfSensor::Settings::mRequiredPd, mXmtr, WsfSensorComponent::PostAttemptToDetect(), WsfEM_Interaction::Print(), WsfSensorResult::Reset(), and WsfPlatform::Update().

◆ AttemptToDetect() [2/2]

void WsfSurfaceWaveRadarSensor::RadarMode::AttemptToDetect	(	double	aSimTime,
		WsfPlatform *	aTargetPtr,
		WsfEM_Xmtr *	aXmtrPtr,
		WsfSensorResult &	aResult )

protected

◆ Calibrate()

void WsfSurfaceWaveRadarSensor::RadarMode::Calibrate ( )

References WsfEM_Xmtr::GetAveragePower(), WsfEM_Rcvr::GetDetectionThreshold(), WsfEM_XmtrRcvr::GetFrequency(), WsfEM_XmtrRcvr::GetInternalLoss(), WsfEM_Rcvr::GetNoisePower(), WsfEM_XmtrRcvr::GetPeakAntennaGain(), WsfEM_Xmtr::GetPeakPower(), WsfEM_Xmtr::GetPower(), WsfEM_Xmtr::GetPulseCompressionRatio(), WsfEM_Xmtr::GetPulseRepetitionFrequency(), WsfEM_Xmtr::GetPulseWidth(), mAdjustmentFactor, mDetector, mIntegrationGain, mRcvr, WsfSensorMode::mSensorPtr, mUseDetector, and mXmtr.

Referenced by Initialize().

◆ Clone()

WsfMode * WsfSurfaceWaveRadarSensor::RadarMode::Clone ( ) const

overridevirtual

Create an exact duplicate of this mode.

Implements WsfSensorMode.

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

◆ Deselect()

void WsfSurfaceWaveRadarSensor::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 mRcvr, and mXmtr.

◆ GetBeamCount()

size_t WsfSurfaceWaveRadarSensor::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.

◆ GetBeamEntry()

WsfSensorBeam * WsfSurfaceWaveRadarSensor::RadarMode::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 WsfSensorBeam::WsfSensorBeam().

◆ GetDopplerResolution()

double WsfSurfaceWaveRadarSensor::RadarMode::GetDopplerResolution ( ) const

inline

References mDopplerResolution.

Referenced by wsf::SurfaceWaveRadarSensorErrorModel::GetSphericalErrorStdDev().

◆ GetEM_Rcvr()

WsfEM_Rcvr * WsfSurfaceWaveRadarSensor::RadarMode::GetEM_Rcvr ( )

inlineoverridevirtual

Reimplemented from WsfSensorBeam.

References mRcvr.

Referenced by WsfSurfaceWaveRadarSensor::GetEM_Rcvr().

◆ GetEM_Xmtr()

WsfEM_Xmtr * WsfSurfaceWaveRadarSensor::RadarMode::GetEM_Xmtr ( )

inlineoverridevirtual

Reimplemented from WsfSensorBeam.

References mXmtr.

Referenced by WsfSurfaceWaveRadarSensor::GetEM_Xmtr().

◆ GetIntegrationGain()

double WsfSurfaceWaveRadarSensor::RadarMode::GetIntegrationGain ( ) const

inlineoverridevirtual

Reimplemented from WsfSensorBeam.

References mIntegrationGain.

◆ Initialize()

bool WsfSurfaceWaveRadarSensor::RadarMode::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 Calibrate(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::GetSimulation(), WsfSensorMode::Initialize(), mAntenna, WsfSensorMode::mMaximumRange, mNoise, mRcvr, WsfSensorMode::mSensorPtr, mXmtr, and ok.

◆ operator=()

RadarMode & WsfSurfaceWaveRadarSensor::RadarMode::operator= ( const RadarMode & )

delete

References RadarMode().

◆ ProcessInput()

bool WsfSurfaceWaveRadarSensor::RadarMode::ProcessInput ( UtInput & aInput )

overridevirtual

Reimplemented from WsfMode.

References wsf::MarcumSwerling::cDL_LINEAR, wsf::MarcumSwerling::cDL_LOG, wsf::MarcumSwerling::cDL_SQUARE, mAdjustmentFactor, mAntenna, mDetector, mDopplerResolution, WsfSensorMode::mErrorModelPtr, mIntegrationGain, mNoise, mRcvr, mUseDetector, mXmtr, WsfSensorBeam::ProcessInput(), and WsfSensorMode::ProcessInput().

◆ Select()

void WsfSurfaceWaveRadarSensor::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 mRcvr, and mXmtr.

◆ SetIntegrationGain()

void WsfSurfaceWaveRadarSensor::RadarMode::SetIntegrationGain ( double aIntegrationGain )

inlineoverridevirtual

Reimplemented from WsfSensorBeam.

References mIntegrationGain.

Member Data Documentation

◆ mAdjustmentFactor

double WsfSurfaceWaveRadarSensor::RadarMode::mAdjustmentFactor

protected

A term to represent a general adjustment (multiplier) to the radar range equation.

Referenced by AttemptToDetect(), Calibrate(), ProcessInput(), RadarMode(), and RadarMode().

◆ mAntenna

WsfEM_Antenna WsfSurfaceWaveRadarSensor::RadarMode::mAntenna

protected

Referenced by Initialize(), ProcessInput(), RadarMode(), and RadarMode().

◆ mDetector

wsf::MarcumSwerling WsfSurfaceWaveRadarSensor::RadarMode::mDetector

protected

Referenced by AttemptToDetect(), Calibrate(), ProcessInput(), RadarMode(), and RadarMode().

◆ mDopplerResolution

double WsfSurfaceWaveRadarSensor::RadarMode::mDopplerResolution

protected

Doppler resolution as velocity (m/s).

Referenced by GetDopplerResolution(), ProcessInput(), RadarMode(), and RadarMode().

◆ mIntegrationGain

double WsfSurfaceWaveRadarSensor::RadarMode::mIntegrationGain

protected

Integration gain for non-Swerling detector.

Referenced by AttemptToDetect(), Calibrate(), GetIntegrationGain(), ProcessInput(), RadarMode(), RadarMode(), and SetIntegrationGain().

◆ mNoise

WsfEM_Noise WsfSurfaceWaveRadarSensor::RadarMode::mNoise

protected

the EM_noise for a radar beam

Referenced by AttemptToDetect(), Initialize(), ProcessInput(), RadarMode(), and RadarMode().

◆ mRcvr

WsfEM_Rcvr WsfSurfaceWaveRadarSensor::RadarMode::mRcvr

protected

The receiver for a radar beam.

Referenced by AttemptToDetect(), AttemptToDetect(), Calibrate(), Deselect(), GetEM_Rcvr(), Initialize(), ProcessInput(), RadarMode(), RadarMode(), and Select().

◆ mUseDetector

bool WsfSurfaceWaveRadarSensor::RadarMode::mUseDetector

protected

If 'true' then used the detector.

Referenced by AttemptToDetect(), Calibrate(), ProcessInput(), RadarMode(), and RadarMode().

◆ mXmtr

WsfEM_Xmtr WsfSurfaceWaveRadarSensor::RadarMode::mXmtr

protected

The transmitter for a radar beam.

Referenced by AttemptToDetect(), Calibrate(), Deselect(), GetEM_Xmtr(), Initialize(), ProcessInput(), RadarMode(), RadarMode(), and Select().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RadarMode() [1/2]

◆ RadarMode() [2/2]

Member Function Documentation

◆ AttemptToDetect() [1/2]

◆ AttemptToDetect() [2/2]

◆ Calibrate()

◆ Clone()

◆ Deselect()

◆ GetBeamCount()

◆ GetBeamEntry()

◆ GetDopplerResolution()

◆ GetEM_Rcvr()

◆ GetEM_Xmtr()

◆ GetIntegrationGain()

◆ Initialize()

◆ operator=()

◆ ProcessInput()

◆ Select()

◆ SetIntegrationGain()

Member Data Documentation

◆ mAdjustmentFactor

◆ mAntenna

◆ mDetector

◆ mDopplerResolution

◆ mIntegrationGain

◆ mNoise

◆ mRcvr

◆ mUseDetector

◆ mXmtr