WSF
Public Member Functions | Public Attributes | Static Public Attributes | Protected Attributes | Friends | List of all members
WsfXIO_PlatformPartInfo Class Reference

#include <WsfXIO_ObjectInfo.hpp>

Inheritance diagram for WsfXIO_PlatformPartInfo:
Inheritance graph
[legend]
Collaboration diagram for WsfXIO_PlatformPartInfo:
Collaboration graph
[legend]

Public Member Functions

 WsfXIO_PlatformPartInfo (ObjectType aType=cPART_INFO_ID)
virtual ~WsfXIO_PlatformPartInfo ()
template<typename T>
void Serialize (T &aBuff)
void InitStateChange (WsfXIO_PartStateChangeRequestPkt &aPkt)
virtual void UpdateFromStateChange (WsfXIO_PartStateChangePkt &aPkt)
virtual void UpdateFromPartState (WsfXIO_PlatformPartStatePkt &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

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 = cPLATFORM_PART

Protected Attributes

WsfXIO_PlatformInfo * mPlatformPtr

Friends

class WsfXIO_RemotePlatformList
struct RequestStateChangeFunctor

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

Constructor & Destructor Documentation

◆ WsfXIO_PlatformPartInfo()

WsfXIO_PlatformPartInfo::WsfXIO_PlatformPartInfo ( ObjectType aType = cPART_INFO_ID)
inline

References cPART_INFO_ID, and WsfXIO_ObjectInfo::WsfXIO_ObjectInfo().

Referenced by WsfXIO_ArticulatedPartInfo::WsfXIO_ArticulatedPartInfo(), WsfXIO_MoverInfo::WsfXIO_MoverInfo(), and WsfXIO_ProcessorInfo::WsfXIO_ProcessorInfo().

◆ ~WsfXIO_PlatformPartInfo()

WsfXIO_PlatformPartInfo::~WsfXIO_PlatformPartInfo ( )
virtual

Member Function Documentation

◆ GetBasicType()

WsfStringId WsfXIO_PlatformPartInfo::GetBasicType ( ) const
inline

Most basic type of the platform part. ex: 'WSF_RADAR_SENSOR' or 'WSF_TASK_PROCESSOR'.

References mBasicType.

◆ GetInstantiationType()

WsfStringId WsfXIO_PlatformPartInfo::GetInstantiationType ( ) const
inline

TypeID of the platform part.

References mType.

◆ GetName()

WsfStringId WsfXIO_PlatformPartInfo::GetName ( ) const
inline

NameID of the platform part.

References mName.

Referenced by WsfXIO_WeaponInfo::FireSalvo(), WsfXIO_WeaponInfo::FireSalvo(), InitStateChange(), and WsfXIO_ModedPartInfo::SelectMode().

◆ GetPartType()

int WsfXIO_PlatformPartInfo::GetPartType ( ) const
inline

Type of platform part.

References mPartType.

Referenced by InitStateChange(), and WsfXIO_ModedPartInfo::SelectMode().

◆ GetPlatform()

WsfXIO_PlatformInfo * WsfXIO_PlatformPartInfo::GetPlatform ( ) const
inline

Get owning platform pointer.

References mPlatformPtr.

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

◆ GetPlatformIndex()

size_t WsfXIO_PlatformPartInfo::GetPlatformIndex ( ) const
inline

Index of the platform.

References mPlatformIndex.

Referenced by WsfXIO_WeaponInfo::FireSalvo(), WsfXIO_WeaponInfo::FireSalvo(), and WsfXIO_ModedPartInfo::SelectMode().

◆ InitStateChange()

void WsfXIO_PlatformPartInfo::InitStateChange ( WsfXIO_PartStateChangeRequestPkt & aPkt)

References GetName(), GetPartType(), WsfXIO_PartStateChangeRequestPkt::mPartName, WsfXIO_PartStateChangeRequestPkt::mPartType, WsfXIO_PartStateChangeRequestPkt::mPlatformIndex, mPlatformIndex, and WsfXIO_PartStateChangeRequestPkt::mStateChange.

◆ IsExternallyControlled()

bool WsfXIO_PlatformPartInfo::IsExternallyControlled ( ) const
inline

'true' if the platform part is externally controlled

References mIsExternallyControlled.

◆ IsOperational()

bool WsfXIO_PlatformPartInfo::IsOperational ( ) const
inline

'true' if the platform part is operational

References mIsOperational.

◆ IsTurnedOn()

bool WsfXIO_PlatformPartInfo::IsTurnedOn ( ) const
inline

'true' if the platform part is turned on

References mIsTurnedOn.

◆ Serialize()

template<typename T>
void WsfXIO_PlatformPartInfo::Serialize ( T & aBuff)
inline

References mBasicType, mDebugEnabled, mIsExternallyControlled, mIsOperational, mIsTurnedOn, mName, mPartType, mPlatformIndex, mType, and WsfXIO_ObjectInfo::Serialize().

Referenced by WsfXIO_ArticulatedPartInfo::Serialize(), WsfXIO_MoverInfo::Serialize(), and WsfXIO_ProcessorInfo::Serialize().

◆ SetDebugEnabled()

void WsfXIO_PlatformPartInfo::SetDebugEnabled ( bool aEnabled)

Change debug state.

References WsfXIO_PartStateChangeRequestPkt::cTURN_DEBUG_OFF, WsfXIO_PartStateChangeRequestPkt::cTURN_DEBUG_ON, and mDebugEnabled.

◆ SetPlatformPtr()

void WsfXIO_PlatformPartInfo::SetPlatformPtr ( WsfXIO_PlatformInfo * aPlatformPtr)
inline

Set owning platform pointer. Use with caution.

References mPlatformPtr.

◆ SetTurnedOnFlag()

void WsfXIO_PlatformPartInfo::SetTurnedOnFlag ( const bool aTurnedOn)
inline

References mIsTurnedOn.

◆ TurnOff()

void WsfXIO_PlatformPartInfo::TurnOff ( )

Notify the platform host to turn this platform part off.

References TurnOn().

◆ TurnOn()

void WsfXIO_PlatformPartInfo::TurnOn ( bool aTurnOn = true)

Notify the platform host to turn this platform part on.

References WsfXIO_PartStateChangeRequestPkt::cTURN_OFF, WsfXIO_PartStateChangeRequestPkt::cTURN_ON, and mIsTurnedOn.

Referenced by TurnOff().

◆ UpdateFromPartState()

void WsfXIO_PlatformPartInfo::UpdateFromPartState ( WsfXIO_PlatformPartStatePkt & aPkt)
virtual

Reimplemented in WsfXIO_ArticulatedPartInfo, WsfXIO_ModedPartInfo, WsfXIO_SensorInfo, and WsfXIO_WeaponInfo.

References mIsExternallyControlled, and WsfXIO_PlatformPartStatePkt::mIsExternallyControlled.

Referenced by WsfXIO_ArticulatedPartInfo::UpdateFromPartState().

◆ UpdateFromStateChange()

void WsfXIO_PlatformPartInfo::UpdateFromStateChange ( WsfXIO_PartStateChangePkt & aPkt)
virtual

Reimplemented in WsfXIO_ArticulatedPartInfo, WsfXIO_ModedPartInfo, WsfXIO_SensorInfo, and WsfXIO_WeaponInfo.

References WsfXIO_PartStateChangePkt::mIsTurnedOn, and mIsTurnedOn.

Referenced by WsfXIO_ArticulatedPartInfo::UpdateFromStateChange().

◆ RequestStateChangeFunctor

friend struct RequestStateChangeFunctor
friend

References RequestStateChangeFunctor.

Referenced by RequestStateChangeFunctor.

◆ WsfXIO_RemotePlatformList

friend class WsfXIO_RemotePlatformList
friend

References WsfXIO_RemotePlatformList.

Referenced by WsfXIO_RemotePlatformList.

Member Data Documentation

◆ cPART_INFO_ID

const ObjectType WsfXIO_PlatformPartInfo::cPART_INFO_ID = cPLATFORM_PART
static

Referenced by WsfXIO_PlatformPartInfo().

◆ mBasicType

WsfStringId WsfXIO_PlatformPartInfo::mBasicType

Referenced by GetBasicType(), WsfXIO_ObjectInfoLoad::Load_PlatformPart(), and Serialize().

◆ mDebugEnabled

bool WsfXIO_PlatformPartInfo::mDebugEnabled

Referenced by WsfXIO_ObjectInfoLoad::Load_PlatformPart(), Serialize(), and SetDebugEnabled().

◆ mIsExternallyControlled

bool WsfXIO_PlatformPartInfo::mIsExternallyControlled

Referenced by IsExternallyControlled(), WsfXIO_ObjectInfoLoad::Load_PlatformPart(), Serialize(), and UpdateFromPartState().

◆ mIsOperational

bool WsfXIO_PlatformPartInfo::mIsOperational

Referenced by IsOperational(), WsfXIO_ObjectInfoLoad::Load_PlatformPart(), and Serialize().

◆ mIsTurnedOn

bool WsfXIO_PlatformPartInfo::mIsTurnedOn

Referenced by IsTurnedOn(), WsfXIO_ObjectInfoLoad::Load_PlatformPart(), Serialize(), SetTurnedOnFlag(), TurnOn(), and UpdateFromStateChange().

◆ mName

WsfStringId WsfXIO_PlatformPartInfo::mName

Referenced by GetName(), WsfXIO_ObjectInfoLoad::Load_PlatformPart(), and Serialize().

◆ mPartType

int WsfXIO_PlatformPartInfo::mPartType

Referenced by GetPartType(), WsfXIO_ObjectInfoLoad::Load_Comm(), WsfXIO_ObjectInfoLoad::Load_Processor(), WsfXIO_ObjectInfoLoad::Load_Sensor(), and Serialize().

◆ mPlatformIndex

size_t WsfXIO_PlatformPartInfo::mPlatformIndex

Referenced by GetPlatformIndex(), InitStateChange(), WsfXIO_ObjectInfoLoad::Load_PlatformPart(), and Serialize().

◆ mPlatformPtr

WsfXIO_PlatformInfo* WsfXIO_PlatformPartInfo::mPlatformPtr
protected

Referenced by GetPlatform(), WsfXIO_ModedPartInfo::SelectMode(), and SetPlatformPtr().

◆ mType

WsfStringId WsfXIO_PlatformPartInfo::mType

Referenced by GetInstantiationType(), WsfXIO_ObjectInfoLoad::Load_PlatformPart(), and Serialize().

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved