#include <WsfUCI_WeaponComponent.hpp>

Inheritance diagram for wsf::UCI_WeaponComponent:

[legend]

Collaboration diagram for wsf::UCI_WeaponComponent:

[legend]

Definitions to support templated component methods.
static const int	cWSF_COMPONENT_UCI_WEAPON = 9876543
std::unique_ptr< UCI_StrikeActivityMessage >	mActivityMessagePtr
std::unique_ptr< UCI_StrikeCapabilityMessage >	mCapabilityMessagePtr
std::unique_ptr< UCI_StrikeCapabilityStatusMessage >	mCapabilityStatusMessagePtr
std::map< unsigned int, UCI_StrikeActivityType >	mSerialToActivity
std::map< std::string, std::string >	mUUIDtoCapability
	UCI_WeaponComponent ()=delete
	UCI_WeaponComponent (const WsfScenario &aScenario)
	UCI_WeaponComponent (const UCI_WeaponComponent &aSrc)
virtual	~UCI_WeaponComponent ()=default
void *	QueryInterface (int aRole) override
bool	Initialize2 (double aSimTime) override
const int *	GetComponentRoles () const override
bool	ProcessInput (UtInput &aInput) override
WsfComponent *	CloneComponent () const override
WsfObject *	Clone () const
void	UpdateCapabilityStatus ()
virtual void	SetOwnerProducer (const ISM_OwnerProducerType &aOwnerType) override
std::string	GetCommandTypeString (uci::type::StrikeWeaponCommandType::StrikeWeaponCommandTypeChoice aType)
void	SetCommandAccepted (const uci::type::StrikeCapabilityCommandType &aCapabilityCommand, const WsfWeapon::FireResult &aResult)
bool	HandleCommandMessage (double aSimTime, const UCI_StrikeCommandMessage &aMessage)
bool	HandleCapabilityCommand (double aSimTime, const uci::type::StrikeCapabilityCommandType &aCapabilityCommand)
bool	HandleActivityCommand (double aSimTime, const uci::type::StrikeActivityCommandType &aActivityCommand)
bool	HandleDMPI_Message (double aSimTime, const UCI_DMPI_Message &aMessage)
bool	CommandWeapon (double aSimTime, const uci::type::StrikeCapabilityCommandType &aCapabilityCommand)
void	ClearActivities ()
void	SendActivityMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState) override
void	SendCapabilityMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState) override
void	SendCapabilityStatusMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState) override
void	SendDMPI_StatusMessage (double aSimTime, const uci::type::MessageStateEnum::EnumerationItem &aMessageState, const uci::type::DMPI_ID_Type &aDMPI_ID, const uci::type::DMPI_StoreStateEnum::EnumerationItem &aStoreState)
void	UpdateAllMessages ()
void	SetAllCapabilitiesAvailability (const uci::type::CapabilityAvailabilityEnum::EnumerationItem &aAvailability)
bool	ReceiveMessage (double aSimTime, const WsfMessage &aMessage) override
void	WeaponHitCB (double aSimTime, const WsfWeaponEngagement aEngagementPtr, WsfPlatform aTargetPlatformPt)
void	WeaponTerminatedCB (double aSimTime, const WsfWeaponEngagement *aEngagementPtr)
void	WeaponMissedCB (double aSimTime, const WsfWeaponEngagement aEngagementPtr, WsfPlatform aTargetPlatformPtr)
void	WeaponFiredCB (double aSimTime, const WsfWeaponEngagement aEngagementPtr, const WsfTrack aTargetPtr)

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 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
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_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	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)
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
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. The WeaponComponent handles all weapons on a platform, therefore should only have one instance on a platform.

Constructor & Destructor Documentation

◆ UCI_WeaponComponent() [1/3]

wsf::UCI_WeaponComponent::UCI_WeaponComponent ( )

delete

References UCI_WeaponComponent().

Referenced by Clone(), CloneComponent(), UCI_WeaponComponent(), and UCI_WeaponComponent().

◆ UCI_WeaponComponent() [2/3]

wsf::UCI_WeaponComponent::UCI_WeaponComponent ( const WsfScenario & aScenario )

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

◆ UCI_WeaponComponent() [3/3]

wsf::UCI_WeaponComponent::UCI_WeaponComponent ( const UCI_WeaponComponent & aSrc )

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

◆ ~UCI_WeaponComponent()

virtual wsf::UCI_WeaponComponent::~UCI_WeaponComponent ( )

virtualdefault

Member Function Documentation

◆ ClearActivities()

void wsf::UCI_WeaponComponent::ClearActivities ( )

inlineprotectedvirtual

Implements wsf::UCI_PartComponent.

References mActivityMessagePtr.

◆ Clone()

WsfObject * wsf::UCI_WeaponComponent::Clone ( ) const

inlinevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

References UCI_WeaponComponent().

◆ CloneComponent()

WsfComponent * wsf::UCI_WeaponComponent::CloneComponent ( ) const

overridevirtual

Clones a component. May return null if component does not support clone.

Implements WsfComponent.

References UCI_WeaponComponent().

◆ CommandWeapon()

bool wsf::UCI_WeaponComponent::CommandWeapon	(	double	aSimTime,
		const uci::type::StrikeCapabilityCommandType &	aCapabilityCommand )

protected

References WsfPlatformPart::DebugEnabled(), WsfWeaponEngagement::EnumToString(), GetCommandTypeString(), WsfComponentT< WsfPlatform >::GetComponentParent(), WsfWeaponEngagement::GetGeometryResult(), wsf::UCI_Component::GetInterface(), WsfPlatformPart::GetPlatform(), WsfWeaponEngagement::GetSerialNumber(), mActivityMessagePtr, WsfWeapon::FireResult::mEngagementPtr, mSerialToActivity, WsfWeapon::FireResult::mSuccess, mUUIDtoCapability, WsfWeapon::FireOptions::mWeaponPlatformName, and SendDMPI_StatusMessage().

Referenced by HandleCommandMessage().

◆ GetCommandTypeString()

std::string wsf::UCI_WeaponComponent::GetCommandTypeString ( uci::type::StrikeWeaponCommandType::StrikeWeaponCommandTypeChoice aType )

protected

Referenced by CommandWeapon().

◆ GetComponentRoles()

const int * wsf::UCI_WeaponComponent::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_WEAPON.

◆ HandleActivityCommand()

bool wsf::UCI_WeaponComponent::HandleActivityCommand	(	double	aSimTime,
		const uci::type::StrikeActivityCommandType &	aActivityCommand )

protected

References WsfPlatformPart::DebugEnabled(), wsf::UCI_PartComponent::mActivityToCabability, wsf::UCI_PartComponent::mCapabilityToUUID, and wsf::UCI_PartComponent::UpdateCommandResults().

Referenced by HandleCommandMessage().

◆ HandleCapabilityCommand()

bool wsf::UCI_WeaponComponent::HandleCapabilityCommand	(	double	aSimTime,
		const uci::type::StrikeCapabilityCommandType &	aCapabilityCommand )

protected

References wsf::UCI_PartComponent::CheckPartStatus(), WsfPlatformPart::DebugEnabled(), WsfPlatformPart::GetPlatform(), mUUIDtoCapability, and wsf::UCI_PartComponent::UpdateCommandResults().

Referenced by HandleCommandMessage().

◆ HandleCommandMessage()

bool wsf::UCI_WeaponComponent::HandleCommandMessage	(	double	aSimTime,
		const UCI_StrikeCommandMessage &	aMessage )

protected

References CommandWeapon(), HandleActivityCommand(), HandleCapabilityCommand(), wsf::UCI_PartComponent::HasControl(), wsf::UCI_PartComponent::IsCommandAccepted(), SendActivityMessage(), and wsf::UCI_PartComponent::SendCommandStatusMessage().

Referenced by ReceiveMessage().

◆ HandleDMPI_Message()

bool wsf::UCI_WeaponComponent::HandleDMPI_Message	(	double	aSimTime,
		const UCI_DMPI_Message &	aMessage )

protected

References wsf::UCI_Component::GetInterface(), and SendDMPI_StatusMessage().

Referenced by ReceiveMessage().

◆ Initialize2()

bool wsf::UCI_WeaponComponent::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 WsfComponentList::RoleIterator< T >::AtEnd(), WsfComponentT< WsfPlatform >::GetComponentParent(), wsf::UCI_Component::GetInterface(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), wsf::UCI_Component::GetSimulation(), wsf::UCI_PartComponent::Initialize2(), wsf::UCI_Component::IsActive(), mActivityMessagePtr, wsf::UCI_PartComponent::mCallbacks, mCapabilityMessagePtr, mCapabilityStatusMessagePtr, wsf::UCI_PartComponent::mCapabilityToUUID, wsf::UCI_PartComponent::mControlStatusMessagePtr, wsf::UCI_PartComponent::mPrimaryController, wsf::UCI_PartComponent::mSubsystemStatusMessagePtr, wsf::UCI_Component::mSubsystemUUID, wsf::UCI_PartComponent::mSystemStatusMessagePtr, mUUIDtoCapability, UCI_Util::RemoveAngleBrackets(), SetOwnerProducer(), WsfObserver::WeaponFired(), WeaponFiredCB(), WsfObserver::WeaponHit(), WeaponHitCB(), WsfObserver::WeaponMissed(), WeaponMissedCB(), WsfObserver::WeaponTerminated(), and WeaponTerminatedCB().

◆ ProcessInput()

bool wsf::UCI_WeaponComponent::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, and wsf::UCI_PartComponent::ProcessInput().

◆ QueryInterface()

void * wsf::UCI_WeaponComponent::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_WEAPON, and wsf::UCI_PartComponent::QueryInterface().

◆ ReceiveMessage()

bool wsf::UCI_WeaponComponent::ReceiveMessage	(	double	aSimTime,
		const WsfMessage &	aMessage )

overrideprotectedvirtual

Receive a message from another platform part (system). The default implementation simply calls ProcessMessage to process the received message.

Parameters

aSimTime	The current simulation time.
aMessage	The message that is being sent.

Returns: 'true' if the message was received or 'false' if not.

Note: A message is first received by ReceiveMessage which then calls ProcessMessage to process the message. A derived class ReceiveMessage method may choose to delay the message before calling ProcessMessage or may choose to ignore the message altogether.

Reimplemented from WsfPlatformPart.

References wsf::UCI_Component::CanHandleMessage(), WsfPlatformPart::DebugEnabled(), WsfObject::GetName(), WsfMessage::GetType(), HandleCommandMessage(), HandleDMPI_Message(), and WsfPlatformPart::ReceiveMessage().

◆ SendActivityMessage()

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

overrideprotectedvirtual

Implements wsf::UCI_PartComponent.

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

Referenced by HandleCommandMessage().

◆ SendCapabilityMessage()

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

overrideprotectedvirtual

Implements wsf::UCI_PartComponent.

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

◆ SendCapabilityStatusMessage()

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

overrideprotectedvirtual

Implements wsf::UCI_PartComponent.

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

◆ SendDMPI_StatusMessage()

void wsf::UCI_WeaponComponent::SendDMPI_StatusMessage	(	double	aSimTime,
		const uci::type::MessageStateEnum::EnumerationItem &	aMessageState,
		const uci::type::DMPI_ID_Type &	aDMPI_ID,
		const uci::type::DMPI_StoreStateEnum::EnumerationItem &	aStoreState )

protected

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

Referenced by CommandWeapon(), and HandleDMPI_Message().

◆ SetAllCapabilitiesAvailability()

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

inlineprotectedvirtual

Implements wsf::UCI_PartComponent.

◆ SetCommandAccepted()

void wsf::UCI_WeaponComponent::SetCommandAccepted	(	const uci::type::StrikeCapabilityCommandType &	aCapabilityCommand,
		const WsfWeapon::FireResult &	aResult )

protected

◆ SetOwnerProducer()

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

overrideprotectedvirtual

Reimplemented from wsf::UCI_PartComponent.

References mActivityMessagePtr, mCapabilityMessagePtr, mCapabilityStatusMessagePtr, and wsf::UCI_PartComponent::SetOwnerProducer().

Referenced by Initialize2().

◆ UpdateAllMessages()

void wsf::UCI_WeaponComponent::UpdateAllMessages ( )

protectedvirtual

Implements wsf::UCI_PartComponent.

References wsf::UCI_PartComponent::UpdateSubsystemStatusMessage().

◆ UpdateCapabilityStatus()

void wsf::UCI_WeaponComponent::UpdateCapabilityStatus ( )

protected

References WsfComponentList::RoleIterator< T >::AtEnd(), WsfPlatformPart::GetPlatform(), mCapabilityStatusMessagePtr, and wsf::UCI_PartComponent::mCapabilityToUUID.

Referenced by SendCapabilityStatusMessage().

◆ WeaponFiredCB()

void wsf::UCI_WeaponComponent::WeaponFiredCB	(	double	aSimTime,
		const WsfWeaponEngagement *	aEngagementPtr,
		const WsfTrack *	aTargetPtr )

protected

References WsfPlatformPart::GetPlatform(), WsfWeaponEngagement::GetWeaponSystemName(), and wsf::UCI_PartComponent::mCapabilityToUUID.

Referenced by Initialize2().

◆ WeaponHitCB()

void wsf::UCI_WeaponComponent::WeaponHitCB	(	double	aSimTime,
		const WsfWeaponEngagement *	aEngagementPtr,
		WsfPlatform *	aTargetPlatformPt )

protected

Referenced by Initialize2().

◆ WeaponMissedCB()

void wsf::UCI_WeaponComponent::WeaponMissedCB	(	double	aSimTime,
		const WsfWeaponEngagement *	aEngagementPtr,
		WsfPlatform *	aTargetPlatformPtr )

protected

Referenced by Initialize2().

◆ WeaponTerminatedCB()

void wsf::UCI_WeaponComponent::WeaponTerminatedCB	(	double	aSimTime,
		const WsfWeaponEngagement *	aEngagementPtr )

protected

Referenced by Initialize2().

Member Data Documentation

◆ cWSF_COMPONENT_UCI_WEAPON

const int wsf::UCI_WeaponComponent::cWSF_COMPONENT_UCI_WEAPON = 9876543

static

Referenced by GetComponentRoles(), QueryInterface(), and UCI_WeaponComponent().

◆ mActivityMessagePtr

std::unique_ptr<UCI_StrikeActivityMessage> wsf::UCI_WeaponComponent::mActivityMessagePtr

protected

Referenced by ClearActivities(), CommandWeapon(), Initialize2(), SendActivityMessage(), and SetOwnerProducer().

◆ mCapabilityMessagePtr

std::unique_ptr<UCI_StrikeCapabilityMessage> wsf::UCI_WeaponComponent::mCapabilityMessagePtr

protected

Referenced by Initialize2(), SendCapabilityMessage(), and SetOwnerProducer().

◆ mCapabilityStatusMessagePtr

std::unique_ptr<UCI_StrikeCapabilityStatusMessage> wsf::UCI_WeaponComponent::mCapabilityStatusMessagePtr

protected

Referenced by Initialize2(), SendCapabilityStatusMessage(), SetOwnerProducer(), and UpdateCapabilityStatus().

◆ mSerialToActivity

std::map<unsigned int, UCI_StrikeActivityType> wsf::UCI_WeaponComponent::mSerialToActivity

protected

Referenced by CommandWeapon().

◆ mUUIDtoCapability

std::map<std::string, std::string> wsf::UCI_WeaponComponent::mUUIDtoCapability

protected

Referenced by CommandWeapon(), HandleCapabilityCommand(), and Initialize2().

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

Definitions to support templated component methods.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UCI_WeaponComponent() [1/3]

◆ UCI_WeaponComponent() [2/3]

◆ UCI_WeaponComponent() [3/3]

◆ ~UCI_WeaponComponent()

Member Function Documentation

◆ ClearActivities()

◆ Clone()

◆ CloneComponent()

◆ CommandWeapon()

◆ GetCommandTypeString()

◆ GetComponentRoles()

◆ HandleActivityCommand()

◆ HandleCapabilityCommand()

◆ HandleCommandMessage()

◆ HandleDMPI_Message()

◆ Initialize2()

◆ ProcessInput()

◆ QueryInterface()

◆ ReceiveMessage()

◆ SendActivityMessage()

◆ SendCapabilityMessage()

◆ SendCapabilityStatusMessage()

◆ SendDMPI_StatusMessage()

◆ SetAllCapabilitiesAvailability()

◆ SetCommandAccepted()

◆ SetOwnerProducer()

◆ UpdateAllMessages()

◆ UpdateCapabilityStatus()

◆ WeaponFiredCB()

◆ WeaponHitCB()

◆ WeaponMissedCB()

◆ WeaponTerminatedCB()

Member Data Documentation

◆ cWSF_COMPONENT_UCI_WEAPON

◆ mActivityMessagePtr

◆ mCapabilityMessagePtr

◆ mCapabilityStatusMessagePtr

◆ mSerialToActivity

◆ mUUIDtoCapability