#include <WsfUCI_SensorComponent.hpp>

Inheritance diagram for wsf::UCI_SensorComponent:

[legend]

Collaboration diagram for wsf::UCI_SensorComponent:

[legend]

Definitions to support templated component methods.
static const int	cWSF_COMPONENT_UCI_SENSOR = 1234578
WsfSensor *	mSensorPtr { nullptr }
std::string	mSensorName
int	mClass
std::map< std::string, size_t >	mUUID_ToModeIndex
size_t	mLowestAvailableCapability { 0 }
	UCI_SensorComponent ()=delete
	UCI_SensorComponent (const WsfScenario &aScenario, int aPartType, const int aClass)
	UCI_SensorComponent (const UCI_SensorComponent &aSrc)
virtual	~UCI_SensorComponent ()=default
bool	ProcessInput (UtInput &aInput) override
void	SetUpdateMessageTime (double aUpdateTime)
double	GetUpdateMessageTime () const
void	ClearRemarks ()
std::string	GetRemarks () const
uci::type::CommandStateEnum::EnumerationItem	GetCommandState () const
void	UpdateCommandResults (const uci::type::CommandStateEnum::EnumerationItem &aState, const std::string &aRemark)
void *	QueryInterface (int aRole) override
bool	PreInitialize (double aSimTime) override
bool	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
const int *	GetComponentRoles () const override
WsfSensor *	GetSensor () const
const std::string &	GetSensorName () const
virtual void	OnSensorDeleting (WsfSensor *aSensorPtr) override
	Called before the sensor is actually deleted.
virtual void	OnSensorDeleted (WsfSensor *aSensorPtr) override
	Called just before the sensor is removed from the simulation.
virtual void	OnSensorTurnedOff (double aSimTime, WsfSensor *aSensorPtr) override
	Called just after the sensor is turned off.
virtual void	OnSensorTurnedOn (double aSimTime, WsfSensor *aSensorPtr) override
	Called just after the sensor is turned on.
virtual void	OnSlewComplete (double aSimTime)
void	SelectDefaultMode (double aSimTime)
void	SensorModeActivated (double aSimTime, WsfSensor aSensorPtr, WsfSensorMode aModePtr)
void	SensorModeDeactivated (double aSimTime, WsfSensor aSensorPtr, WsfSensorMode aModePtr)
void	Attach (WsfSensor &aSensor)
virtual void	ClearActivities ()=0
void	Detach () override
	Detaches the component observer from the sensor.
template<typename CapabilityType, typename CapabilityStatusType>
void	InitializeModeData (CapabilityType &aCapabilityType, CapabilityStatusType &aStatusType, const size_t &aIndex)
template<typename CommandStatusMessage, typename CommandID>
void	SendCommandStatusMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState, const CommandID &aCommandID)
virtual void	SendControlRequestStatusMessage (double aSimTime, const uci::type::ControlRequestID_Type &aRequestID)
virtual void	SendControlStatusMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState)
void	SendEntityMessage (double aSimTime, const WsfTrack &aTrack, const uci::type::MessageStateEnum::EnumerationItem &aMessageState, const uci::type::EntitySourceEnum::EnumerationItem &aSourceType)
virtual void	UpdateAllMessages () override
template<typename CapabilityStatusMessage>
void	UpdateCapabilityStatusMessage (CapabilityStatusMessage *aMessagePtr)
template<typename CapabilityStatusMessage>
uci::type::CapabilityAvailabilityEnum::EnumerationItem	GetCapabilityAvailability (const CapabilityStatusMessage *aMessagePtr, const size_t aIndex) const
template<typename ActivityMessage>
void	SlewComplete (double aSimTime, ActivityMessage *aMessagePtr)
virtual void	SetAllCapabilitiesAvailability (const uci::type::CapabilityAvailabilityEnum::EnumerationItem &aAvailability)=0
virtual void	SetCommandAccepted (double aAz, double aEl)
virtual void	SetRejectedOutOfLimits (double aAz, double aEl)
virtual void	SetRejectedFixedMode (const std::string &aModeName, const std::string &aCapabilityUUID)
virtual void	SetRejectedModeDisabled (const std::string &aModeName, const std::string &aCapabilityUUID)
virtual void	SetRejectedTypeUnavailable ()

Additional Inherited Members
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.
	UCI_PartComponent ()=delete
	UCI_PartComponent (const WsfScenario &aScenario, int aPartType)
	UCI_PartComponent (const UCI_PartComponent &aSrc)
virtual	~UCI_PartComponent ()=default
void	SetUpdateMessageTime (double aUpdateTime)
double	GetUpdateMessageTime () const
void	ClearRemarks ()
std::string	GetRemarks () const
uci::type::CommandStateEnum::EnumerationItem	GetCommandState () const
void	UpdateCommandResults (const uci::type::CommandStateEnum::EnumerationItem &aState, const std::string &aRemark)
virtual void	SendUpdateMessages (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState)
virtual bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage) override
virtual std::set< std::string >	GetCapabilityUUIDs () const override
	UCI_Component (const WsfScenario &aScenario, int aPartType)
	UCI_Component (const UCI_Component &aSrc)
virtual	~UCI_Component ()
UCI_Interface *	GetInterface ()
double	GetUpdateInterval () const override
void	SetUpdateInterval (double aUpdateInterval) override
WsfStringId	GetComponentName () const override
virtual bool	InjectConditionally (double aSimTime, WsfPlatform &aPlatform)
bool	IsActive ()
	Is this interface active (i.e., it has a valid corresponding UCI interface; otherwise it does nothing).
bool	RegisterWithInterface (double aSimTime)
void	DeregisterWithInterface ()
void	RegisterCapabilitiesWithInterface ()
void	DeregisterCapabilitiesWithInterface ()
virtual void	ReceiveUCI_Message (const uci::type::MessageType *aMessagePtr)
WsfSimulation &	GetSimulation () const
	Convenience Methods.
bool	CanHandleMessage () const
Public Member Functions inherited from WsfPlatformPart
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) 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
bool	Initialize (double aSimTime) override
bool	Initialize2 (double aSimTime) override
bool	ProcessInput (UtInput &aInput) override
virtual void	Update (double aSimTime)
WsfPlatform *	GetPlatform () const
virtual void	SetPlatform (WsfPlatform *aPlatformPtr)
virtual void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
virtual void	PlatformDeleted (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	SetOperational (double aSimTime)
virtual void	SetNonOperational (double aSimTime)
virtual void	PartBroken (double aSimTime)
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	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
virtual WsfObject *	Clone () const =0
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
virtual WsfComponent *	CloneComponent () const =0
virtual int	GetComponentInitializationOrder () const
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual void	PreInput ()
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
Public Member Functions inherited from WsfSingleSensorObserver
virtual	~WsfSingleSensorObserver ()=default
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).
static const int	cWSF_COMPONENT_UCI_PART = 1234321
static const int	cWSF_COMPONENT_UCI = 1234568
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
bool	IsCommandAccepted () const
virtual void	SetOwnerProducer (const ISM_OwnerProducerType &aOwnerType)
bool	CheckPartStatus (WsfArticulatedPart *aPartPtr)
bool	HandleControlRequestMessage (const UCI_ControlRequestMessage &aMessage)
bool	HasControl (const std::string &aCapbilityUUID, uci::type::ServiceID_Type &aServiceID, uci::type::SystemID_Type &aSystemID)
virtual void	SendActivityMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState)=0
virtual void	SendCapabilityMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState)=0
virtual void	SendCapabilityStatusMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState)=0
template<typename CommandStatusMessage, typename CommandID>
void	SendCommandStatusMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState, const CommandID &aCommandID)
virtual void	SendSubsystemStatusMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState)
virtual void	SendSystemStatusMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState)
virtual void	TurnOn (double aSimTime) override
virtual void	TurnOff (double aSimTime) override
template<typename CapabilityStatusMessage>
void	UpdateCapabilityStatusMessage (CapabilityStatusMessage *aMessagePtr)
void	UpdateSubsystemStatusMessage (uci::type::SubsystemStateEnum::EnumerationItem aState)
virtual uci::type::ApprovalEnum::EnumerationItem	GetApprovalType () const
template<typename CapabilityStatusMessage>
uci::type::CapabilityAvailabilityEnum::EnumerationItem	GetCapabilityAvailability (const CapabilityStatusMessage *aMessagePtr, const size_t aIndex) const
void	SetRejectedCurrentlyCommanded (const std::string &aPartName)
virtual void	PrintMessageSent (double aSimTime, const std::string &aMessageType)
virtual void	PrintMessageNotSent (double aSimTime, const std::string &aMessageType, const std::string &aReason)
	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)
std::unique_ptr< UCI_ControlStatusMessage >	mControlStatusMessagePtr
std::unique_ptr< UCI_SubsystemStatusMessage >	mSubsystemStatusMessagePtr
std::unique_ptr< UCI_SystemStatusMessage >	mSystemStatusMessagePtr
std::map< std::string, std::string >	mCapabilityToUUID
double	mUpdateMessageTime { 10 }
std::map< std::string, std::string >	mActivityToCabability
uci::type::CommandStateEnum::EnumerationItem	mCommandState { uci::type::CommandStateEnum::UCI_ACCEPTED }
std::string	mRemarks
bool	mInitialMessagesSent { false }
bool	mIsCommanded { false }
UtCallbackHolder	mCallbacks
std::map< std::string, Controller >	mPrimaryController
std::map< std::string, std::set< Controller > >	mSecondaryControllers
std::map< std::string, std::set< Controller > >	mManagerControllers
uci::type::ApprovalEnum::EnumerationItem	mApprovalType
std::string	mSubsystemUUID
std::string	mSubsystemLabel

Detailed Description

An example of a simple platform component (See WsfSimplePlatformCompoent). UCI_ are meant to be single instances on platforms with only a defined quantity.

Constructor & Destructor Documentation

◆ UCI_SensorComponent() [1/3]

wsf::UCI_SensorComponent::UCI_SensorComponent ( )

delete

References UCI_SensorComponent().

Referenced by wsf::UCI_ESM_Component::QueryInterface(), wsf::UCI_IRST_Component::QueryInterface(), wsf::UCI_AMTI_Component::UCI_AMTI_Component(), wsf::UCI_AMTI_Component::UCI_AMTI_Component(), wsf::UCI_ESM_Component::UCI_ESM_Component(), wsf::UCI_ESM_Component::UCI_ESM_Component(), wsf::UCI_IRST_Component::UCI_IRST_Component(), wsf::UCI_IRST_Component::UCI_IRST_Component(), UCI_SensorComponent(), and UCI_SensorComponent().

◆ UCI_SensorComponent() [2/3]

wsf::UCI_SensorComponent::UCI_SensorComponent	(	const WsfScenario &	aScenario,
		int	aPartType,
		const int	aClass )

References mClass, and wsf::UCI_PartComponent::UCI_PartComponent().

◆ UCI_SensorComponent() [3/3]

wsf::UCI_SensorComponent::UCI_SensorComponent ( const UCI_SensorComponent & aSrc )

References mClass, mSensorName, mUUID_ToModeIndex, wsf::UCI_PartComponent::UCI_PartComponent(), and UCI_SensorComponent().

◆ ~UCI_SensorComponent()

virtual wsf::UCI_SensorComponent::~UCI_SensorComponent ( )

virtualdefault

Member Function Documentation

◆ Attach()

void wsf::UCI_SensorComponent::Attach ( WsfSensor & aSensor )

protected

Attaches the UCI component to the given sensor

Parameters

aSensor The sensor to attach observer to

References WsfSensor::AttachObserver(), WsfPlatformPart::DebugEnabled(), Detach(), WsfObject::GetName(), wsf::UCI_Component::GetSimulation(), mSensorPtr, OnSlewComplete(), SensorModeActivated(), WsfObserver::SensorModeActivated(), SensorModeDeactivated(), and WsfObserver::SensorModeDeactivated().

Referenced by PreInitialize().

◆ ClearActivities()

virtual void wsf::UCI_SensorComponent::ClearActivities ( )

protectedpure virtual

Implements wsf::UCI_PartComponent.

Referenced by OnSensorTurnedOff().

◆ ClearRemarks()

void wsf::UCI_SensorComponent::ClearRemarks ( )

inline

References wsf::UCI_PartComponent::mRemarks.

◆ Detach()

void wsf::UCI_SensorComponent::Detach ( )

overrideprotectedvirtual

Detaches the component observer from the sensor.

Reimplemented from wsf::UCI_PartComponent.

References WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), and mSensorPtr.

Referenced by Attach(), OnSensorDeleted(), wsf::UCI_AMTI_Component::~UCI_AMTI_Component(), wsf::UCI_ESM_Component::~UCI_ESM_Component(), and wsf::UCI_IRST_Component::~UCI_IRST_Component().

◆ GetCapabilityAvailability()

template<typename CapabilityStatusMessage>

uci::type::CapabilityAvailabilityEnum::EnumerationItem wsf::UCI_SensorComponent::GetCapabilityAvailability	(	const CapabilityStatusMessage *	aMessagePtr,
		const size_t	aIndex ) const

inlineprotected

References wsf::UCI_Component::CanHandleMessage().

◆ GetCommandState()

uci::type::CommandStateEnum::EnumerationItem wsf::UCI_SensorComponent::GetCommandState ( ) const

inline

References wsf::UCI_PartComponent::mCommandState.

Referenced by SendCommandStatusMessage().

◆ GetComponentRoles()

const int * wsf::UCI_SensorComponent::GetComponentRoles ( ) const

overridevirtual

Returns a zero-terminated array of component roles. Note that the array should be in decreasing order of specificity and should generally the inheritance hierarchy. The first entry should be the components 'primary' role. For example a sensor would do the following:

static const int roles[] = { cWSF_COMPONENT_SENSOR, cWSF_COMPONENT_ARTICULATED_PART,
                             cWSF_COMPONENT_PLATFORM_PART, 0 };
return roles;

Reimplemented from wsf::UCI_PartComponent.

References cWSF_COMPONENT_NULL, cWSF_COMPONENT_PLATFORM_PART, wsf::UCI_Component::cWSF_COMPONENT_UCI, wsf::UCI_PartComponent::cWSF_COMPONENT_UCI_PART, and cWSF_COMPONENT_UCI_SENSOR.

◆ GetRemarks()

std::string wsf::UCI_SensorComponent::GetRemarks ( ) const

inline

References wsf::UCI_PartComponent::mRemarks.

◆ GetSensor()

WsfSensor * wsf::UCI_SensorComponent::GetSensor ( ) const

inline

References mSensorPtr.

◆ GetSensorName()

const std::string & wsf::UCI_SensorComponent::GetSensorName ( ) const

inline

References mSensorPtr.

◆ GetUpdateMessageTime()

double wsf::UCI_SensorComponent::GetUpdateMessageTime ( ) const

inline

References wsf::UCI_PartComponent::mUpdateMessageTime.

◆ Initialize()

bool wsf::UCI_SensorComponent::Initialize ( double aSimTime )

overridevirtual

Perform phase 1 initialization. This is called by WsfPlatform::Initialize() during phase 1 initialization of the platform. The component should complete validation of input data that could not be done by ProcessInput, as well as any other functions to prepare for simulation use (subject to the next paragraph).

The order in which components are initialized is defined by GetComponentInitializationOrder. In general a component implementation of this method should not be dependent on the state of another component, i.e.: it should not assume that the other components Initialize() method has been called. If such a dependency exists one should use Initialize2() if possible, or specify a value GetComponentInitializationOrder to force things to initialize in a particular order.

Parameters

aSimTime The current simulation time.

Returns: true if successful or false if unsuccessful (bad input data, etc.)

Note: This method should NOT add any other components to the platform. This MUST be done in PreInitialize().

Reimplemented from WsfComponent.

References WsfObject::GetName(), WsfComponent::Initialize(), mSensorName, and mSensorPtr.

◆ Initialize2()

bool wsf::UCI_SensorComponent::Initialize2 ( double aSimTime )

overridevirtual

Save whether this component was successfully initialized. In overriding this method, this base class method should be called last. (see destructor).

Reimplemented from wsf::UCI_PartComponent.

References WsfObject::GetName(), WsfPlatformPart::GetPlatform(), UCI_Util::GetSubsystemState(), wsf::UCI_PartComponent::Initialize2(), wsf::UCI_Component::IsActive(), mSensorPtr, wsf::UCI_Component::mSubsystemLabel, wsf::UCI_PartComponent::mSubsystemStatusMessagePtr, and UCI_Util::RemoveAngleBrackets().

Referenced by wsf::UCI_AMTI_Component::Initialize2(), wsf::UCI_ESM_Component::Initialize2(), and wsf::UCI_IRST_Component::Initialize2().

◆ InitializeModeData()

template<typename CapabilityType, typename CapabilityStatusType>

void wsf::UCI_SensorComponent::InitializeModeData	(	CapabilityType &	aCapabilityType,
		CapabilityStatusType &	aStatusType,
		const size_t &	aIndex )

inlineprotected

============================================================= Initializes common mode data such as the CapabilityID, ControlInterface,

References WsfArticulatedPart::cSLEW_FIXED, WsfComponentT< WsfPlatform >::GetComponentParent(), wsf::UCI_Interface::GetConnection(), wsf::UCI_Component::GetInterface(), wsf::UCI_PartComponent::mCapabilityToUUID, wsf::UCI_PartComponent::mControlStatusMessagePtr, wsf::UCI_PartComponent::mPrimaryController, mSensorPtr, wsf::UCI_PartComponent::mSubsystemStatusMessagePtr, mUUID_ToModeIndex, and UCI_Util::RemoveAngleBrackets().

Referenced by wsf::UCI_AMTI_Component::Initialize2(), wsf::UCI_ESM_Component::Initialize2(), and wsf::UCI_IRST_Component::Initialize2().

◆ OnSensorDeleted()

void wsf::UCI_SensorComponent::OnSensorDeleted ( WsfSensor * aSensorPtr )

overridevirtual

Called just before the sensor is removed from the simulation.

Reimplemented from WsfSingleSensorObserver.

References WsfPlatformPart::DebugEnabled(), Detach(), and WsfObject::GetName().

◆ OnSensorDeleting()

void wsf::UCI_SensorComponent::OnSensorDeleting ( WsfSensor * aSensorPtr )

overridevirtual

Called before the sensor is actually deleted.

Reimplemented from WsfSingleSensorObserver.

◆ OnSensorTurnedOff()

void wsf::UCI_SensorComponent::OnSensorTurnedOff	(	double	aSimTime,
		WsfSensor *	aSensorPtr )

overridevirtual

Called just after the sensor is turned off.

Reimplemented from WsfSingleSensorObserver.

References ClearActivities(), WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), wsf::UCI_PartComponent::mIsCommanded, wsf::UCI_PartComponent::SendActivityMessage(), wsf::UCI_PartComponent::SendCapabilityStatusMessage(), wsf::UCI_PartComponent::SendSubsystemStatusMessage(), wsf::UCI_PartComponent::SendSystemStatusMessage(), SetAllCapabilitiesAvailability(), and UpdateAllMessages().

◆ OnSensorTurnedOn()

void wsf::UCI_SensorComponent::OnSensorTurnedOn	(	double	aSimTime,
		WsfSensor *	aSensorPtr )

overridevirtual

Called just after the sensor is turned on.

Reimplemented from WsfSingleSensorObserver.

References WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), wsf::UCI_PartComponent::mIsCommanded, wsf::UCI_PartComponent::SendActivityMessage(), wsf::UCI_PartComponent::SendCapabilityStatusMessage(), wsf::UCI_PartComponent::SendSubsystemStatusMessage(), wsf::UCI_PartComponent::SendSystemStatusMessage(), SetAllCapabilitiesAvailability(), and UpdateAllMessages().

◆ OnSlewComplete()

virtual void wsf::UCI_SensorComponent::OnSlewComplete ( double aSimTime )

inlinevirtual

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

Referenced by Attach().

◆ PreInitialize()

bool wsf::UCI_SensorComponent::PreInitialize ( double aSimTime )

overridevirtual

Perform pre-initializion function. This is called by WsfPlatform::Initialize prior to actually initializing the components on a platform (i.e.: calling Initialize and Initialize2 for each component). The primary reason for this method is to allow components to add other components that will then be subsequently initialized. The component may examine the component list and add components, but it must not assume ANYTHING about the actual state of the component.

Parameters

aSimTime The current simulation time.

Returns: true if successful or false if unsuccessful (bad input data, etc.)

Reimplemented from WsfComponent.

References Attach(), cWSF_COMPONENT_SENSOR, WsfComponentListT< COMPONENT_TYPE >::GetComponentEntryByRole(), WsfComponentT< WsfPlatform >::GetComponentParent(), wsf::UCI_Component::IsActive(), mClass, mSensorName, ok, and WsfComponent::PreInitialize().

◆ ProcessInput()

bool wsf::UCI_SensorComponent::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 wsf::UCI_PartComponent.

References wsf::UCI_PartComponent::mCapabilityToUUID, mSensorName, mUUID_ToModeIndex, and wsf::UCI_PartComponent::ProcessInput().

◆ QueryInterface()

void * wsf::UCI_SensorComponent::QueryInterface ( int aRole )

overridevirtual

Requests a component's role interface. A component can support one or more roles.

Parameters

aRole The role whose interface is to be returned.

Returns: A pointer to the object if it supports the indicated role, or 'null' if it does not. Usage: WsfProcessor* procPtrOrNull = (WsfProcessor*)componentPtr->QueryComponentInterface(cWSF_COMPONENT_PROCESSOR);

Reimplemented from wsf::UCI_PartComponent.

References cWSF_COMPONENT_UCI_SENSOR, and wsf::UCI_PartComponent::QueryInterface().

Referenced by wsf::UCI_AMTI_Component::QueryInterface().

◆ SelectDefaultMode()

void wsf::UCI_SensorComponent::SelectDefaultMode ( double aSimTime )

References mLowestAvailableCapability, and mSensorPtr.

◆ SendCommandStatusMessage()

template<typename CommandStatusMessage, typename CommandID>

void wsf::UCI_SensorComponent::SendCommandStatusMessage	(	double	aSimTime,
		const uci::type::MessageStateEnum::EnumerationItem &	aMessageState,
		const CommandID &	aCommandID )

inlineprotected

References GetCommandState(), WsfComponentT< WsfPlatform >::GetComponentParent(), wsf::UCI_PartComponent::PrintMessageSent(), and WsfPlatformPart::SendMessage().

◆ SendControlRequestStatusMessage()

void wsf::UCI_SensorComponent::SendControlRequestStatusMessage	(	double	aSimTime,
		const uci::type::ControlRequestID_Type &	aRequestID )

protectedvirtual

Reimplemented from wsf::UCI_PartComponent.

References wsf::UCI_Component::CanHandleMessage(), wsf::UCI_PartComponent::GetApprovalType(), WsfComponentT< WsfPlatform >::GetComponentParent(), WsfObject::GetName(), wsf::UCI_PartComponent::PrintMessageNotSent(), wsf::UCI_PartComponent::PrintMessageSent(), and WsfPlatformPart::SendMessage().

◆ SendControlStatusMessage()

void wsf::UCI_SensorComponent::SendControlStatusMessage	(	double	aSimTime,
		const uci::type::MessageStateEnum::EnumerationItem &	aMessageState )

protectedvirtual

Sends ControlStatusMessages. These messages describe the state of who has the ability to command or control the sensor

Reimplemented from wsf::UCI_PartComponent.

References wsf::UCI_Component::CanHandleMessage(), WsfObject::GetName(), wsf::UCI_PartComponent::mControlStatusMessagePtr, wsf::UCI_PartComponent::PrintMessageNotSent(), wsf::UCI_PartComponent::PrintMessageSent(), and WsfPlatformPart::SendMessage().

◆ SendEntityMessage()

void wsf::UCI_SensorComponent::SendEntityMessage	(	double	aSimTime,
		const WsfTrack &	aTrack,
		const uci::type::MessageStateEnum::EnumerationItem &	aMessageState,
		const uci::type::EntitySourceEnum::EnumerationItem &	aSourceType )

protected

Sends Entity messages based on WsfTrack data. Data includes: track creation time, source and kinematic information, and, if applicable, IFF, pulse, pulsewidth, and frequency data.

Parameters

aSimTime	The current simulation time
aTrack	The track of the entity being described in this message
aMessageState	The message state of the message (UCI_NEW/UCI_UPDATE)
aSourceType	The source of the message

References wsf::UCI_Component::CanHandleMessage(), WsfComponentT< WsfPlatform >::GetComponentParent(), wsf::UCI_Component::GetInterface(), UCI_Util::GetKinematics(), WsfObject::GetName(), WsfTrack::GetSignalList(), wsf::UCI_Component::GetSimulation(), UCI_Util::GetStandardIdentity(), UCI_Util::GetTimeStamp(), WsfTrack::GetTrackId(), WsfTrack::GetUpdateTime(), mSensorPtr, mUUID_ToModeIndex, wsf::UCI_PartComponent::PrintMessageNotSent(), wsf::UCI_PartComponent::PrintMessageSent(), and WsfPlatformPart::SendMessage().

Referenced by wsf::UCI_AMTI_Component::OnSensorTrackInitiated(), wsf::UCI_ESM_Component::OnSensorTrackInitiated(), wsf::UCI_IRST_Component::OnSensorTrackInitiated(), wsf::UCI_AMTI_Component::OnSensorTrackUpdated(), wsf::UCI_ESM_Component::OnSensorTrackUpdated(), and wsf::UCI_IRST_Component::OnSensorTrackUpdated().

◆ SensorModeActivated()

void wsf::UCI_SensorComponent::SensorModeActivated	(	double	aSimTime,
		WsfSensor *	aSensorPtr,
		WsfSensorMode *	aModePtr )

References wsf::UCI_PartComponent::mInitialMessagesSent, mSensorPtr, and UpdateAllMessages().

Referenced by Attach().

◆ SensorModeDeactivated()

void wsf::UCI_SensorComponent::SensorModeDeactivated	(	double	aSimTime,
		WsfSensor *	aSensorPtr,
		WsfSensorMode *	aModePtr )

References wsf::UCI_PartComponent::mInitialMessagesSent, mSensorPtr, wsf::UCI_PartComponent::SendActivityMessage(), wsf::UCI_PartComponent::SendCapabilityStatusMessage(), and UpdateAllMessages().

Referenced by Attach().

◆ SetAllCapabilitiesAvailability()

virtual void wsf::UCI_SensorComponent::SetAllCapabilitiesAvailability ( const uci::type::CapabilityAvailabilityEnum::EnumerationItem & aAvailability )

protectedpure virtual

Implements wsf::UCI_PartComponent.

Referenced by OnSensorTurnedOff(), and OnSensorTurnedOn().