WSF
WsfSingleSensorObserver Class Reference

#include <WsfSingleSensorObserver.hpp>

Inheritance diagram for WsfSingleSensorObserver:

Public Member Functions

virtual ~WsfSingleSensorObserver ()=default
virtual void OnSensorTurnedOff (double aSimTime, WsfSensor *aSensorPtr)
 Called just after the sensor is turned off.
virtual void OnSensorTurnedOn (double aSimTime, WsfSensor *aSensorPtr)
 Called just after the sensor is turned on.
virtual void OnSensorDeleting (WsfSensor *aSensorPtr)
 Called before the sensor is actually deleted.
virtual void OnSensorDeleted (WsfSensor *aSensorPtr)
 Called just before the sensor is removed from the simulation.
virtual void OnSensorTargetUpdated (double aSimTime, WsfSensor *aSensorPtr, WsfPlatform *aTargetPtr, WsfSensorResult &aResult)
 Called after each sensor update.
virtual void OnSensorDetectionAttempted (double aSimTime, WsfSensor *aSensorPtr, WsfPlatform *aTargetPtr, WsfSensorResult &aResult)
 Called after each sensor detection attempt, per mode/beam for multi-mode/beam sensors.
virtual void OnSensorTrackInitiated (double aSimTime, WsfSensor *aSensorPtr, const WsfTrack &aTrack)
 Called after initial sensor track formation by a sensor (similar to Observer::SensorTrackInitiated).
virtual void OnSensorTrackUpdated (double aSimTime, WsfSensor *aSensorPtr, const WsfTrack &aTrack)
 Called after each subsequent update of sensor track by a sensor (similar to Observer::SensorTrackUpdated).
virtual void OnSensorTrackDropped (double aSimTime, WsfSensor *aSensorPtr, const WsfTrack &aTrack)
 Called after a sensor track is dropped by a sensor (similar to Observer::SensorTrackDropped).

Detailed Description

A light-weight observer of a single sensor.

A object may register an instance of this class with a particular sensor in order to receive notification of the events defined by the virtual methods. Unlike the simulation observers which receive notification of ALL occurrences of a subscribed event, this is directed at observing a SINGLE sensor. It is lighter weight and faster, but the user must take care to follow the process described below.

The typical use is to subclass this, define one or more of the virtual methods and attach to the platform using WsfSensor::AttachObserver(). Once an object attaches, it MUST detach from the sensor using WsfSensor::DetachObserver prior to its destruction.

Constructor & Destructor Documentation

◆ ~WsfSingleSensorObserver()

virtual WsfSingleSensorObserver::~WsfSingleSensorObserver ( )
virtualdefault

Member Function Documentation

◆ OnSensorDeleted()

virtual void WsfSingleSensorObserver::OnSensorDeleted ( WsfSensor * aSensorPtr)
inlinevirtual

Called just before the sensor is removed from the simulation.

Reimplemented in wsf::UCI_SensorComponent.

◆ OnSensorDeleting()

virtual void WsfSingleSensorObserver::OnSensorDeleting ( WsfSensor * aSensorPtr)
inlinevirtual

Called before the sensor is actually deleted.

Reimplemented in wsf::UCI_SensorComponent, and WsfCoherentSensorProcessor.

◆ OnSensorDetectionAttempted()

virtual void WsfSingleSensorObserver::OnSensorDetectionAttempted ( double aSimTime,
WsfSensor * aSensorPtr,
WsfPlatform * aTargetPtr,
WsfSensorResult & aResult )
inlinevirtual

Called after each sensor detection attempt, per mode/beam for multi-mode/beam sensors.

Reimplemented in WsfCoherentSensorProcessor.

◆ OnSensorTargetUpdated()

virtual void WsfSingleSensorObserver::OnSensorTargetUpdated ( double aSimTime,
WsfSensor * aSensorPtr,
WsfPlatform * aTargetPtr,
WsfSensorResult & aResult )
inlinevirtual

Called after each sensor update.

Reimplemented in WsfCoherentSensorProcessor.

◆ OnSensorTrackDropped()

virtual void WsfSingleSensorObserver::OnSensorTrackDropped ( double aSimTime,
WsfSensor * aSensorPtr,
const WsfTrack & aTrack )
inlinevirtual

Called after a sensor track is dropped by a sensor (similar to Observer::SensorTrackDropped).

◆ OnSensorTrackInitiated()

virtual void WsfSingleSensorObserver::OnSensorTrackInitiated ( double aSimTime,
WsfSensor * aSensorPtr,
const WsfTrack & aTrack )
inlinevirtual

Called after initial sensor track formation by a sensor (similar to Observer::SensorTrackInitiated).

Reimplemented in wsf::UCI_AMTI_Component, wsf::UCI_ESM_Component, and wsf::UCI_IRST_Component.

◆ OnSensorTrackUpdated()

virtual void WsfSingleSensorObserver::OnSensorTrackUpdated ( double aSimTime,
WsfSensor * aSensorPtr,
const WsfTrack & aTrack )
inlinevirtual

Called after each subsequent update of sensor track by a sensor (similar to Observer::SensorTrackUpdated).

Reimplemented in wsf::UCI_AMTI_Component, wsf::UCI_ESM_Component, and wsf::UCI_IRST_Component.

◆ OnSensorTurnedOff()

virtual void WsfSingleSensorObserver::OnSensorTurnedOff ( double aSimTime,
WsfSensor * aSensorPtr )
inlinevirtual

Called just after the sensor is turned off.

Reimplemented in wsf::UCI_SensorComponent, and WsfCoherentSensorProcessor.

◆ OnSensorTurnedOn()

virtual void WsfSingleSensorObserver::OnSensorTurnedOn ( double aSimTime,
WsfSensor * aSensorPtr )
inlinevirtual

Called just after the sensor is turned on.

Reimplemented in wsf::UCI_SensorComponent.


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