WSF
WsfXIO_PlatformInfo Class Reference

#include <WsfXIO_ObjectInfo.hpp>

Inheritance diagram for WsfXIO_PlatformInfo:
Collaboration diagram for WsfXIO_PlatformInfo:

Public Types

enum  PlatformFlags { cEXTERNALLY_CONTROLLED = 1 }
using PlatformPartInfo = WsfXIO_PlatformPartInfo
using PartList = std::vector<WsfXIO_PlatformPartInfo*>
using CommandChain = std::pair<WsfStringId, WsfStringId>
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

Public Member Functions

 WsfXIO_PlatformInfo (ObjectType aType=cPART_INFO_ID)
virtual ~WsfXIO_PlatformInfo ()
bool operator== (const WsfXIO_PlatformInfo &aRhs) const
bool operator== (const WsfXIO_EntityId &aRhs) const
template<typename T>
void Serialize (T &aBuff)
void SetHostConnection (WsfXIO_Connection *aConnectionPtr)
WsfXIO_ConnectionGetHostConnection () const
int GetConnectionId () const
WsfXIO_PlatformId GetId () const
int32_t GetIndex () const
 Index if the platform is in the simulation.
WsfStringId GetName () const
 NameID of the platform or platform type.
WsfStringId GetType () const
 NameID of the base type of the platform.
WsfStringId GetIcon () const
 Platform icon.
WsfStringId GetSide () const
 SideID of the platform.
WsfStringId GetMarking () const
WsfSpatialDomain GetSpatialDomain () const
 Spatial domain of the platform.
void AddPart (WsfXIO_PlatformPartInfo *aPartPtr)
unsigned int GetPartCount () const
WsfXIO_PlatformPartInfoGetPartEntry (unsigned int aEntry) const
PartList::const_iterator BeginParts () const
PartList::const_iterator EndParts () const
PartList::iterator BeginParts ()
PartList::iterator EndParts ()
const PartListGetParts () const
WsfXIO_PlatformPartInfoFindPart (WsfStringId aPartName, int aType)
unsigned int GetZoneCount () const
 Returns the number of zones the platform uses.
std::vector< WsfXIO_Zone >::const_iterator BeginZones () const
 Returns begin index to the list of Zone names.
std::vector< WsfXIO_Zone >::const_iterator EndZones () const
bool UpdateState (double aSimTime)
void SetStateRefTime (double aBaseTime)
bool IsStateValid () const
const UtEntity & GetState () const
UtEntity & GetState ()
WsfXIO_EntityId GetEntityId () const
WsfXIO_EntityType GetEntityType () const
const WsfXIO_TrackManagerInfoGetTrackManagerInfo () const
WsfXIO_TrackManagerInfoGetTrackManagerInfo ()
const std::vector< CommandChain > & GetCommanders () const
WsfAttributeContainerGetAuxData () const
void RequestDelete ()
 Sends a request to delete this platform from the hosting simulation.
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

int32_t mIndex
int32_t mFlags
WsfStringId mName
WsfStringId mType
WsfStringId mIcon
WsfStringId mSide
WsfStringId mMarking
WsfSpatialDomain mSpatialDomain
std::vector< WsfXIO_PlatformPartInfo * > mParts
bool mStateValid
double mEntityStateBaseTime
UtEntity mEntityState
WsfXIO_EntityId mEntityId
WsfXIO_EntityType mEntityType
WsfXIO_TrackManagerInfo mTrackManagerInfo
std::vector< CommandChainmCommanders
std::vector< WsfXIO_ZonemZoneNames
WsfRoutemRoutePtr
int mTargetWaypointIndex
WsfXIO_MoverInfomMoverPtr
WsfAttributeContainermAuxDataPtr

Static Public Attributes

static const ObjectType cPART_INFO_ID = cPLATFORM

Member Typedef Documentation

◆ CommandChain

◆ PartList

◆ PlatformPartInfo

Member Enumeration Documentation

◆ PlatformFlags

Enumerator
cEXTERNALLY_CONTROLLED 

Constructor & Destructor Documentation

◆ WsfXIO_PlatformInfo()

◆ ~WsfXIO_PlatformInfo()

WsfXIO_PlatformInfo::~WsfXIO_PlatformInfo ( )
virtual

References mMoverPtr, and mParts.

Member Function Documentation

◆ AddPart()

void WsfXIO_PlatformInfo::AddPart ( WsfXIO_PlatformPartInfo * aPartPtr)
inline

References mParts.

◆ BeginParts() [1/2]

PartList::iterator WsfXIO_PlatformInfo::BeginParts ( )
inline

References mParts.

◆ BeginParts() [2/2]

PartList::const_iterator WsfXIO_PlatformInfo::BeginParts ( ) const
inline

References mParts.

◆ BeginZones()

std::vector< WsfXIO_Zone >::const_iterator WsfXIO_PlatformInfo::BeginZones ( ) const
inline

Returns begin index to the list of Zone names.

References mZoneNames.

◆ EndParts() [1/2]

PartList::iterator WsfXIO_PlatformInfo::EndParts ( )
inline

References mParts.

◆ EndParts() [2/2]

PartList::const_iterator WsfXIO_PlatformInfo::EndParts ( ) const
inline

References mParts.

◆ EndZones()

std::vector< WsfXIO_Zone >::const_iterator WsfXIO_PlatformInfo::EndZones ( ) const
inline

References mZoneNames.

◆ FindPart()

WsfXIO_PlatformPartInfo * WsfXIO_PlatformInfo::FindPart ( WsfStringId aPartName,
int aType )

References GetName(), and mParts.

◆ GetAuxData()

WsfAttributeContainer * WsfXIO_PlatformInfo::GetAuxData ( ) const
inline

References mAuxDataPtr.

◆ GetCommanders()

const std::vector< CommandChain > & WsfXIO_PlatformInfo::GetCommanders ( ) const
inline

References mCommanders.

◆ GetConnectionId()

int WsfXIO_PlatformInfo::GetConnectionId ( ) const
inline

◆ GetEntityId()

WsfXIO_EntityId WsfXIO_PlatformInfo::GetEntityId ( ) const
inline

References mEntityId.

◆ GetEntityType()

WsfXIO_EntityType WsfXIO_PlatformInfo::GetEntityType ( ) const
inline

References mEntityType.

◆ GetHostConnection()

◆ GetIcon()

WsfStringId WsfXIO_PlatformInfo::GetIcon ( ) const
inline

Platform icon.

References mIcon.

◆ GetId()

WsfXIO_PlatformId WsfXIO_PlatformInfo::GetId ( ) const
inline

References mIndex.

◆ GetIndex()

int32_t WsfXIO_PlatformInfo::GetIndex ( ) const
inline

Index if the platform is in the simulation.

References mIndex.

◆ GetMarking()

WsfStringId WsfXIO_PlatformInfo::GetMarking ( ) const
inline

References mMarking.

◆ GetName()

WsfStringId WsfXIO_PlatformInfo::GetName ( ) const
inline

NameID of the platform or platform type.

References mName.

Referenced by FindPart().

◆ GetPartCount()

unsigned int WsfXIO_PlatformInfo::GetPartCount ( ) const
inline

References mParts.

◆ GetPartEntry()

WsfXIO_PlatformPartInfo * WsfXIO_PlatformInfo::GetPartEntry ( unsigned int aEntry) const
inline

References mParts.

◆ GetParts()

const PartList & WsfXIO_PlatformInfo::GetParts ( ) const
inline

References mParts.

◆ GetSide()

WsfStringId WsfXIO_PlatformInfo::GetSide ( ) const
inline

SideID of the platform.

References mSide.

◆ GetSpatialDomain()

WsfSpatialDomain WsfXIO_PlatformInfo::GetSpatialDomain ( ) const
inline

Spatial domain of the platform.

References mSpatialDomain.

◆ GetState() [1/2]

UtEntity & WsfXIO_PlatformInfo::GetState ( )
inline

References mEntityState.

◆ GetState() [2/2]

const UtEntity & WsfXIO_PlatformInfo::GetState ( ) const
inline

References mEntityState.

◆ GetTrackManagerInfo() [1/2]

WsfXIO_TrackManagerInfo & WsfXIO_PlatformInfo::GetTrackManagerInfo ( )
inline

References mTrackManagerInfo.

◆ GetTrackManagerInfo() [2/2]

const WsfXIO_TrackManagerInfo & WsfXIO_PlatformInfo::GetTrackManagerInfo ( ) const
inline

References mTrackManagerInfo.

◆ GetType()

WsfStringId WsfXIO_PlatformInfo::GetType ( ) const
inline

NameID of the base type of the platform.

References mType.

◆ GetZoneCount()

unsigned int WsfXIO_PlatformInfo::GetZoneCount ( ) const
inline

Returns the number of zones the platform uses.

References mZoneNames.

◆ IsStateValid()

bool WsfXIO_PlatformInfo::IsStateValid ( ) const
inline

References mEntityStateBaseTime.

◆ operator==() [1/2]

bool WsfXIO_PlatformInfo::operator== ( const WsfXIO_EntityId & aRhs) const

References mEntityId.

◆ operator==() [2/2]

bool WsfXIO_PlatformInfo::operator== ( const WsfXIO_PlatformInfo & aRhs) const

References mEntityId, and WsfXIO_PlatformInfo().

◆ RequestDelete()

void WsfXIO_PlatformInfo::RequestDelete ( )

Sends a request to delete this platform from the hosting simulation.

References GetHostConnection(), mIndex, WsfXIO_DeletePlatformPkt::mPlatformIndices, and WsfXIO_Connection::Send().

◆ Serialize()

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

◆ SetHostConnection()

void WsfXIO_PlatformInfo::SetHostConnection ( WsfXIO_Connection * aConnectionPtr)

◆ SetStateRefTime()

void WsfXIO_PlatformInfo::SetStateRefTime ( double aBaseTime)
inline

References mEntityStateBaseTime.

◆ UpdateState()

bool WsfXIO_PlatformInfo::UpdateState ( double aSimTime)

Member Data Documentation

◆ cPART_INFO_ID

const ObjectType WsfXIO_PlatformInfo::cPART_INFO_ID = cPLATFORM
static

Referenced by WsfXIO_PlatformInfo().

◆ mAuxDataPtr

◆ mCommanders

std::vector<CommandChain> WsfXIO_PlatformInfo::mCommanders

◆ mEntityId

◆ mEntityState

UtEntity WsfXIO_PlatformInfo::mEntityState

Referenced by GetState(), GetState(), and UpdateState().

◆ mEntityStateBaseTime

double WsfXIO_PlatformInfo::mEntityStateBaseTime

◆ mEntityType

◆ mFlags

int32_t WsfXIO_PlatformInfo::mFlags

◆ mIcon

WsfStringId WsfXIO_PlatformInfo::mIcon

◆ mIndex

int32_t WsfXIO_PlatformInfo::mIndex

◆ mMarking

WsfStringId WsfXIO_PlatformInfo::mMarking

◆ mMoverPtr

◆ mName

WsfStringId WsfXIO_PlatformInfo::mName

◆ mParts

◆ mRoutePtr

WsfRoute* WsfXIO_PlatformInfo::mRoutePtr

◆ mSide

WsfStringId WsfXIO_PlatformInfo::mSide

◆ mSpatialDomain

WsfSpatialDomain WsfXIO_PlatformInfo::mSpatialDomain

◆ mStateValid

bool WsfXIO_PlatformInfo::mStateValid

Referenced by WsfXIO_PlatformInfo().

◆ mTargetWaypointIndex

int WsfXIO_PlatformInfo::mTargetWaypointIndex

◆ mTrackManagerInfo

◆ mType

WsfStringId WsfXIO_PlatformInfo::mType

◆ mZoneNames

std::vector<WsfXIO_Zone> WsfXIO_PlatformInfo::mZoneNames

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