#include <WsfSensorProcessor.hpp>

Inheritance diagram for WsfSensorProcessor:

[legend]

Collaboration diagram for WsfSensorProcessor:

[legend]

Public Member Functions
	WsfSensorProcessor (WsfScenario &aScenario)
	~WsfSensorProcessor () override=default
Public Member Functions inherited from WsfProcessor
	WsfProcessor (const WsfScenario &aScenario)
	~WsfProcessor () override=default
ComponentList &	GetComponents ()
const ComponentList &	GetComponents () const
virtual void	ProcessCallback (double aSimTime, const WsfCallback &aCallback)
WsfComponent *	CloneComponent () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
int	GetComponentInitializationOrder () const override
const char *	GetScriptClassName () const override
bool	PreInitialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
void	PreInput () override
void	Update (double aSimTime) override
void	TurnOff (double aSimTime) override
void	TurnOn (double aSimTime) override
void	SetNonOperational (double aSimTime) override
void	SetOperational (double aSimTime) override
void	PartBroken (double aSimTime) override
double	GetUpdateInterval () const override
void	SetUpdateInterval (double aUpdateInterval) override
Public Member Functions inherited from WsfPlatformPart
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () override
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
unsigned int	GetDebugMask ()
bool	IsExternallyControlled () const
virtual void	SetExternallyControlled (double aSimTime, bool aIsExternallyControlled)
int	GetPartType () const
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
const WsfScenario &	GetScenario () const
WsfStringId	GetComponentName () const override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override
WsfPlatform *	GetPlatform () const
virtual void	SetPlatform (WsfPlatform *aPlatformPtr)
double	GetLastStatusChangeTime () const
void	SetLastStatusChangeTime (double aSimTime)
	Allows a system to set the time at which the device was initialized.
bool	CanBeMadeOperational () const
	Returns an indication that this system can be made operational.
bool	CanBeMadeNonOperational () const
	Returns an indication that this system can be made non-operational.
bool	CanBeTurnedOn () const
	Returns an indication that this system can be turned on.
bool	CanBeTurnedOff () const
	Returns an indication that this system can be turned off.
bool	IsTurnedOn () const
bool	InitiallyTurnedOn () const
	Is the system to be turned 'on' when added to the simulation?
void	SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
	Sets if the system is turned on when added to the simulation.
virtual void	Restore (double aSimTime)
bool	IsOperational () const
bool	SetOperational (double aSimTime, bool aMakeOperational)
double	GetDamageFactor () const
bool	SetDamageFactor (double aSimTime, double aDamageFactor)
bool	IsCritical () const
void	SetCritical (bool aValue)
virtual void	OnPlatformBrokenEvent (double aSimTime)
	Owning platform has issued a broken event.
bool	IsBroken () const
WsfInternalLinks &	GetInternalLinks ()
	Return the internal links for this part.
virtual bool	HasInternalLinks () const
	Does this platform part have a communication link to other platform parts?
virtual bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage)
virtual bool	ReceiveMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void	SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void	SendQueuedMessages (double aSimTime)
const WsfCategoryList &	GetCategories () const
	Get the categories to which this part belongs.
void	AddCategory (WsfStringId aCategoryId)
	Adds the provided category to the platform part's category list.
bool	IsCategoryMember (WsfStringId aCategoryId) const
const WsfGroupList &	GetGroups () const
	Get the groups to which this platform part belongs.
void	JoinGroup (WsfGroup *aGroupPtr)
	Join the given group.
void	LeaveGroup (WsfGroup *aGroupPtr)
	Leave the given group.
bool	IsGroupMember (WsfStringId aGroupId)
unsigned int	GetUpdateEventEpoch () const
void	IncrementUpdateEventEpoch ()
bool	UpdateEventActive () const
	Is an 'Update' event active?
void	SetUpdateEventActive (bool aUpdateEventActive)
	Indicate if the 'Update' event is active.
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
Public Member Functions inherited from WsfUniqueId
	WsfUniqueId ()
	Construtor initializes the unique identifier to 0.
	WsfUniqueId (const WsfUniqueId &)
	Copy constructor initializes the unique identifier to 0.
WsfUniqueId &	operator= (const WsfUniqueId &)
unsigned int	GetUniqueId () const
	Get the unique identifier assigned to this object.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Tracking Methods
std::recursive_mutex	mIncomingMutex
virtual void	TrackUpdated (double aSimTime, WsfSensor aSensorPtr, WsfTrack aTrackPtr)
virtual void	TrackDropped (double aSimTime, const WsfTrack &aTrack)
void	SendTrackUpdateMessage (double aSimTime, WsfSensor aSensorPtr, const WsfTrack aTrackPtr)

Base Class overrides
WsfProcessor *	Clone () const override=0
bool	Initialize (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr) override
void	PlatformDeleted (WsfPlatform *aPlatformPtr) override
virtual bool	AddSensor (WsfStringId aPlatformNameId, WsfStringId aSensorNameId)
virtual bool	RemoveSensor (WsfStringId aPlatformNameId, WsfStringId aSensorNameId)
static void	RegisterScriptMethods (UtScriptTypes &aScriptTypes)
	WsfSensorProcessor (const WsfSensorProcessor &aSrc)
WsfSensorProcessor &	operator= (const WsfSensorProcessor &aRhs)=delete
virtual bool	SensorAdded (WsfSensor *aSensorPtr)=0
	Clear any data or lists maintained by inheriting classes.
virtual bool	SensorRemoved (WsfSensor *aSensorPtr)=0

Additional Inherited Members
using	ComponentList = WsfComponentListT<WsfProcessorComponent>
Public Types inherited from WsfPlatformPart
enum	{ cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using	InternalMessageQueue = std::queue<WsfMessage*>
using	RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart, WsfMessage>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
	WsfProcessor (const WsfProcessor &aSrc)
	Copy constructor (for Clone()).
WsfProcessor &	operator= (const WsfProcessor &aRhs)=delete
	WsfPlatformPart (const WsfPlatformPart &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void	AssignUniqueId (WsfSimulation *aSimulationPtr)

Detailed Description

A base class sensor processor that connects to single or multiple sensors to allow for sensor base functionality and sensor management for inheriting classes.

Note: The inheriting class may want to also inherit from the WsfSingleSensorObserver to attach directly to certain sensor events.

Constructor & Destructor Documentation

◆ WsfSensorProcessor() [1/2]

WsfSensorProcessor::WsfSensorProcessor ( WsfScenario & aScenario )

References mIncomingMutex, and WsfProcessor::WsfProcessor().

Referenced by Clone(), operator=(), WsfCoherentSensorProcessor::WsfCoherentSensorProcessor(), WsfCoherentSensorProcessor::WsfCoherentSensorProcessor(), WsfSensorProcessor(), and WsfTRIMSIM_Processor::WsfTRIMSIM_Processor().

◆ ~WsfSensorProcessor()

WsfSensorProcessor::~WsfSensorProcessor ( )

overridedefault

◆ WsfSensorProcessor() [2/2]

WsfSensorProcessor::WsfSensorProcessor ( const WsfSensorProcessor & aSrc )

protected

References mIncomingMutex, WsfProcessor::WsfProcessor(), and WsfSensorProcessor().

Member Function Documentation

◆ AddSensor()

bool WsfSensorProcessor::AddSensor	(	WsfStringId	aPlatformNameId,
		WsfStringId	aSensorNameId )

virtual

References WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), WsfObject::GetNameId(), WsfPlatformPart::GetPlatform(), WsfSimulation::GetPlatformByName(), WsfPlatformPart::GetSimulation(), platformPtr, and SensorAdded().

Referenced by Clone(), Initialize(), and PlatformAdded().

◆ Clone()

WsfProcessor * WsfSensorProcessor::Clone ( ) const

overridepure virtual

Create a clone of this object.

Returns: A pointer to the new copy.

Implements WsfProcessor.

Implemented in WsfCoherentSensorProcessor, and WsfTRIMSIM_Processor.

References AddSensor(), RegisterScriptMethods(), RemoveSensor(), WsfProcessor::WsfProcessor(), and WsfSensorProcessor().

◆ Initialize()

bool WsfSensorProcessor::Initialize ( double aSimTime )

overridevirtual

Perform phase 1 initialization of the part. This is invoked by WsfPlatform::Initialize() during phase 1 initialization of the platform. During phase 1 initialization, platform components must not assume the existence of ANY data that is the responsibility of another platform component. In particular, the platform location and initial tracks cannot be assumed to be valid.

Parameters

aSimTime The current simulation time.

Returns: 'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfProcessor.

References AddSensor(), WsfObject::GetNameId(), WsfPlatformPart::GetPlatform(), WsfProcessor::Initialize(), and ok.

Referenced by WsfCoherentSensorProcessor::Initialize().

◆ operator=()

WsfSensorProcessor & WsfSensorProcessor::operator= ( const WsfSensorProcessor & aRhs )

protecteddelete

References WsfSensorProcessor().

◆ PlatformAdded()

void WsfSensorProcessor::PlatformAdded	(	double	aSimTime,
		WsfPlatform *	aPlatformPtr )

overridevirtual

Some other platform has been added to the simulation.

This is invoked (via WsfPlatform::PlatformAdded) whenever another platform has been added to the simulation.

Parameters

aSimTime	The current simulation time.
aPlatformPtr	Pointer to the platform being added.

Reimplemented from WsfPlatformPart.

References AddSensor(), and WsfObject::GetNameId().

◆ PlatformDeleted()

void WsfSensorProcessor::PlatformDeleted ( WsfPlatform * aPlatformPtr )

overridevirtual

Some other platform has been deleted from the simulation.

This is invoked (via WsfPlatform::PlatformDeleted) whenever another platform has been deleted from the simulation.

Parameters

aPlatformPtr Pointer to the platform being deleted.

Reimplemented from WsfPlatformPart.

References WsfObject::GetNameId(), and RemoveSensor().

◆ ProcessInput()

bool WsfSensorProcessor::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfProcessor.

Reimplemented in WsfTRIMSIM_Processor.

References WsfProcessor::ProcessInput().

Referenced by WsfCoherentSensorProcessor::ProcessInput(), and WsfTRIMSIM_Processor::ProcessInput().

◆ RegisterScriptMethods()

void WsfSensorProcessor::RegisterScriptMethods ( UtScriptTypes & aScriptTypes )

static

Register the script methods associated with this class.

Note: The WsfPlatform script class must be defined before calling this method.

Referenced by Clone(), and WsfScriptManager::RegisterTypes().

◆ RemoveSensor()

bool WsfSensorProcessor::RemoveSensor	(	WsfStringId	aPlatformNameId,
		WsfStringId	aSensorNameId )

virtual

References WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), WsfObject::GetNameId(), WsfPlatformPart::GetPlatform(), WsfSimulation::GetPlatformByName(), WsfPlatformPart::GetSimulation(), platformPtr, and SensorRemoved().

Referenced by Clone(), and PlatformDeleted().

◆ SendTrackUpdateMessage()

void WsfSensorProcessor::SendTrackUpdateMessage	(	double	aSimTime,
		WsfSensor *	aSensorPtr,
		const WsfTrack *	aTrackPtr )

protected

A common method to inform interested parties that the track has been updated. This will inform simulation observers and attached processors that a track has been updated.

Parameters

aSimTime	[input] The current simulation time.
aSensorPtr	[input] Pointer to the sensor.
aTrackPtr	[input] A pointer to the track being updated.

References WsfPlatformPart::GetPlatform(), WsfPlatformPart::SendMessage(), WsfMessage::SetPriority(), and WsfMessage::SetSizeBits().

Referenced by SensorRemoved(), and TrackUpdated().

◆ SensorAdded()

virtual bool WsfSensorProcessor::SensorAdded ( WsfSensor * aSensorPtr )

protectedpure virtual

Clear any data or lists maintained by inheriting classes.

Implemented in WsfCoherentSensorProcessor.

Referenced by AddSensor().

◆ SensorRemoved()

virtual bool WsfSensorProcessor::SensorRemoved ( WsfSensor * aSensorPtr )

protectedpure virtual

Implemented in WsfCoherentSensorProcessor.

References SendTrackUpdateMessage(), TrackDropped(), and TrackUpdated().

Referenced by RemoveSensor().

◆ TrackDropped()

void WsfSensorProcessor::TrackDropped	(	double	aSimTime,
		const WsfTrack &	aTrack )

protectedvirtual

Hook to notify a derived class that a track representing a target being dropped.

Parameters

aSimTime	The current simulation time.
aTrack	The track being dropped.

Referenced by SensorRemoved().

◆ TrackUpdated()

void WsfSensorProcessor::TrackUpdated	(	double	aSimTime,
		WsfSensor *	aSensorPtr,
		WsfTrack *	aTrackPtr )

protectedvirtual

The sensor tracker has updated a track. This method is a hook that is called when a derived sensor (or one of it's constituents such as the tracker) has updated a track. The default method simply calls SendTrackUpdateMessage inform simulation observers and send a message to attached processors.

This method is often provided by derived classes that want to use an existing sensor and simply want to change how information is reported.

Parameters

aSimTime	[input] The current simulation time.
aSensorPtr	[input] Pointer to the sensor.
aTrackPtr	[input] A pointer to the track being updated.

References WsfPlatformPart::GetSimulation(), WsfTrack::GetUpdateCount(), WsfPlatformPart::IsExternallyControlled(), SendTrackUpdateMessage(), WsfObserver::SensorTrackInitiated(), and WsfObserver::SensorTrackUpdated().

Referenced by SensorRemoved().

Member Data Documentation

◆ mIncomingMutex

std::recursive_mutex WsfSensorProcessor::mIncomingMutex

protected

Referenced by WsfCoherentSensorProcessor::OnSensorDetectionAttempted(), WsfCoherentSensorProcessor::OnSensorTargetUpdated(), WsfSensorProcessor(), and WsfSensorProcessor().

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

Public Member Functions

Tracking Methods

Base Class overrides

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfSensorProcessor() [1/2]

◆ ~WsfSensorProcessor()

◆ WsfSensorProcessor() [2/2]

Member Function Documentation

◆ AddSensor()

◆ Clone()

◆ Initialize()

◆ operator=()

◆ PlatformAdded()

◆ PlatformDeleted()

◆ ProcessInput()

◆ RegisterScriptMethods()

◆ RemoveSensor()

◆ SendTrackUpdateMessage()

◆ SensorAdded()

◆ SensorRemoved()

◆ TrackDropped()

◆ TrackUpdated()

Member Data Documentation

◆ mIncomingMutex