#include <WsfUCI_PartComponent.hpp>

Inheritance diagram for wsf::UCI_PartComponent:

[legend]

Collaboration diagram for wsf::UCI_PartComponent:

[legend]

Classes
struct	Controller

Definitions to support templated component methods.
static const int	cWSF_COMPONENT_UCI_PART = 1234321
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
	UCI_PartComponent ()=delete
	UCI_PartComponent (const WsfScenario &aScenario, int aPartType)
	UCI_PartComponent (const UCI_PartComponent &aSrc)
virtual	~UCI_PartComponent ()=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	Initialize2 (double aSimTime) override
const int *	GetComponentRoles () const override
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
bool	IsCommandAccepted () const
virtual void	SetOwnerProducer (const ISM_OwnerProducerType &aOwnerType)
virtual void	ClearActivities ()=0
virtual void	Detach ()
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	SendControlRequestStatusMessage (double aSimTime, const uci::type::ControlRequestID_Type &aRequestID)
virtual void	SendControlStatusMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState)
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
virtual void	UpdateAllMessages ()=0
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
virtual void	SetAllCapabilitiesAvailability (const uci::type::CapabilityAvailabilityEnum::EnumerationItem &aAvailability)=0
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)

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_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 bool	PreInitialize (double aSimTime)
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
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
	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::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_PartComponent() [1/3]

wsf::UCI_PartComponent::UCI_PartComponent ( )

delete

References UCI_PartComponent().

Referenced by UCI_PartComponent(), UCI_PartComponent(), wsf::UCI_SensorComponent::UCI_SensorComponent(), wsf::UCI_SensorComponent::UCI_SensorComponent(), wsf::UCI_WeaponComponent::UCI_WeaponComponent(), and wsf::UCI_WeaponComponent::UCI_WeaponComponent().

◆ UCI_PartComponent() [2/3]

wsf::UCI_PartComponent::UCI_PartComponent	(	const WsfScenario &	aScenario,
		int	aPartType )

References wsf::UCI_Component::UCI_Component().

◆ UCI_PartComponent() [3/3]

wsf::UCI_PartComponent::UCI_PartComponent ( const UCI_PartComponent & aSrc )

References mCapabilityToUUID, mUpdateMessageTime, wsf::UCI_Component::UCI_Component(), and UCI_PartComponent().

◆ ~UCI_PartComponent()

virtual wsf::UCI_PartComponent::~UCI_PartComponent ( )

virtualdefault

Member Function Documentation

◆ CheckPartStatus()

bool wsf::UCI_PartComponent::CheckPartStatus ( WsfArticulatedPart * aPartPtr )

protected

References WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), WsfPlatformPart::IsOperational(), WsfPlatformPart::IsTurnedOn(), mIsCommanded, SetRejectedCurrentlyCommanded(), and UpdateCommandResults().

Referenced by wsf::UCI_WeaponComponent::HandleCapabilityCommand().

◆ ClearActivities()

virtual void wsf::UCI_PartComponent::ClearActivities ( )

protectedpure virtual

Implemented in wsf::UCI_SensorComponent, and wsf::UCI_WeaponComponent.

◆ ClearRemarks()

void wsf::UCI_PartComponent::ClearRemarks ( )

inline

References mRemarks.

◆ Detach()

virtual void wsf::UCI_PartComponent::Detach ( )

inlineprotectedvirtual

Reimplemented in wsf::UCI_SensorComponent.

◆ GetApprovalType()

virtual uci::type::ApprovalEnum::EnumerationItem wsf::UCI_PartComponent::GetApprovalType ( ) const

inlineprotectedvirtual

References mApprovalType.

Referenced by SendControlRequestStatusMessage(), and wsf::UCI_SensorComponent::SendControlRequestStatusMessage().

◆ GetCapabilityAvailability()

template<typename CapabilityStatusMessage>

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

inlineprotected

References wsf::UCI_Component::CanHandleMessage().

◆ GetCapabilityUUIDs()

std::set< std::string > wsf::UCI_PartComponent::GetCapabilityUUIDs ( ) const

overridevirtual

Reimplemented from wsf::UCI_Component.

References mCapabilityToUUID.

◆ GetCommandState()

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

inline

References mCommandState.

Referenced by SendCommandStatusMessage().

◆ GetComponentRoles()

const int * wsf::UCI_PartComponent::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_Component.

Reimplemented in wsf::UCI_SensorComponent, and wsf::UCI_WeaponComponent.

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

◆ GetRemarks()

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

inline

References mRemarks.

Referenced by SendControlRequestStatusMessage().

◆ GetUpdateMessageTime()

double wsf::UCI_PartComponent::GetUpdateMessageTime ( ) const

inline

References mUpdateMessageTime.

Referenced by TurnOn().

◆ HandleControlRequestMessage()

bool wsf::UCI_PartComponent::HandleControlRequestMessage ( const UCI_ControlRequestMessage & aMessage )

protected

References wsf::UCI_Component::GetInterface(), wsf::UCI_Component::GetSimulation(), SendControlRequestStatusMessage(), and SendControlStatusMessage().

Referenced by ProcessMessage().

◆ HasControl()

bool wsf::UCI_PartComponent::HasControl	(	const std::string &	aCapbilityUUID,
		uci::type::ServiceID_Type &	aServiceID,
		uci::type::SystemID_Type &	aSystemID )

protected

References mManagerControllers, mPrimaryController, and mSecondaryControllers.

Referenced by wsf::UCI_WeaponComponent::HandleCommandMessage().

◆ Initialize2()

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

Reimplemented in wsf::UCI_SensorComponent, and wsf::UCI_WeaponComponent.

References wsf::UCI_Component::GetInterface(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), wsf::UCI_Component::Initialize2(), wsf::UCI_Component::IsActive(), mControlStatusMessagePtr, wsf::UCI_Component::mSubsystemLabel, mSubsystemStatusMessagePtr, wsf::UCI_Component::mSubsystemUUID, mSystemStatusMessagePtr, UCI_Util::RemoveAngleBrackets(), and UpdateAllMessages().

Referenced by wsf::UCI_SensorComponent::Initialize2(), and wsf::UCI_WeaponComponent::Initialize2().

◆ IsCommandAccepted()

bool wsf::UCI_PartComponent::IsCommandAccepted ( ) const

inlineprotected

References mCommandState.

Referenced by wsf::UCI_WeaponComponent::HandleCommandMessage().

◆ PrintMessageNotSent()

void wsf::UCI_PartComponent::PrintMessageNotSent	(	double	aSimTime,
		const std::string &	aMessageType,
		const std::string &	aReason )

protectedvirtual

References WsfPlatformPart::DebugEnabled().

Referenced by wsf::UCI_WeaponComponent::SendActivityMessage(), wsf::UCI_WeaponComponent::SendCapabilityMessage(), wsf::UCI_WeaponComponent::SendCapabilityStatusMessage(), SendControlRequestStatusMessage(), wsf::UCI_SensorComponent::SendControlRequestStatusMessage(), SendControlStatusMessage(), wsf::UCI_SensorComponent::SendControlStatusMessage(), and wsf::UCI_SensorComponent::SendEntityMessage().

◆ PrintMessageSent()

void wsf::UCI_PartComponent::PrintMessageSent	(	double	aSimTime,
		const std::string &	aMessageType )

protectedvirtual

References WsfPlatformPart::DebugEnabled().

Referenced by wsf::UCI_WeaponComponent::SendActivityMessage(), wsf::UCI_WeaponComponent::SendCapabilityMessage(), wsf::UCI_WeaponComponent::SendCapabilityStatusMessage(), SendCommandStatusMessage(), wsf::UCI_SensorComponent::SendCommandStatusMessage(), SendControlRequestStatusMessage(), wsf::UCI_SensorComponent::SendControlRequestStatusMessage(), SendControlStatusMessage(), wsf::UCI_SensorComponent::SendControlStatusMessage(), and wsf::UCI_SensorComponent::SendEntityMessage().

◆ ProcessInput()

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

Reimplemented in wsf::UCI_SensorComponent, and wsf::UCI_WeaponComponent.

References mUpdateMessageTime, and wsf::UCI_Component::ProcessInput().

Referenced by wsf::UCI_SensorComponent::ProcessInput(), and wsf::UCI_WeaponComponent::ProcessInput().

◆ ProcessMessage()

bool wsf::UCI_PartComponent::ProcessMessage	(	double	aSimTime,
		const WsfMessage &	aMessage )

overridevirtual

Process a received UCI message. Currently only handles Control Request Messages.

Parameters

aSimTime	The current simulation time
aMessage	The message being processed

Returns: Returns true if the message is a known type; otherwise returns false.

Reimplemented from WsfPlatformPart.

Reimplemented in wsf::UCI_IRST_Component.

References wsf::UCI_Component::CanHandleMessage(), WsfMessage::GetType(), and HandleControlRequestMessage().

◆ QueryInterface()

void * wsf::UCI_PartComponent::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_Component.

Reimplemented in wsf::UCI_SensorComponent, and wsf::UCI_WeaponComponent.

References cWSF_COMPONENT_UCI_PART, and wsf::UCI_Component::QueryInterface().

Referenced by wsf::UCI_SensorComponent::QueryInterface(), and wsf::UCI_WeaponComponent::QueryInterface().

◆ SendActivityMessage()

virtual void wsf::UCI_PartComponent::SendActivityMessage	(	double	aSimTime,
		const uci::type::MessageStateEnum::EnumerationItem &	aMessageState )

protectedpure virtual

Implemented in wsf::UCI_WeaponComponent.

Referenced by wsf::UCI_SensorComponent::OnSensorTurnedOff(), wsf::UCI_SensorComponent::OnSensorTurnedOn(), SendUpdateMessages(), wsf::UCI_SensorComponent::SensorModeDeactivated(), and wsf::UCI_SensorComponent::SlewComplete().

◆ SendCapabilityMessage()

virtual void wsf::UCI_PartComponent::SendCapabilityMessage	(	double	aSimTime,
		const uci::type::MessageStateEnum::EnumerationItem &	aMessageState )

protectedpure virtual

Implemented in wsf::UCI_WeaponComponent.

Referenced by SendUpdateMessages().

◆ SendCapabilityStatusMessage()

virtual void wsf::UCI_PartComponent::SendCapabilityStatusMessage	(	double	aSimTime,
		const uci::type::MessageStateEnum::EnumerationItem &	aMessageState )

protectedpure virtual

Implemented in wsf::UCI_WeaponComponent.

Referenced by wsf::UCI_SensorComponent::OnSensorTurnedOff(), wsf::UCI_SensorComponent::OnSensorTurnedOn(), SendUpdateMessages(), and wsf::UCI_SensorComponent::SensorModeDeactivated().

◆ SendCommandStatusMessage()

template<typename CommandStatusMessage, typename CommandID>

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

inlineprotected

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

Referenced by wsf::UCI_WeaponComponent::HandleCommandMessage().

◆ SendControlRequestStatusMessage()

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

protectedvirtual

Reimplemented in wsf::UCI_SensorComponent.

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

Referenced by HandleControlRequestMessage().

◆ SendControlStatusMessage()

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

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

Referenced by HandleControlRequestMessage(), and SendUpdateMessages().

◆ SendSubsystemStatusMessage()

void wsf::UCI_PartComponent::SendSubsystemStatusMessage	(	double	aSimTime,
		const uci::type::MessageStateEnum::EnumerationItem &	aMessageState )

protectedvirtual

References wsf::UCI_Component::CanHandleMessage(), WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), mSubsystemStatusMessagePtr, and WsfPlatformPart::SendMessage().

Referenced by wsf::UCI_SensorComponent::OnSensorTurnedOff(), wsf::UCI_SensorComponent::OnSensorTurnedOn(), and SendUpdateMessages().

◆ SendSystemStatusMessage()

void wsf::UCI_PartComponent::SendSystemStatusMessage	(	double	aSimTime,
		const uci::type::MessageStateEnum::EnumerationItem &	aMessageState )

protectedvirtual

References wsf::UCI_Component::CanHandleMessage(), WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), mSystemStatusMessagePtr, and WsfPlatformPart::SendMessage().

Referenced by wsf::UCI_SensorComponent::OnSensorTurnedOff(), wsf::UCI_SensorComponent::OnSensorTurnedOn(), and SendUpdateMessages().

◆ SendUpdateMessages()

void wsf::UCI_PartComponent::SendUpdateMessages	(	double	aSimTime,
		const uci::type::MessageStateEnum::EnumerationItem &	aMessageState )

virtual

References SendActivityMessage(), SendCapabilityMessage(), SendCapabilityStatusMessage(), SendControlStatusMessage(), SendSubsystemStatusMessage(), and SendSystemStatusMessage().

Referenced by TurnOn().

◆ SetAllCapabilitiesAvailability()

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

protectedpure virtual

Implemented in wsf::UCI_SensorComponent, and wsf::UCI_WeaponComponent.

◆ SetOwnerProducer()

void wsf::UCI_PartComponent::SetOwnerProducer ( const ISM_OwnerProducerType & aOwnerType )

protectedvirtual

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

References mControlStatusMessagePtr, mSubsystemStatusMessagePtr, and mSystemStatusMessagePtr.

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

◆ SetRejectedCurrentlyCommanded()

void wsf::UCI_PartComponent::SetRejectedCurrentlyCommanded ( const std::string & aPartName )

protected

References WsfPlatformPart::DebugEnabled(), and UpdateCommandResults().

Referenced by CheckPartStatus().

◆ SetUpdateMessageTime()

void wsf::UCI_PartComponent::SetUpdateMessageTime ( double aUpdateTime )

inline

References mUpdateMessageTime.

◆ TurnOff()

void wsf::UCI_PartComponent::TurnOff ( double aSimTime )

overrideprotectedvirtual

Turn off the platform part (system).

Parameters

aSimTime The current simulation time.

Reimplemented from WsfPlatformPart.

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

◆ TurnOn()

void wsf::UCI_PartComponent::TurnOn ( double aSimTime )

overrideprotectedvirtual

Turn on the platform part (system).

Parameters

aSimTime The current simulation time.

Reimplemented from WsfPlatformPart.

References WsfPlatformPart::CanBeTurnedOn(), WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), wsf::UCI_Component::GetSimulation(), GetUpdateMessageTime(), mInitialMessagesSent, SendUpdateMessages(), and WsfPlatformPart::TurnOn().

◆ UpdateAllMessages()

virtual void wsf::UCI_PartComponent::UpdateAllMessages ( )

protectedpure virtual

Implemented in wsf::UCI_SensorComponent, and wsf::UCI_WeaponComponent.

Referenced by Initialize2().

◆ UpdateCapabilityStatusMessage()

template<typename CapabilityStatusMessage>

void wsf::UCI_PartComponent::UpdateCapabilityStatusMessage ( CapabilityStatusMessage * aMessagePtr )

inlineprotected

References wsf::UCI_Component::CanHandleMessage().

◆ UpdateCommandResults()

void wsf::UCI_PartComponent::UpdateCommandResults	(	const uci::type::CommandStateEnum::EnumerationItem &	aState,
		const std::string &	aRemark )

inline

References mCommandState, and mRemarks.

Referenced by CheckPartStatus(), wsf::UCI_WeaponComponent::HandleActivityCommand(), wsf::UCI_WeaponComponent::HandleCapabilityCommand(), and SetRejectedCurrentlyCommanded().

◆ UpdateSubsystemStatusMessage()

void wsf::UCI_PartComponent::UpdateSubsystemStatusMessage ( uci::type::SubsystemStateEnum::EnumerationItem aState )

protected

References mSubsystemStatusMessagePtr.

Referenced by wsf::UCI_SensorComponent::UpdateAllMessages(), and wsf::UCI_WeaponComponent::UpdateAllMessages().

Member Data Documentation

◆ cWSF_COMPONENT_UCI_PART

const int wsf::UCI_PartComponent::cWSF_COMPONENT_UCI_PART = 1234321

static

Referenced by GetComponentRoles(), wsf::UCI_SensorComponent::GetComponentRoles(), wsf::UCI_WeaponComponent::GetComponentRoles(), and QueryInterface().

◆ mActivityToCabability

std::map<std::string, std::string> wsf::UCI_PartComponent::mActivityToCabability

protected

Referenced by wsf::UCI_WeaponComponent::HandleActivityCommand().

◆ mApprovalType

uci::type::ApprovalEnum::EnumerationItem wsf::UCI_PartComponent::mApprovalType

protected

Referenced by GetApprovalType().

◆ mCallbacks

UtCallbackHolder wsf::UCI_PartComponent::mCallbacks

protected

Referenced by wsf::UCI_WeaponComponent::Initialize2().

◆ mCapabilityToUUID

std::map<std::string, std::string> wsf::UCI_PartComponent::mCapabilityToUUID

protected

Referenced by GetCapabilityUUIDs(), wsf::UCI_WeaponComponent::HandleActivityCommand(), wsf::UCI_WeaponComponent::Initialize2(), wsf::UCI_SensorComponent::InitializeModeData(), wsf::UCI_SensorComponent::ProcessInput(), wsf::UCI_WeaponComponent::ProcessInput(), UCI_PartComponent(), wsf::UCI_WeaponComponent::UpdateCapabilityStatus(), and wsf::UCI_WeaponComponent::WeaponFiredCB().

◆ mCommandState

uci::type::CommandStateEnum::EnumerationItem wsf::UCI_PartComponent::mCommandState { uci::type::CommandStateEnum::UCI_ACCEPTED }

protected

Referenced by GetCommandState(), wsf::UCI_SensorComponent::GetCommandState(), IsCommandAccepted(), UpdateCommandResults(), and wsf::UCI_SensorComponent::UpdateCommandResults().

◆ mControlStatusMessagePtr

std::unique_ptr<UCI_ControlStatusMessage> wsf::UCI_PartComponent::mControlStatusMessagePtr

protected

Referenced by wsf::UCI_AMTI_Component::Initialize2(), wsf::UCI_ESM_Component::Initialize2(), wsf::UCI_IRST_Component::Initialize2(), Initialize2(), wsf::UCI_WeaponComponent::Initialize2(), wsf::UCI_SensorComponent::InitializeModeData(), SendControlStatusMessage(), wsf::UCI_SensorComponent::SendControlStatusMessage(), and SetOwnerProducer().

◆ mInitialMessagesSent

bool wsf::UCI_PartComponent::mInitialMessagesSent { false }

protected

Referenced by wsf::UCI_SensorComponent::SensorModeActivated(), wsf::UCI_SensorComponent::SensorModeDeactivated(), and TurnOn().

◆ mIsCommanded

bool wsf::UCI_PartComponent::mIsCommanded { false }

protected

Referenced by CheckPartStatus(), wsf::UCI_SensorComponent::OnSensorTurnedOff(), wsf::UCI_SensorComponent::OnSensorTurnedOn(), wsf::UCI_SensorComponent::SetCommandAccepted(), and wsf::UCI_SensorComponent::SlewComplete().

◆ mManagerControllers

std::map<std::string, std::set<Controller> > wsf::UCI_PartComponent::mManagerControllers

protected

Referenced by HasControl().

◆ mPrimaryController

std::map<std::string, Controller> wsf::UCI_PartComponent::mPrimaryController

protected

Referenced by HasControl(), wsf::UCI_WeaponComponent::Initialize2(), and wsf::UCI_SensorComponent::InitializeModeData().

◆ mRemarks

std::string wsf::UCI_PartComponent::mRemarks

protected

Referenced by ClearRemarks(), wsf::UCI_SensorComponent::ClearRemarks(), GetRemarks(), wsf::UCI_SensorComponent::GetRemarks(), UpdateCommandResults(), and wsf::UCI_SensorComponent::UpdateCommandResults().

◆ mSecondaryControllers

std::map<std::string, std::set<Controller> > wsf::UCI_PartComponent::mSecondaryControllers

protected

Referenced by HasControl().

◆ mSubsystemStatusMessagePtr

std::unique_ptr<UCI_SubsystemStatusMessage> wsf::UCI_PartComponent::mSubsystemStatusMessagePtr

protected

Referenced by wsf::UCI_AMTI_Component::Initialize2(), wsf::UCI_ESM_Component::Initialize2(), wsf::UCI_IRST_Component::Initialize2(), Initialize2(), wsf::UCI_SensorComponent::Initialize2(), wsf::UCI_WeaponComponent::Initialize2(), wsf::UCI_SensorComponent::InitializeModeData(), SendSubsystemStatusMessage(), SetOwnerProducer(), and UpdateSubsystemStatusMessage().

◆ mSystemStatusMessagePtr

std::unique_ptr<UCI_SystemStatusMessage> wsf::UCI_PartComponent::mSystemStatusMessagePtr

protected

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

◆ mUpdateMessageTime

double wsf::UCI_PartComponent::mUpdateMessageTime { 10 }

protected

Referenced by GetUpdateMessageTime(), wsf::UCI_SensorComponent::GetUpdateMessageTime(), ProcessInput(), SetUpdateMessageTime(), wsf::UCI_SensorComponent::SetUpdateMessageTime(), and UCI_PartComponent().

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

Classes

Definitions to support templated component methods.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UCI_PartComponent() [1/3]

◆ UCI_PartComponent() [2/3]

◆ UCI_PartComponent() [3/3]

◆ ~UCI_PartComponent()

Member Function Documentation

◆ CheckPartStatus()

◆ ClearActivities()

◆ ClearRemarks()

◆ Detach()

◆ GetApprovalType()

◆ GetCapabilityAvailability()

◆ GetCapabilityUUIDs()

◆ GetCommandState()

◆ GetComponentRoles()

◆ GetRemarks()

◆ GetUpdateMessageTime()

◆ HandleControlRequestMessage()

◆ HasControl()

◆ Initialize2()

◆ IsCommandAccepted()

◆ PrintMessageNotSent()

◆ PrintMessageSent()

◆ ProcessInput()

◆ ProcessMessage()

◆ QueryInterface()

◆ SendActivityMessage()

◆ SendCapabilityMessage()

◆ SendCapabilityStatusMessage()

◆ SendCommandStatusMessage()

◆ SendControlRequestStatusMessage()

◆ SendControlStatusMessage()

◆ SendSubsystemStatusMessage()

◆ SendSystemStatusMessage()

◆ SendUpdateMessages()

◆ SetAllCapabilitiesAvailability()

◆ SetOwnerProducer()

◆ SetRejectedCurrentlyCommanded()

◆ SetUpdateMessageTime()

◆ TurnOff()

◆ TurnOn()

◆ UpdateAllMessages()

◆ UpdateCapabilityStatusMessage()

◆ UpdateCommandResults()

◆ UpdateSubsystemStatusMessage()

Member Data Documentation

◆ cWSF_COMPONENT_UCI_PART

◆ mActivityToCabability

◆ mApprovalType

◆ mCallbacks

◆ mCapabilityToUUID

◆ mCommandState

◆ mControlStatusMessagePtr

◆ mInitialMessagesSent

◆ mIsCommanded

◆ mManagerControllers

◆ mPrimaryController

◆ mRemarks

◆ mSecondaryControllers

◆ mSubsystemStatusMessagePtr

◆ mSystemStatusMessagePtr

◆ mUpdateMessageTime