WsfXIO_WeaponInfo Class Reference

Provides information about a weapon. More...

#include <WsfXIO_WeaponObjectInfo.hpp>

Inheritance diagram for WsfXIO_WeaponInfo:

Collaboration diagram for WsfXIO_WeaponInfo:

Public Member Functions
	WsfXIO_WeaponInfo (ObjectType aType=cPART_INFO_ID)
template<typename T>
void	Serialize (T &aBuff)
void	UpdateFromStateChange (WsfXIO_PartStateChangePkt &aPkt) override
void	UpdateFromPartState (WsfXIO_PlatformPartStatePkt &aPkt) override
void	FireSalvo (const WsfTrackId &aTrackId, int aSalvoSize=1)
void	FireSalvo (WsfStringId aTargetNameId, int aSalvoSize=1)
Public Member Functions inherited from WsfXIO_ModedPartInfo
	WsfXIO_ModedPartInfo (ObjectType aType)
template<typename T>
void	Serialize (T &aBuff)
void	SelectMode (bool aSelect, WsfStringId aModeId)
bool	IsModeSelected (WsfStringId aModeName)
Public Member Functions inherited from WsfXIO_ArticulatedPartInfo
	WsfXIO_ArticulatedPartInfo (ObjectType aType=cPART_INFO_ID)
template<typename T>
void	Serialize (T &aBuff)
Public Member Functions inherited from WsfXIO_PlatformPartInfo
	WsfXIO_PlatformPartInfo (ObjectType aType=cPART_INFO_ID)
virtual	~WsfXIO_PlatformPartInfo ()
template<typename T>
void	Serialize (T &aBuff)
void	InitStateChange (WsfXIO_PartStateChangeRequestPkt &aPkt)
int	GetPartType () const
	Type of platform part.
size_t	GetPlatformIndex () const
	Index of the platform.
WsfStringId	GetName () const
	NameID of the platform part.
WsfStringId	GetInstantiationType () const
	TypeID of the platform part.
WsfStringId	GetBasicType () const
	Most basic type of the platform part. ex: 'WSF_RADAR_SENSOR' or 'WSF_TASK_PROCESSOR'.
bool	IsTurnedOn () const
	'true' if the platform part is turned on
void	TurnOn (bool aTurnOn=true)
	Notify the platform host to turn this platform part on.
void	TurnOff ()
	Notify the platform host to turn this platform part off.
void	SetDebugEnabled (bool aEnabled)
	Change debug state.
bool	IsOperational () const
	'true' if the platform part is operational
bool	IsExternallyControlled () const
	'true' if the platform part is externally controlled
void	SetPlatformPtr (WsfXIO_PlatformInfo *aPlatformPtr)
	Set owning platform pointer. Use with caution.
WsfXIO_PlatformInfo *	GetPlatform () const
	Get owning platform pointer.
void	SetTurnedOnFlag (const bool aTurnedOn)
Public Member Functions inherited from WsfXIO_ObjectInfo
	WsfXIO_ObjectInfo (ObjectType aObjectType)
bool	IsPlatform () const
bool	IsTrackManager () const
bool	IsPlatformPart () const
bool	IsArticulatedPart () const
bool	IsSensor () const
bool	IsComm () const
bool	IsProcessor () const
bool	IsMover () const
ObjectType	GetObjectType () const
template<typename T>
void	Serialize (T &aBuff)

Public Attributes
double	mQuantityRemaining
Public Attributes inherited from WsfXIO_ModedPartInfo
std::vector< WsfStringId >	mModeNames
std::vector< WsfStringId >	mSelectedModeNames
WsfStringId	mCurrentModeName
Public Attributes inherited from WsfXIO_ArticulatedPartInfo
double	mYaw
	Orientation of the articulated part.
double	mPitch
double	mRoll
double	mTilt
Public Attributes inherited from WsfXIO_PlatformPartInfo
int	mPartType
size_t	mPlatformIndex
WsfStringId	mName
WsfStringId	mType
WsfStringId	mBasicType
bool	mIsTurnedOn
bool	mIsOperational
bool	mIsExternallyControlled
bool	mDebugEnabled

Static Public Attributes
static const ObjectType	cPART_INFO_ID = cARTICULATED_PART | cWSF_COMPONENT_WEAPON
Static Public Attributes inherited from WsfXIO_ArticulatedPartInfo
static const ObjectType	cPART_INFO_ID = cARTICULATED_PART
Static Public Attributes inherited from WsfXIO_PlatformPartInfo
static const ObjectType	cPART_INFO_ID = cPLATFORM_PART

Additional Inherited Members
Public Types inherited from WsfXIO_ObjectInfo
enum	{   cPLATFORM_PART = 0x40000000 , cARTICULATED_PART = cPLATFORM_PART | 0x20000000 , cCOMPONENT_ROLE_MASK = 0x007fffff , cPART_TYPE_MASK = 0x607fffff ,   cDERIVED_TYPE_MASK = 0x1f800000 , cDERIVED_TYPE_BEGIN = 0x00800000 , cNO_OBJECT = 0 , cPLATFORM = cWSF_COMPONENT_PLATFORM ,   cTRACK_MANAGER = cWSF_COMPONENT_TRACK_MANAGER , cMOVER_PART = cPLATFORM_PART | cWSF_COMPONENT_MOVER , cCOMM_PART = cARTICULATED_PART | cWSF_COMPONENT_COMM , cPROCESSOR_PART = cPLATFORM_PART | cWSF_COMPONENT_PROCESSOR ,   cSENSOR_PART = cARTICULATED_PART | cWSF_COMPONENT_SENSOR }
using	ObjectType = int32_t
Protected Attributes inherited from WsfXIO_PlatformPartInfo
WsfXIO_PlatformInfo *	mPlatformPtr

Detailed Description

Provides information about a weapon.

Constructor & Destructor Documentation

WsfXIO_WeaponInfo()

WsfXIO_WeaponInfo::WsfXIO_WeaponInfo ( ObjectType aType = cPART_INFO_ID )

inline

References cPART_INFO_ID, and WsfXIO_ModedPartInfo::WsfXIO_ModedPartInfo().

Referenced by WsfXIO_ExplicitWeaponInfo::WsfXIO_ExplicitWeaponInfo(), and WsfXIO_JammerWeaponInfo::WsfXIO_JammerWeaponInfo().

Member Function Documentation

FireSalvo() [1/2]

void WsfXIO_WeaponInfo::FireSalvo	(	const WsfTrackId &	aTrackId,
		int	aSalvoSize = 1 )

References WsfXIO_PlatformInfo::GetHostConnection(), WsfXIO_PlatformPartInfo::GetName(), WsfXIO_PlatformPartInfo::GetPlatform(), WsfXIO_PlatformPartInfo::GetPlatformIndex(), WsfXIO_FireWeaponPkt::mPlatformIndex, WsfXIO_FireWeaponPkt::mSalvoSize, WsfXIO_FireWeaponPkt::mTrackId, WsfXIO_FireWeaponPkt::mTrackPtr, WsfXIO_FireWeaponPkt::mWeaponNameId, and WsfXIO_Connection::Send().

FireSalvo() [2/2]

void WsfXIO_WeaponInfo::FireSalvo	(	WsfStringId	aTargetNameId,
		int	aSalvoSize = 1 )

References WsfXIO_PlatformInfo::GetHostConnection(), WsfXIO_PlatformPartInfo::GetName(), WsfXIO_PlatformPartInfo::GetPlatform(), WsfXIO_PlatformPartInfo::GetPlatformIndex(), WsfXIO_FireWeaponPkt::mPlatformIndex, WsfXIO_FireWeaponPkt::mSalvoSize, WsfXIO_FireWeaponPkt::mTargetNameId, WsfXIO_FireWeaponPkt::mTrackPtr, WsfXIO_FireWeaponPkt::mWeaponNameId, and WsfXIO_Connection::Send().

Serialize()

template<typename T>

void WsfXIO_WeaponInfo::Serialize ( T & aBuff )

inline

References mQuantityRemaining, and WsfXIO_ModedPartInfo::Serialize().

Referenced by WsfXIO_ExplicitWeaponInfo::Serialize(), and WsfXIO_JammerWeaponInfo::Serialize().

UpdateFromPartState()

void WsfXIO_WeaponInfo::UpdateFromPartState ( WsfXIO_PlatformPartStatePkt & aPkt )

overridevirtual

Reimplemented from WsfXIO_ModedPartInfo.

References WsfXIO_ModedPartInfo::UpdateFromPartState().

UpdateFromStateChange()

void WsfXIO_WeaponInfo::UpdateFromStateChange ( WsfXIO_PartStateChangePkt & aPkt )

overridevirtual

Reimplemented from WsfXIO_ModedPartInfo.

References WsfXIO_PartStateChangePkt::mQuantityRemaining, mQuantityRemaining, and WsfXIO_ModedPartInfo::UpdateFromStateChange().

Member Data Documentation

cPART_INFO_ID

const ObjectType WsfXIO_WeaponInfo::cPART_INFO_ID = cARTICULATED_PART | cWSF_COMPONENT_WEAPON

static

Referenced by WsfXIO_WeaponInfo().

mQuantityRemaining

double WsfXIO_WeaponInfo::mQuantityRemaining

Referenced by Serialize(), and UpdateFromStateChange().

---

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

• WsfXIO_WeaponObjectInfo.hpp
• WsfXIO_WeaponObjectInfo.cpp