WSF
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
WsfL16::Interface Class Reference

#include <Interface.hpp>

Inheritance diagram for WsfL16::Interface:
Inheritance graph
[legend]
Collaboration diagram for WsfL16::Interface:
Collaboration graph
[legend]

Public Member Functions

 Interface (InterfaceSetup &aScenario)
void AddedToSimulation () override
 ~Interface () override
bool Initialize () override
bool IncludeJ3xTrackDisEntityId ()
 Returns a boolean used to determine whether or not to include track DIS entity id inside J3.X messages.
void SendJMessage (double aSimTime, WsfPlatform &aSender, const Messages::InitialBase *aMessage)
void SendJMessage (double aSimTime, WsfPlatform &aSender, const Messages::InitialBase *aMessage, const SlotParameters &aSlotParameters)
void SendRawJMessage (double aSimTime, WsfPlatform *aSender, const char *aDataPtr, int aMessageBytes, int aNPG)
void SendUserDefinedJMessage (double aSimTime, WsfPlatform *aSender, unsigned short *aMessage, int aNPG, int aMessageBytes, int aLabel, int aSubLabel, int aNumMsgs)
void SendUserDefinedJMessage (double aSimTime, WsfPlatform *aSender, unsigned short *aMessage, const SlotParameters &aSlotParameters, int aMessageBytes, int aLabel, int aSubLabel, int aNumMsgs)
void FilterMessageSend (WsfPlatform &aSenderPlatform, int aLabel, int aSubLabel=-1)
void UnfilterMessageSend (WsfPlatform &aSenderPlatform, int aLabel, int aSubLabel=-1)
void FilterMessageSend (WsfPlatform *aSenderPlatform, int aLabel, int aSubLabel=-1)
void UnfilterMessageSend (WsfPlatform *aSenderPlatform, int aLabel, int aSubLabel=-1)
unsigned GetAirSpecificType (WsfStringId aPlatformTypeId)
unsigned GetLandSpecificType (WsfStringId aPlatformTypeId)
WsfStringId GetAirPlatformType (unsigned aAirSpecificTypeId)
WsfStringId GetLandPlatformType (unsigned aLandSpecificTypeId)
WsfDisInterface * GetDisInterface () const
Public Member Functions inherited from WsfSimulationExtension
 WsfSimulationExtension ()
 ~WsfSimulationExtension () override=default
WsfSimulation & GetSimulation () const
const WsfScenario & GetScenario () const
virtual bool PrepareExtension ()
virtual bool PlatformsInitialized ()
virtual void PendingStart ()
virtual void Start ()
virtual void Complete (double aSimTime)
Public Member Functions inherited from WsfExtension
virtual ~WsfExtension ()=default
const std::string & GetExtensionName () const
Public Member Functions inherited from WsfL16::InterfaceSetup
 InterfaceSetup (WsfScenario &aScenario)
bool ProcessInput (UtInput &aInput)
void PrintScriptUsage ()
 Scripting language.
void PrintScriptUsageRst ()
bool SetNPGTable (int aMsgType, int aNPG)
bool IsRequested () const

Static Public Member Functions

static int GetJ3xIdentityFromIFF (WsfTrack::IFF_Status aIFF_Status)
static void SetIFF_FromJ3xIdentity (WsfTrack &aTrack, int aJ3xIdentity)
static void __private_SetSim (WsfSimulationExtension &aExtension, WsfSimulation *aSimPtr)

Public Attributes

UtCallbackListN< void(double, const WsfL16::Messages::InitialBase &)> JMessageReceived
UtCallbackListN< void(const WsfL16::Messages::InitialBase &)> JMessageSent
Public Attributes inherited from WsfL16::InterfaceSetup
TdlHeaderType mHeaderType
TdlSwapType mSwapMethod
int mTSALevel
int mTimeSlotType
Messages::HeaderTDL100 mHeaderTDL100
Messages::WSF_HeaderTDL100 mWSF_HeaderTDL100
int mSlotOffset
Messages::HeaderTDL100 mTdlHeader
bool mIsRequested
bool mDebugEnabled
bool mSendPPLI
bool mFillWith31_7
bool mIgnoreInboundMessages
double mSecondsTillSimStartSinceJan1_1900
double mSecondsSinceMidnight
bool mIncludeJ3xTrackDEI
std::map< unsigned, WsfStringId > mAirPlatformTypes
std::map< WsfStringId, unsigned > mAirSpecificTypes
std::map< unsigned, WsfStringId > mLandPlatformTypes
std::map< WsfStringId, unsigned > mLandSpecificTypes
Interface_J11_Setup mInterface_J11_Setup
std::map< size_t, MessageFilter > mPlatformFilters
MessageFilter mGlobalFilters
std::set< std::pair< int, int > > mNPGTable
WsfScenario * mWsfSetupPtr

Provision to allow an external method to provide the track numbers for a weapon and controller.

This decouples the Link-16 interface from the services that are launching and controlling weapons.

using GetWeaponTrackNumbersFn
void SetWeaponTrackNumbersFunction (GetWeaponTrackNumbersFn aFunctionPtr)
void GetWeaponTrackNumbers (size_t aWeaponIndex, unsigned int &aWeaponTrackNumber, unsigned int &aControllerTrackNumber)
static WSF_L16_EXPORT WsfPlatform * GetControllerFromTrackNumber (WsfSimulation *aSimulationPtr, unsigned int aTrackNumber)
static WSF_L16_EXPORT void SetPlatformTrackNumber (WsfPlatform *aPlatformPtr, unsigned int aTrackNumber)

Additional Inherited Members

Public Types inherited from WsfL16::InterfaceSetup
enum  TdlHeaderType { cTDL_6 , cTDL_100 }
enum  TdlSwapType { cWSF , cTRAP_TOOL }
Protected Member Functions inherited from WsfExtension
void InitializeExtensionName (const std::string &aName)

Detailed Description

WsfL16::Interface is primarily an interface to DIS using the DisSignal PDU.

Member Typedef Documentation

◆ GetWeaponTrackNumbersFn

using WsfL16::Interface::GetWeaponTrackNumbersFn
Initial value:
void (*)(WsfSimulation& aSimulation,
size_t aWeaponIndex,
unsigned int& aWeaponTrackNumber,
unsigned int& aControllerTrackNumber)
WsfSimulationExtension::WsfSimulation
friend class WsfSimulation
Definition WsfSimulationExtension.hpp:43

Constructor & Destructor Documentation

◆ Interface()

WsfL16::Interface::Interface ( InterfaceSetup & aScenario)

References WsfL16::InterfaceSetup::InterfaceSetup(), WsfL16::InterfaceSetup::mIgnoreInboundMessages, and WsfL16::InterfaceSetup::mInterface_J11_Setup.

◆ ~Interface()

WsfL16::Interface::~Interface ( )
override

Member Function Documentation

◆ AddedToSimulation()

void WsfL16::Interface::AddedToSimulation ( )
overridevirtual

Called in response to WsfSimulation::RegisterExtension. The extension has now been registered in the simulation.

Reimplemented from WsfSimulationExtension.

References WsfSimulation::GetExtension(), and WsfSimulationExtension::GetSimulation().

◆ FilterMessageSend() [1/2]

void WsfL16::Interface::FilterMessageSend ( WsfPlatform & aSenderPlatform,
int aLabel,
int aSubLabel = -1 )

References WsfPlatform::GetIndex(), WsfL16::InterfaceSetup::MessageFilter::mFilteredMessageTypes, WsfL16::InterfaceSetup::MessageFilter::mFilteredSpecificTypes, and WsfL16::InterfaceSetup::mPlatformFilters.

◆ FilterMessageSend() [2/2]

void WsfL16::Interface::FilterMessageSend ( WsfPlatform * aSenderPlatform,
int aLabel,
int aSubLabel = -1 )

References WsfPlatform::GetIndex(), WsfL16::InterfaceSetup::MessageFilter::mFilteredMessageTypes, WsfL16::InterfaceSetup::MessageFilter::mFilteredSpecificTypes, and WsfL16::InterfaceSetup::mPlatformFilters.

◆ GetAirPlatformType()

WsfStringId WsfL16::Interface::GetAirPlatformType ( unsigned aAirSpecificTypeId)

References WsfL16::InterfaceSetup::mAirPlatformTypes.

◆ GetAirSpecificType()

unsigned WsfL16::Interface::GetAirSpecificType ( WsfStringId aPlatformTypeId)

References WsfL16::InterfaceSetup::mAirSpecificTypes.

◆ GetControllerFromTrackNumber()

WsfPlatform * WsfL16::Interface::GetControllerFromTrackNumber ( WsfSimulation * aSimulationPtr,
unsigned int aTrackNumber )
static

References WsfComponentList::RoleIterator< T >::AtEnd(), WsfL16::ComputerProcessor::Config(), WsfSimulation::GetPlatformCount(), WsfSimulation::GetPlatformEntry(), WsfObject::IsA_TypeOf(), WsfL16::ComputerProcessor::Configuration::mTrackNumber, platformPtr, and WsfSimulationExtension::WsfSimulation.

Referenced by WsfWeaponServer::SetCommander().

◆ GetDisInterface()

WsfDisInterface * WsfL16::Interface::GetDisInterface ( ) const
inline

◆ GetJ3xIdentityFromIFF()

int WsfL16::Interface::GetJ3xIdentityFromIFF ( WsfTrack::IFF_Status aIFF_Status)
static

References WsfTrack::cIFF_AMBIGUOUS, WsfTrack::cIFF_FOE, WsfTrack::cIFF_FRIEND, WsfTrack::cIFF_NEUTRAL, and WsfTrack::cIFF_UNKNOWN.

◆ GetLandPlatformType()

WsfStringId WsfL16::Interface::GetLandPlatformType ( unsigned aLandSpecificTypeId)

References WsfL16::InterfaceSetup::mLandPlatformTypes.

◆ GetLandSpecificType()

unsigned WsfL16::Interface::GetLandSpecificType ( WsfStringId aPlatformTypeId)

References WsfL16::InterfaceSetup::mLandSpecificTypes.

◆ GetWeaponTrackNumbers()

void WsfL16::Interface::GetWeaponTrackNumbers ( size_t aWeaponIndex,
unsigned int & aWeaponTrackNumber,
unsigned int & aControllerTrackNumber )

Attempt to get the track numbers for a weapon and its controller from an external provider of track numbers. This decouples the Link-16 interface from those interfaces that are launching and controlling weapons.

References WsfSimulationExtension::GetSimulation().

◆ IncludeJ3xTrackDisEntityId()

bool WsfL16::Interface::IncludeJ3xTrackDisEntityId ( )
inline

Returns a boolean used to determine whether or not to include track DIS entity id inside J3.X messages.

References WsfL16::InterfaceSetup::mIncludeJ3xTrackDEI.

◆ Initialize()

bool WsfL16::Interface::Initialize ( )
overridevirtual

Called in response to WsfSimulation::Initialize. This is called to allow the extension to perform any initialization that is required.

Note
The extension should not assume that another extension has been initialized unless it this extension has been registered as a dependency of the other extension.

Reimplemented from WsfSimulationExtension.

References WsfObserver::DisSignalReceived(), WsfSimulation::GetDateTime(), WsfDateTime::GetJulianDate(), WsfSimulationExtension::GetSimulation(), WsfDateTime::GetStartDate(), WsfDateTime::GetStartJulianDate(), WsfSimulationExtension::Initialize(), WsfObserver::MessageQueued(), WsfObserver::MessageTransmitEnded(), WsfObserver::MessageTransmitted(), WsfObserver::MessageTransmittedHeartbeat(), WsfL16::InterfaceSetup::mIsRequested, WsfL16::InterfaceSetup::mSecondsSinceMidnight, WsfL16::InterfaceSetup::mSecondsTillSimStartSinceJan1_1900, WsfL16::InterfaceSetup::mSlotOffset, WsfObserver::WeaponFired(), and WsfObserver::WeaponTerminated().

◆ SendJMessage() [1/2]

void WsfL16::Interface::SendJMessage ( double aSimTime,
WsfPlatform & aSender,
const Messages::InitialBase * aMessage )

References WsfL16::SlotParameters::mMSEC, WsfL16::SlotParameters::mNetNumber, WsfL16::SlotParameters::mNPG, WsfL16::InterfaceSetup::mNPGTable, WsfL16::SlotParameters::mSlotNumber, WsfL16::InterfaceSetup::mTimeSlotType, WsfL16::SlotParameters::mTSEC, and SendJMessage().

Referenced by SendJMessage().

◆ SendJMessage() [2/2]

void WsfL16::Interface::SendJMessage ( double aSimTime,
WsfPlatform & aSender,
const Messages::InitialBase * aMessage,
const SlotParameters & aSlotParameters )

References WsfComponentList::RoleIterator< T >::AtEnd(), WsfL16::InterfaceSetup::cTDL_100, WsfL16::InterfaceSetup::cWSF, WsfL16::Messages::MessageBitOutput::GetBitOffset(), wsf::comm::Comm::GetClassId(), WsfDisPlatform::GetEntityId(), WsfL16::Messages::InitialBase::GetHeader(), WsfPlatform::GetIndex(), WsfL16::InterfaceSetup::mDebugEnabled, WsfL16::InterfaceSetup::mFillWith31_7, WsfL16::InterfaceSetup::mHeaderTDL100, WsfL16::InterfaceSetup::mHeaderType, WsfL16::InterfaceSetup::mNPGTable, WsfL16::InterfaceSetup::mSwapMethod, WsfL16::InterfaceSetup::mTimeSlotType, WsfL16::Messages::Header::mTimeSlotType, WsfL16::InterfaceSetup::mWSF_HeaderTDL100, WsfL16::Messages::MessageBitOutput::Skip(), and WsfL16::Messages::InitialBase::WriteMessage().

◆ SendRawJMessage()

void WsfL16::Interface::SendRawJMessage ( double aSimTime,
WsfPlatform * aSender,
const char * aDataPtr,
int aMessageBytes,
int aNPG )

References WsfL16::InterfaceSetup::cTDL_100, WsfL16::InterfaceSetup::cWSF, WsfPlatform::GetIndex(), WsfL16::InterfaceSetup::mDebugEnabled, WsfL16::InterfaceSetup::mHeaderTDL100, WsfL16::InterfaceSetup::mHeaderType, WsfL16::SlotParameters::mMSEC, WsfL16::SlotParameters::mNetNumber, WsfL16::SlotParameters::mNPG, WsfL16::SlotParameters::mSlotNumber, WsfL16::InterfaceSetup::mSwapMethod, WsfL16::InterfaceSetup::mTimeSlotType, WsfL16::SlotParameters::mTSEC, and WsfL16::InterfaceSetup::mWSF_HeaderTDL100.

◆ SendUserDefinedJMessage() [1/2]

void WsfL16::Interface::SendUserDefinedJMessage ( double aSimTime,
WsfPlatform * aSender,
unsigned short * aMessage,
const SlotParameters & aSlotParameters,
int aMessageBytes,
int aLabel,
int aSubLabel,
int aNumMsgs )

References WsfL16::InterfaceSetup::cTDL_100, WsfL16::InterfaceSetup::cWSF, WsfDisPlatform::GetEntityId(), WsfPlatform::GetIndex(), WsfL16::InterfaceSetup::mDebugEnabled, WsfL16::InterfaceSetup::mHeaderTDL100, WsfL16::InterfaceSetup::mHeaderType, WsfL16::InterfaceSetup::mSwapMethod, and WsfL16::InterfaceSetup::mWSF_HeaderTDL100.

◆ SendUserDefinedJMessage() [2/2]

void WsfL16::Interface::SendUserDefinedJMessage ( double aSimTime,
WsfPlatform * aSender,
unsigned short * aMessage,
int aNPG,
int aMessageBytes,
int aLabel,
int aSubLabel,
int aNumMsgs )

References WsfL16::SlotParameters::mMSEC, WsfL16::SlotParameters::mNetNumber, WsfL16::SlotParameters::mNPG, WsfL16::SlotParameters::mSlotNumber, WsfL16::SlotParameters::mTSEC, and SendUserDefinedJMessage().

Referenced by SendUserDefinedJMessage().

◆ SetIFF_FromJ3xIdentity()

void WsfL16::Interface::SetIFF_FromJ3xIdentity ( WsfTrack & aTrack,
int aJ3xIdentity )
static

References WsfTrack::cIFF_AMBIGUOUS, WsfTrack::cIFF_FOE, WsfTrack::cIFF_FRIEND, WsfTrack::cIFF_NEUTRAL, and WsfTrack::SetIFF_Status().

◆ SetPlatformTrackNumber()

void WsfL16::Interface::SetPlatformTrackNumber ( WsfPlatform * aPlatformPtr,
unsigned int aTrackNumber )
static

References WsfComponentList::RoleIterator< T >::AtEnd(), WsfL16::ComputerProcessor::Config(), and WsfL16::ComputerProcessor::Configuration::mTrackNumber.

Referenced by WsfWeaponServer::ProcessCommand().

◆ SetWeaponTrackNumbersFunction()

void WsfL16::Interface::SetWeaponTrackNumbersFunction ( GetWeaponTrackNumbersFn aFunctionPtr)
inline

Referenced by WsfWeaponServer::Initialize().

◆ UnfilterMessageSend() [1/2]

void WsfL16::Interface::UnfilterMessageSend ( WsfPlatform & aSenderPlatform,
int aLabel,
int aSubLabel = -1 )

References WsfPlatform::GetIndex(), WsfL16::InterfaceSetup::MessageFilter::mFilteredMessageTypes, WsfL16::InterfaceSetup::MessageFilter::mFilteredSpecificTypes, and WsfL16::InterfaceSetup::mPlatformFilters.

◆ UnfilterMessageSend() [2/2]

void WsfL16::Interface::UnfilterMessageSend ( WsfPlatform * aSenderPlatform,
int aLabel,
int aSubLabel = -1 )

References WsfPlatform::GetIndex(), WsfL16::InterfaceSetup::MessageFilter::mFilteredMessageTypes, WsfL16::InterfaceSetup::MessageFilter::mFilteredSpecificTypes, and WsfL16::InterfaceSetup::mPlatformFilters.

Member Data Documentation

◆ JMessageReceived

UtCallbackListN<void(double, const WsfL16::Messages::InitialBase&)> WsfL16::Interface::JMessageReceived

◆ JMessageSent

UtCallbackListN<void(const WsfL16::Messages::InitialBase&)> WsfL16::Interface::JMessageSent
The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved