WsfXIO_ModedPartInfo Class Reference

Contains information about a part which contains modes (sensor). More...

#include <WsfXIO_ObjectInfo.hpp>

Inheritance diagram for WsfXIO_ModedPartInfo:

Collaboration diagram for WsfXIO_ModedPartInfo:

Public Member Functions
	WsfXIO_ModedPartInfo (ObjectType aType)
template<typename T>
void	Serialize (T &aBuff)
void	UpdateFromStateChange (WsfXIO_PartStateChangePkt &aPkt) override
void	UpdateFromPartState (WsfXIO_PlatformPartStatePkt &aPkt) override
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
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

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
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
Protected Attributes inherited from WsfXIO_PlatformPartInfo
WsfXIO_PlatformInfo *	mPlatformPtr

Detailed Description

Contains information about a part which contains modes (sensor).

Constructor & Destructor Documentation

WsfXIO_ModedPartInfo()

WsfXIO_ModedPartInfo::WsfXIO_ModedPartInfo ( ObjectType aType )

inline

References WsfXIO_ArticulatedPartInfo::WsfXIO_ArticulatedPartInfo().

Referenced by WsfXIO_SensorInfo::WsfXIO_SensorInfo(), and WsfXIO_WeaponInfo::WsfXIO_WeaponInfo().

Member Function Documentation

IsModeSelected()

bool WsfXIO_ModedPartInfo::IsModeSelected

(

WsfStringId

aModeName

)

References mSelectedModeNames.

SelectMode()

void WsfXIO_ModedPartInfo::SelectMode	(	bool	aSelect,
		WsfStringId	aModeId )

References WsfXIO_PartStateChangeRequestPkt::cDESELECT_MODE, WsfXIO_PlatformPartInfo::GetName(), WsfXIO_PlatformPartInfo::GetPartType(), WsfXIO_PlatformPartInfo::GetPlatformIndex(), WsfXIO_PartStateChangeRequestPkt::mPartName, WsfXIO_PartStateChangeRequestPkt::mPartType, WsfXIO_PartStateChangeRequestPkt::mPlatformIndex, WsfXIO_PlatformPartInfo::mPlatformPtr, WsfXIO_PartStateChangeRequestPkt::mSelectMode, and WsfXIO_PartStateChangeRequestPkt::mStateChange.

Serialize()

template<typename T>

void WsfXIO_ModedPartInfo::Serialize ( T & aBuff )

inline

References mCurrentModeName, mModeNames, mSelectedModeNames, and WsfXIO_ArticulatedPartInfo::Serialize().

Referenced by WsfXIO_SensorInfo::Serialize(), and WsfXIO_WeaponInfo::Serialize().

UpdateFromPartState()

void WsfXIO_ModedPartInfo::UpdateFromPartState ( WsfXIO_PlatformPartStatePkt & aPkt )

overridevirtual

Reimplemented from WsfXIO_ArticulatedPartInfo.

Reimplemented in WsfXIO_SensorInfo, and WsfXIO_WeaponInfo.

References WsfXIO_ArticulatedPartInfo::UpdateFromPartState().

Referenced by WsfXIO_SensorInfo::UpdateFromPartState(), and WsfXIO_WeaponInfo::UpdateFromPartState().

UpdateFromStateChange()

void WsfXIO_ModedPartInfo::UpdateFromStateChange ( WsfXIO_PartStateChangePkt & aPkt )

overridevirtual

Reimplemented from WsfXIO_ArticulatedPartInfo.

Reimplemented in WsfXIO_SensorInfo, and WsfXIO_WeaponInfo.

References mCurrentModeName, WsfXIO_PartStateChangePkt::mCurrentModeName, mSelectedModeNames, WsfXIO_PartStateChangePkt::mSelectedModes, and WsfXIO_ArticulatedPartInfo::UpdateFromStateChange().

Referenced by WsfXIO_SensorInfo::UpdateFromStateChange(), and WsfXIO_WeaponInfo::UpdateFromStateChange().

Member Data Documentation

mCurrentModeName

WsfStringId WsfXIO_ModedPartInfo::mCurrentModeName

Referenced by WsfXIO_SensorInfo::GetCurrentMode(), Serialize(), and UpdateFromStateChange().

mModeNames

std::vector<WsfStringId> WsfXIO_ModedPartInfo::mModeNames

Referenced by Serialize().

mSelectedModeNames

std::vector<WsfStringId> WsfXIO_ModedPartInfo::mSelectedModeNames

Referenced by IsModeSelected(), Serialize(), and UpdateFromStateChange().

---

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

• WsfXIO_ObjectInfo.hpp
• WsfXIO_ObjectInfo.cpp