WsfSensorBeam Class Reference

#include <WsfSensorBeam.hpp>

Inheritance diagram for WsfSensorBeam:

Public Member Functions
	WsfSensorBeam ()
	WsfSensorBeam (const WsfSensorBeam &aSrc)=default
WsfSensorBeam &	operator= (const WsfSensorBeam &aRhs)
virtual	~WsfSensorBeam ()=default

Friends
class	WsfSensor
class	WsfSensorMode
class	WsfSensorModeList

Casting elimination accessors/mutators.
Derived classes should implement these methods to properly set/get data.
virtual int	GetNumberOfPulsesIntegrated () const
virtual double	GetIntegrationGain () const
virtual void	SetIntegrationGain (double aIntegrationGain)
virtual WsfEM_Clutter *	GetClutter () const

Transmitter/receiver access.
Derived classes should implement these methods to return the pointer to the underlying transmitter and receiver. Note The returned values may be if the beam doesn't have the respective object.
virtual WsfEM_Rcvr *	GetEM_Rcvr ()
virtual WsfEM_Xmtr *	GetEM_Xmtr ()
virtual bool	ProcessInput (UtInput &aInput)
virtual bool	Initialize (double aSimTime)
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 ()

Detailed Description

An optional base class for sensor beams.

Use of this class is totally optional. If your sensor implementation implements multiple beams AND it desired to being accessible to some optional derived versions of WsfSensorComponent, then you MUST implement this interface (as well as the GetBeamCount and GetBeamEntry methods) defined in WsfSensorMode. This allows components to have access to the transmitter and receiver defined in the beam.

If you use this class then you MUST adhere to the following rules:

• When creating the first beam in a mode (typically in the constructor), you must set the beam owner This typically looks something like:

  mBeamList.push_back(new MyBeam());      // Add the beam to the beam list
  mBeamList.back()->SetBeamOwner(this);   // Set its owning mode

• When adding beams to the beam list, you must set the beam index (index into the list).

  unsigned int beamIndex = static_cast<unsigned int>(mBeamList.size());
  mBeamList.push_back(new MyBeam(mBeamList[0]));   // Add the beam (clone of the first beam)
  mBeamList.back()->SetBeamIndex(beamIndex);       // Set the index for the new beam

• You must implement the GetEM_Rcvr and GetEM_Xmtr methods in your beam class.

(Examples of this code may be found in WsfPassiveSensor and WsfRadarSensor.)

From that point forward the beam owner and beam index will be maintained by the sensor framework.

Constructor & Destructor Documentation

WsfSensorBeam() [1/2]

WsfSensorBeam::WsfSensorBeam

(

)

Referenced by WsfSAR_Sensor::SAR_Mode::GetBeamEntry(), WsfSurfaceWaveRadarSensor::RadarMode::GetBeamEntry(), operator=(), WsfOTH_RadarSensor::OTH_Beam::OTH_Beam(), WsfOTH_RadarSensor::OTH_Beam::OTH_Beam(), WsfPassiveSensor::PassiveBeam::PassiveBeam(), WsfPassiveSensor::PassiveBeam::PassiveBeam(), WsfRadarSensor::RadarBeam::RadarBeam(), WsfRadarSensor::RadarBeam::RadarBeam(), WsfSurfaceWaveRadarSensor::RadarMode::RadarMode(), WsfSurfaceWaveRadarSensor::RadarMode::RadarMode(), WsfSAR_Sensor::SAR_Mode::SAR_Mode(), WsfSAR_Sensor::SAR_Mode::SAR_Mode(), WsfSensorBeam(), and WsfSensorModeList.

WsfSensorBeam() [2/2]

WsfSensorBeam::WsfSensorBeam ( const WsfSensorBeam & aSrc )

default

References WsfSensorBeam().

~WsfSensorBeam()

virtual WsfSensorBeam::~WsfSensorBeam ( )

virtualdefault

Member Function Documentation

GetBeamIndex()

size_t WsfSensorBeam::GetBeamIndex ( ) const

inline

Referenced by WsfCTD_SensorComponent::Initialize(), and WsfEW_SensorComponent::Initialize().

GetClutter()

virtual WsfEM_Clutter * WsfSensorBeam::GetClutter ( ) const

inlinevirtual

Reimplemented in WsfOTH_RadarSensor::OTH_Beam, and WsfRadarSensor::RadarBeam.

Referenced by WsfRadarMTD_SignalProcessor::Initialize(), WsfRadarMTI_SignalProcessor::Initialize(), and WsfRadarPD_SignalProcessor::Initialize().

GetEM_Rcvr()

virtual WsfEM_Rcvr * WsfSensorBeam::GetEM_Rcvr ( )

inlinevirtual

Reimplemented in WsfOTH_RadarSensor::OTH_Beam, WsfPassiveSensor::PassiveBeam, WsfRadarSensor::RadarBeam, WsfSAR_Sensor::SAR_Mode, and WsfSurfaceWaveRadarSensor::RadarMode.

Referenced by WsfRadarMTD_SignalProcessor::Initialize(), WsfRadarMTI_SignalProcessor::Initialize(), WsfRadarPD_SignalProcessor::Initialize(), and WsfEW_SensorComponent::EW_Mode::UpdateFalseTargetInteractors().

GetEM_Xmtr()

virtual WsfEM_Xmtr * WsfSensorBeam::GetEM_Xmtr ( )

inlinevirtual

Reimplemented in WsfOTH_RadarSensor::OTH_Beam, WsfRadarSensor::RadarBeam, WsfSAR_Sensor::SAR_Mode, and WsfSurfaceWaveRadarSensor::RadarMode.

Referenced by WsfRadarMTD_SignalProcessor::Initialize(), WsfRadarMTI_SignalProcessor::Initialize(), WsfRadarPD_SignalProcessor::Initialize(), and WsfEW_SensorComponent::EW_Mode::UpdateFalseTargetInteractors().

GetIntegrationGain()

double WsfSensorBeam::GetIntegrationGain ( ) const

virtual

Reimplemented in WsfOTH_RadarSensor::OTH_Beam, WsfRadarSensor::RadarBeam, and WsfSurfaceWaveRadarSensor::RadarMode.

GetNumberOfPulsesIntegrated()

int WsfSensorBeam::GetNumberOfPulsesIntegrated ( ) const

virtual

Reimplemented in WsfOTH_RadarSensor::OTH_Beam, and WsfRadarSensor::RadarBeam.

GetSensorMode()

WsfSensorMode * WsfSensorBeam::GetSensorMode ( ) const

inline

References WsfSensorMode.

Referenced by WsfCTD_SensorComponent::Initialize(), WsfEW_SensorComponent::Initialize(), WsfSAR_Sensor::SAR_Mode::SAR_ErrorModel::Initialize(), and ProcessInput().

GetSignalProcessors()

WsfSensorSignalProcessor::List & WsfSensorBeam::GetSignalProcessors ( )

inline

Referenced by WsfOTH_RadarSensor::OTH_Beam::Initialize(), and WsfRadarSensor::RadarBeam::Initialize().

Initialize()

bool WsfSensorBeam::Initialize ( double aSimTime )

virtual

Reimplemented in WsfSAR_Sensor::SAR_Mode, and WsfSurfaceWaveRadarSensor::RadarMode.

Referenced by WsfRadarSensor::RadarBeam::Initialize().

operator=()

WsfSensorBeam & WsfSensorBeam::operator=

(

const WsfSensorBeam &

aRhs

)

References WsfSensorBeam().

Referenced by WsfPassiveSensor::PassiveBeam::operator=(), and WsfRadarSensor::RadarBeam::operator=().

ProcessInput()

bool WsfSensorBeam::ProcessInput ( UtInput & aInput )

virtual

Reimplemented in WsfOTH_RadarSensor::OTH_Beam, WsfPassiveSensor::PassiveBeam, WsfRadarSensor::RadarBeam, WsfSAR_Sensor::SAR_Mode, and WsfSurfaceWaveRadarSensor::RadarMode.

References WsfSensor::GetComponents(), WsfSensorMode::GetSensor(), GetSensorMode(), WsfComponentList::HasComponents(), WsfSensor, and WsfSensorMode.

Referenced by WsfOTH_RadarSensor::OTH_Beam::ProcessInput(), WsfRadarSensor::RadarBeam::ProcessInput(), WsfSAR_Sensor::SAR_Mode::ProcessInput(), and WsfSurfaceWaveRadarSensor::RadarMode::ProcessInput().

SetBeamIndex()

void WsfSensorBeam::SetBeamIndex ( size_t aBeamIndex )

inline

Set the beam index for the second an subsequent beams. The application is responsible for calling this when a beam is first added to the beam list.

Referenced by WsfPassiveSensor::PassiveMode::ProcessInput().

SetBeamOwner()

void WsfSensorBeam::SetBeamOwner ( WsfSensorMode * aSensorModePtr )

inline

Set the beam owner (the parent mode).

References WsfSensorMode.

Referenced by WsfSAR_Sensor::SAR_Mode::SAR_Mode().

SetIntegrationGain()

void WsfSensorBeam::SetIntegrationGain ( double aIntegrationGain )

virtual

Reimplemented in WsfOTH_RadarSensor::OTH_Beam, WsfRadarSensor::RadarBeam, WsfSAR_Sensor::SAR_Mode, and WsfSurfaceWaveRadarSensor::RadarMode.

Friends And Related Symbol Documentation

WsfSensor

friend class WsfSensor

friend

References WsfSensor.

Referenced by WsfSAR_Sensor::SAR_Mode::ComputeGeometry(), WsfOTH_RadarSensor::OTH_Beam::Initialize(), WsfPassiveSensor::PassiveBeam::Initialize(), WsfRadarSensor::RadarBeam::Initialize(), ProcessInput(), and WsfSensor.

WsfSensorMode

friend class WsfSensorMode

friend

References WsfSensorMode.

Referenced by GetSensorMode(), WsfSAR_Sensor::SAR_Mode::SAR_ErrorModel::Initialize(), ProcessInput(), WsfSurfaceWaveRadarSensor::RadarMode::RadarMode(), WsfSurfaceWaveRadarSensor::RadarMode::RadarMode(), WsfSAR_Sensor::SAR_Mode::SAR_Mode(), WsfSAR_Sensor::SAR_Mode::SAR_Mode(), SetBeamOwner(), WsfSensorMode, and WsfSAR_Sensor::SAR_Mode::SAR_ErrorModel::~SAR_ErrorModel().

WsfSensorModeList

friend class WsfSensorModeList

friend

References WsfSensorBeam(), and WsfSensorModeList.

Referenced by WsfSensorModeList.

---

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

• WsfSensorBeam.hpp
• WsfSensorBeam.cpp