WSF
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
WsfExtData Class Reference

#include <WsfExtInterface.hpp>

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

Public Types

using Component = WsfExtInterfaceComponent
using ComponentList = WsfComponentListT<WsfExtInterfaceComponent>

Public Member Functions

 WsfExtData (WsfScenario &aScenario)
virtual ~WsfExtData ()
void AddComponent (Component *aComponentPtr)
const ComponentList & GetComponents () const
virtual bool ProcessInput (WsfScenario &aScenario, UtInput &aInput)
WsfExtEmission * GetEmission () const
bool ProcessDeadReckonInput (UtInput &aInput)
void ProcessEntityType (UtInput &aInput)
void ProcessRadioEntityType (UtInput &aInput)
void ProcessExternalEntity (UtInput &aInput)
void ProcessExternalType (UtInput &aInput)
bool ProcessEntityId (std::string aName, int aEntityId)
void ProcessEntityId (UtInput &aInput)
void WriteEntityTypes (WsfScenario &aScenario, std::ostream &aStream)
 Prints entity type mapping for each platform type.
void WriteEmitterTypes (WsfScenario &aScenario, std::ostream &aStream)
 Prints entity type mapping for each platform type.
bool GetEntityType (WsfStringId aObjectTypeId, WsfExtEntityType &aEntityType) const
bool GetRadioEntityType (WsfStringId aCommTypeId, WsfExtRadioEntityType &aEntityType) const
bool GetEntityType (const WsfObject *aObjectPtr, WsfExtEntityType &aEntityType) const
 Given an object, select a entity type.
int GetForceId (WsfStringId aSideId) const
 Return the force ID that corresponds to a given WSF side ID.
WsfStringId GetSideId (int aForceId) const
 Return the WSF side ID that corresponds to the given force ID.
void SelectEntityType (WsfPlatform *aPlatformPtr, WsfExtEntityType &aEntityType) const
 Given a platform, select an entity type.
WsfStringId GetStringId (const WsfExtEntityType &aEntityType) const
WsfStringId GetStringId (const WsfExtRadioEntityType &aEntityType) const
bool GetRadioEntityType (const wsf::comm::Comm *aCommPtr, WsfExtRadioEntityType &aEntityType) const
 Given an object, select a entity type.
bool CompleteLoad (WsfScenario &aScenario)

Static Public Member Functions

static void ReadEntityType (UtInput &aInput, WsfExtEntityType &aEntityType)
static void ReadEntityId (UtInput &aInput, WsfExtEntityId &aEntityId)
static void ReadRadioEntityType (UtInput &aInput, WsfExtRadioEntityType &aEntityType)
static void ConvertInputToEntityId (std::string &aInput, WsfExtEntityId &aEntityId)
static void ConvertInputToEntityType (std::string &aInput, WsfExtEntityType &aEntityType)
static void ConvertInputToRadioEntityType (std::string &aInput, WsfExtRadioEntityType &aEntityType)

Public Attributes

bool mAllPrivate
std::set< WsfStringId > mPrivateTypeId
std::set< WsfStringId > mPrivateNameId
WsfCategoryList mPrivateCategoryId
uint16_t mStartEntity
unsigned short mSiteId
unsigned short mApplicationId
double mDeferredConnectionTime
double mDeferredPDUSendTime
 Deferred time before any DIS PDUs can be sent.
bool mDebugDetonationEnabled
std::map< WsfStringId, double > mTargetPriority
WsfStringId mUnknownPlatformTypeId
std::map< WsfStringId, int > mSideIdToForceId
std::map< WsfStringId, WsfExtEntityType > mObjectTypeToEntityType
std::map< WsfExtEntityType, WsfStringId > mEntityTypeToObjectType
std::map< WsfStringId, WsfExtRadioEntityType > mCommTypeToRadioEntityType
std::map< WsfExtRadioEntityType, WsfStringId > mRadioEntityTypeToCommType
WsfExtEntityDeadReckonSetup mDR_Setup
std::bitset< 65536U > mPreassignedEntityIds
std::map< WsfStringId, uint16_t > mPlatformNameToEntityId
std::set< WsfExtEntityId > mExternalEntityIds
std::set< WsfExtEntityType > mExternalEntityTypes
WsfExtEmission * mEmissionPtr

Protected Attributes

ComponentList mComponents

Detailed Description

Ext Interface configuration data to be populated by ProcessInput and copied into WsfExtInterface upon creation

Member Typedef Documentation

◆ Component

using WsfExtData::Component = WsfExtInterfaceComponent

◆ ComponentList

using WsfExtData::ComponentList = WsfComponentListT<WsfExtInterfaceComponent>

Constructor & Destructor Documentation

◆ WsfExtData()

WsfExtData::WsfExtData ( WsfScenario & aScenario)

References mAllPrivate, mApplicationId, mDebugDetonationEnabled, mDeferredConnectionTime, mDeferredPDUSendTime, mEmissionPtr, mSiteId, mStartEntity, and mUnknownPlatformTypeId.

Referenced by WsfExtInterface::WsfExtInterface().

◆ ~WsfExtData()

WsfExtData::~WsfExtData ( )
virtual

References mEmissionPtr.

Member Function Documentation

◆ AddComponent()

void WsfExtData::AddComponent ( Component * aComponentPtr)
inline

References mComponents.

Referenced by WsfMilExtension::AddedToScenario().

◆ CompleteLoad()

bool WsfExtData::CompleteLoad ( WsfScenario & aScenario)

References mComponents.

◆ ConvertInputToEntityId()

void WsfExtData::ConvertInputToEntityId ( std::string & aInput,
WsfExtEntityId & aEntityId )
static

References WsfExtEntityId::SetApplication(), WsfExtEntityId::SetEntity(), and WsfExtEntityId::SetSite().

Referenced by WsfDisInterface::ReadEntityId(), and ReadEntityId().

◆ ConvertInputToEntityType()

void WsfExtData::ConvertInputToEntityType ( std::string & aInput,
WsfExtEntityType & aEntityType )
static

References WsfExtEntityType::mCategory, WsfExtEntityType::mCountry, WsfExtEntityType::mDomain, WsfExtEntityType::mEntityKind, WsfExtEntityType::mExtra, WsfExtEntityType::mSpecific, and WsfExtEntityType::mSubcategory.

Referenced by WsfDisInput::ProcessBlockInput(), WsfDisInterface::ReadEntityType(), and ReadEntityType().

◆ ConvertInputToRadioEntityType()

void WsfExtData::ConvertInputToRadioEntityType ( std::string & aInput,
WsfExtRadioEntityType & aEntityType )
static

References WsfExtRadioEntityType::mCategory, WsfExtRadioEntityType::mCountry, WsfExtRadioEntityType::mDomain, WsfExtRadioEntityType::mEntityKind, WsfExtRadioEntityType::mNomenclature, and WsfExtRadioEntityType::mNomenclatureVersion.

Referenced by ReadRadioEntityType().

◆ GetComponents()

const ComponentList & WsfExtData::GetComponents ( ) const
inline

References mComponents.

Referenced by WsfMilExtInterface::Find().

◆ GetEmission()

WsfExtEmission * WsfExtData::GetEmission ( ) const
inline

References mEmissionPtr.

Referenced by WsfDisEmission::GetExtEmission(), WsfDisInterface::SetBeamTypeAndFunction(), WsfDisInterface::UpdateBeamFromXmtr(), and WsfDisInterface::UpdateSystemFromSensor().

◆ GetEntityType() [1/2]

bool WsfExtData::GetEntityType ( const WsfObject * aObjectPtr,
WsfExtEntityType & aEntityType ) const

Given an object, select a entity type.

References WsfObject::GetTypeList(), and mObjectTypeToEntityType.

◆ GetEntityType() [2/2]

bool WsfExtData::GetEntityType ( WsfStringId aObjectTypeId,
WsfExtEntityType & aEntityType ) const

References mObjectTypeToEntityType.

Referenced by WsfDisWeaponEvents::DirectedEnergyWeaponFired(), SelectEntityType(), UT_DEFINE_SCRIPT_METHOD(), UT_DEFINE_SCRIPT_METHOD(), and WriteEntityTypes().

◆ GetForceId()

int WsfExtData::GetForceId ( WsfStringId aSideId) const

Return the force ID that corresponds to a given WSF side ID.

References mSideIdToForceId.

◆ GetRadioEntityType() [1/2]

bool WsfExtData::GetRadioEntityType ( const wsf::comm::Comm * aCommPtr,
WsfExtRadioEntityType & aEntityType ) const

Given an object, select a entity type.

References WsfObject::GetTypeList(), and mCommTypeToRadioEntityType.

◆ GetRadioEntityType() [2/2]

bool WsfExtData::GetRadioEntityType ( WsfStringId aCommTypeId,
WsfExtRadioEntityType & aEntityType ) const

References mCommTypeToRadioEntityType.

◆ GetSideId()

WsfStringId WsfExtData::GetSideId ( int aForceId) const

Return the WSF side ID that corresponds to the given force ID.

References mSideIdToForceId.

◆ GetStringId() [1/2]

WsfStringId WsfExtData::GetStringId ( const WsfExtEntityType & aEntityType) const

References mEntityTypeToObjectType.

Referenced by WsfDisDetonation::Process(), WsfDisResupplyOffer::Process(), WsfDisResupplyReceived::Process(), WsfDisServiceRequest::Process(), and WriteEntityTypes().

◆ GetStringId() [2/2]

WsfStringId WsfExtData::GetStringId ( const WsfExtRadioEntityType & aEntityType) const

References mRadioEntityTypeToCommType.

◆ ProcessDeadReckonInput()

bool WsfExtData::ProcessDeadReckonInput ( UtInput & aInput)

References mDR_Setup.

Referenced by ProcessInput().

◆ ProcessEntityId() [1/2]

bool WsfExtData::ProcessEntityId ( std::string aName,
int aEntityId )

References WsfExtInterface::cALL_ENTITIES, WsfExtInterface::cNO_ENTITY, WsfExtInterface::cRQST_ASSIGN_ID, mPlatformNameToEntityId, mPreassignedEntityIds, and ok.

Referenced by ProcessEntityId(), and ProcessInput().

◆ ProcessEntityId() [2/2]

void WsfExtData::ProcessEntityId ( UtInput & aInput)

References ok, and ProcessEntityId().

◆ ProcessEntityType()

void WsfExtData::ProcessEntityType ( UtInput & aInput)

References mEntityTypeToObjectType, mObjectTypeToEntityType, and ReadEntityType().

Referenced by ProcessInput(), and WsfMilExtInterface::ProcessInput().

◆ ProcessExternalEntity()

void WsfExtData::ProcessExternalEntity ( UtInput & aInput)

References mExternalEntityIds, and ReadEntityId().

Referenced by ProcessInput().

◆ ProcessExternalType()

void WsfExtData::ProcessExternalType ( UtInput & aInput)

References mExternalEntityTypes, and ReadEntityType().

Referenced by ProcessInput().

◆ ProcessInput()

bool WsfExtData::ProcessInput ( WsfScenario & aScenario,
UtInput & aInput )
virtual

References mAllPrivate, mApplicationId, mComponents, mDeferredConnectionTime, mDeferredPDUSendTime, mEmissionPtr, mPrivateCategoryId, mPrivateNameId, mPrivateTypeId, mSideIdToForceId, mSiteId, mStartEntity, mTargetPriority, mUnknownPlatformTypeId, ProcessDeadReckonInput(), ProcessEntityId(), ProcessEntityType(), ProcessExternalEntity(), ProcessExternalType(), ProcessRadioEntityType(), WriteEmitterTypes(), and WriteEntityTypes().

◆ ProcessRadioEntityType()

void WsfExtData::ProcessRadioEntityType ( UtInput & aInput)

References mCommTypeToRadioEntityType, mRadioEntityTypeToCommType, and ReadRadioEntityType().

Referenced by ProcessInput().

◆ ReadEntityId()

void WsfExtData::ReadEntityId ( UtInput & aInput,
WsfExtEntityId & aEntityId )
static

References ConvertInputToEntityId().

Referenced by ProcessExternalEntity().

◆ ReadEntityType()

void WsfExtData::ReadEntityType ( UtInput & aInput,
WsfExtEntityType & aEntityType )
static

Read a Entity Type from an input stream.

Parameters
aInputThe input stream
aEntityTypeThe value read from the stream.

References ConvertInputToEntityType().

Referenced by ProcessEntityType(), and ProcessExternalType().

◆ ReadRadioEntityType()

void WsfExtData::ReadRadioEntityType ( UtInput & aInput,
WsfExtRadioEntityType & aRadioEntityType )
static

Read a Radio Entity Type from an input stream.

Parameters
aInputThe input stream
aRadioEntityTypeThe value read from the stream.

References ConvertInputToRadioEntityType().

Referenced by ProcessRadioEntityType().

◆ SelectEntityType()

void WsfExtData::SelectEntityType ( WsfPlatform * aPlatformPtr,
WsfExtEntityType & aEntityType ) const

Given a platform, select an entity type.

References GetEntityType(), WsfPlatform::GetIconId(), and mObjectTypeToEntityType.

Referenced by WsfDisPlatform::WsfDisPlatform().

◆ WriteEmitterTypes()

void WsfExtData::WriteEmitterTypes ( WsfScenario & aScenario,
std::ostream & aStream )

Prints entity type mapping for each platform type.

References WsfObjectTypeList< T >::Find(), WsfSensorTypes::Get(), WsfObjectTypeListBase::GetTypeIds(), WsfSensor::IsClassActive(), WsfSensor::IsClassRadio(), mComponents, and mEmissionPtr.

Referenced by ProcessInput().

◆ WriteEntityTypes()

void WsfExtData::WriteEntityTypes ( WsfScenario & aScenario,
std::ostream & aStream )

Prints entity type mapping for each platform type.

References WsfObjectTypeList< T >::Find(), WsfPlatformTypes::Get(), GetEntityType(), GetStringId(), WsfObjectTypeListBase::GetTypeIds(), and platformPtr.

Referenced by ProcessInput().

Member Data Documentation

◆ mAllPrivate

bool WsfExtData::mAllPrivate

Referenced by WsfExtInterface::IsPrivate(), ProcessInput(), and WsfExtData().

◆ mApplicationId

unsigned short WsfExtData::mApplicationId

Referenced by WsfExtInterface::GetApplicationId(), ProcessInput(), and WsfExtData().

◆ mCommTypeToRadioEntityType

std::map<WsfStringId, WsfExtRadioEntityType> WsfExtData::mCommTypeToRadioEntityType

Referenced by GetRadioEntityType(), GetRadioEntityType(), and ProcessRadioEntityType().

◆ mComponents

ComponentList WsfExtData::mComponents
protected

Referenced by AddComponent(), CompleteLoad(), GetComponents(), ProcessInput(), and WriteEmitterTypes().

◆ mDebugDetonationEnabled

bool WsfExtData::mDebugDetonationEnabled

Referenced by WsfExtData().

◆ mDeferredConnectionTime

double WsfExtData::mDeferredConnectionTime

Referenced by WsfExtInterface::GetDeferredConnectionTime(), WsfExtInterface::PrepareExtension(), ProcessInput(), and WsfExtData().

◆ mDeferredPDUSendTime

double WsfExtData::mDeferredPDUSendTime

Deferred time before any DIS PDUs can be sent.

Referenced by WsfExtInterface::GetDeferredPDUSendTime(), ProcessInput(), and WsfExtData().

◆ mDR_Setup

WsfExtEntityDeadReckonSetup WsfExtData::mDR_Setup

Referenced by ProcessDeadReckonInput().

◆ mEmissionPtr

WsfExtEmission* WsfExtData::mEmissionPtr

Referenced by GetEmission(), ProcessInput(), WriteEmitterTypes(), WsfExtData(), WsfExtInterface::WsfExtInterface(), and ~WsfExtData().

◆ mEntityTypeToObjectType

std::map<WsfExtEntityType, WsfStringId> WsfExtData::mEntityTypeToObjectType

Referenced by WsfExtInterface::GetEntityTypeToObjectMap(), GetStringId(), ProcessEntityType(), and WsfExtInterface::SelectPlatformType().

◆ mExternalEntityIds

std::set<WsfExtEntityId> WsfExtData::mExternalEntityIds

Referenced by WsfExtInterface::IsEntityExternallyMoved(), and ProcessExternalEntity().

◆ mExternalEntityTypes

std::set<WsfExtEntityType> WsfExtData::mExternalEntityTypes

Referenced by WsfExtInterface::IsEntityExternallyMoved(), and ProcessExternalType().

◆ mObjectTypeToEntityType

std::map<WsfStringId, WsfExtEntityType> WsfExtData::mObjectTypeToEntityType

Referenced by GetEntityType(), GetEntityType(), WsfExtInterface::GetObjectToEntityTypeMap(), ProcessEntityType(), and SelectEntityType().

◆ mPlatformNameToEntityId

std::map<WsfStringId, uint16_t> WsfExtData::mPlatformNameToEntityId

Referenced by WsfExtInterface::PlatformNameToEntityId(), ProcessEntityId(), and WsfExtInterface::SelectEntityId().

◆ mPreassignedEntityIds

std::bitset<65536U> WsfExtData::mPreassignedEntityIds

Referenced by WsfExtInterface::PreassignedEntityIds(), ProcessEntityId(), WsfExtInterface::SelectEntityId(), and WsfExtInterface::WsfExtInterface().

◆ mPrivateCategoryId

WsfCategoryList WsfExtData::mPrivateCategoryId

Referenced by WsfExtInterface::GetPrivateCategoryId(), WsfExtInterface::IsPrivate(), and ProcessInput().

◆ mPrivateNameId

std::set<WsfStringId> WsfExtData::mPrivateNameId

Referenced by WsfExtInterface::GetPrivateNameId(), WsfExtInterface::IsPrivate(), and ProcessInput().

◆ mPrivateTypeId

std::set<WsfStringId> WsfExtData::mPrivateTypeId

Referenced by WsfExtInterface::AddPrivateType(), WsfExtInterface::GetPrivateTypeId(), WsfExtInterface::IsPrivate(), and ProcessInput().

◆ mRadioEntityTypeToCommType

std::map<WsfExtRadioEntityType, WsfStringId> WsfExtData::mRadioEntityTypeToCommType

Referenced by GetStringId(), and ProcessRadioEntityType().

◆ mSideIdToForceId

std::map<WsfStringId, int> WsfExtData::mSideIdToForceId

Referenced by GetForceId(), GetSideId(), WsfExtInterface::PrepareExtension(), and ProcessInput().

◆ mSiteId

unsigned short WsfExtData::mSiteId

Referenced by WsfExtInterface::GetSiteId(), ProcessInput(), and WsfExtData().

◆ mStartEntity

uint16_t WsfExtData::mStartEntity

Referenced by WsfExtInterface::PrepareExtension(), ProcessInput(), and WsfExtData().

◆ mTargetPriority

std::map<WsfStringId, double> WsfExtData::mTargetPriority

Referenced by ProcessInput().

◆ mUnknownPlatformTypeId

WsfStringId WsfExtData::mUnknownPlatformTypeId

Referenced by WsfExtInterface::GetUnknownPlatformTypeId(), ProcessInput(), WsfExtInterface::SelectPlatformType(), and WsfExtData().

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