WsfEventPipeInterface Class Reference

#include <WsfEventPipeInterface.hpp>

Inheritance diagram for WsfEventPipeInterface:

Collaboration diagram for WsfEventPipeInterface:

Public Member Functions
	WsfEventPipeInterface (WsfEventPipeExtension &aExtension, const WsfEventPipeInput &aInput)
	~WsfEventPipeInterface () override
	WsfEventPipeInterface (const WsfEventPipeInterface &aPipeInterface)=delete
WsfEventPipeInterface &	operator= (const WsfEventPipeInterface &aPipeInterface)=delete
void	AddedToSimulation () override
int	GetEventId (const std::string &aEventName) const
const std::string &	GetOutputFileName () const
void	SendImmediate (double aSimTime, bool aExternal, std::unique_ptr< WsfEventPipe::MsgBase > aMessagePtr)
void	SendDependent (double aSimTime, const WsfPlatform &aPlatform, std::unique_ptr< WsfEventPipe::MsgBase > aMessagePtr)
void	SendPartStatus (double aSimTime, WsfPlatformPart *aPartPtr, int aType)
void	SendModeActive (double aSimTime, WsfSensor *aSensorPtr, WsfSensorMode *aModePtr, bool aActive)
void	SendVisualPartDefinition (double aSimTime, WsfVisualPart *aPartPtr, int aType)
const WsfEventPipeOptions &	GetCombinedOptions () const
void	AddLogger (WsfEventPipeLogger *aLoggerPtr)
void	RemoveLogger (WsfEventPipeLogger *aLoggerPtr)
void	UpdateArticulation (double aSimTime, WsfArticulatedPart *aPartPtr, int aPartType, double aAdditionalAz=0.0, double aAdditionalEl=0.0)
void	Bookmark (double aSimTime, const std::string &aMsgType, const std::string &aMsgText)
WSF_DEPRECATED void	Record (double aSimTime, WsfPlatform *aPlatform, const std::string &aKey, double aValue)
void	RecordDouble (const WsfPlatform &aPlatform, const std::string &aKey, double aValue)
void	RecordInt (const WsfPlatform &aPlatform, const std::string &aKey, int aValue)
void	RecordBool (const WsfPlatform &aPlatform, const std::string &aKey, bool aValue)
void	RecordString (const WsfPlatform &aPlatform, const std::string &aKey, const std::string &aValue)
double	HandleScheduledEntityStateRequest (double aTime, size_t aPlatformId)
void	UpdatePartArticulation (double aSimTime, size_t aPlatformId, WsfStringId &aPartNameId)
Public Member Functions inherited from WsfSimulationExtension
	WsfSimulationExtension ()
	~WsfSimulationExtension () override=default
WsfSimulation &	GetSimulation () const
const WsfScenario &	GetScenario () const
virtual bool	Initialize ()
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

Static Public Member Functions
static WsfEventPipeInterface *	Find (const WsfSimulation &aSimulation)
static std::unique_ptr< UtScriptClass >	CreateScriptClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
static void	Pack (WsfEventPipe::Track_Id &aData, const WsfTrackId &aId)
static void	Pack (WsfEventPipe::Covariance &aData, const UtCovariance &aCovariance)
static void	PackTrack (WsfEventPipe::Track &aTrackData, const WsfTrack &aTrack)
static void	Pack (WsfEventPipe::EM_Interaction_RelativeData &aData, const WsfEM_Interaction::RelativeData &aRelative)
static void	Pack (WsfEventPipe::EM_Interaction_BeamData &aData, const WsfEM_Interaction::BeamData &aBeam)
static void	Pack (WsfEventPipe::EM_Interaction &aData, const WsfEM_Interaction &aInteraction)
static unsigned int	Platform (const WsfPlatform &aPlatform)
static unsigned int	Platform (size_t aPlatformIndex)
static void	__private_SetSim (WsfSimulationExtension &aExtension, WsfSimulation *aSimPtr)

Additional Inherited Members
Protected Member Functions inherited from WsfExtension
void	InitializeExtensionName (const std::string &aName)

Constructor & Destructor Documentation

WsfEventPipeInterface() [1/2]

WsfEventPipeInterface::WsfEventPipeInterface	(	WsfEventPipeExtension &	aExtension,
		const WsfEventPipeInput &	aInput )

References for().

Referenced by Find(), operator=(), and WsfEventPipeInterface().

~WsfEventPipeInterface()

WsfEventPipeInterface::~WsfEventPipeInterface ( )

override

WsfEventPipeInterface() [2/2]

WsfEventPipeInterface::WsfEventPipeInterface ( const WsfEventPipeInterface & aPipeInterface )

delete

References WsfEventPipeInterface().

Member Function Documentation

AddedToSimulation()

void WsfEventPipeInterface::AddedToSimulation ( )

overridevirtual

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

Reimplemented from WsfSimulationExtension.

References WsfEventPipeExtension::Find(), UtmlObject::FindProperty(), WsfScriptContext::GetContext(), UtmlObject::GetObject(), UtmlObject::GetObjectCount(), WsfSimulationExtension::GetScenario(), WsfEventPipeExtension::GetSchema(), WsfSimulation::GetScriptContext(), WsfSimulationExtension::GetSimulation(), WsfScenario::GetSystemLog(), UtmlObject::GetType(), UtmlObject::makeContainer(), UtmlWriter::mIndent, wsf::eventpipe::FileWriterWorker::mStreamPtr, UtmlParser::Parse(), UtmlObject::PropertyValue(), UtPackSchema::Read(), WsfEventPipeExtension::RegisterExtensionMessages, UtmlObject::SetValue(), WsfSimulation::SubstituteOutputFileVariables(), WsfSystemLog::WriteOutputLogEntry(), and UtmlWriter::WriteRoot().

AddLogger()

void WsfEventPipeInterface::AddLogger

(

WsfEventPipeLogger *

aLoggerPtr

)

References WsfEventPipeOptions::DisableAll(), and WsfEventPipeLogger::UpdateSubscriptions().

Referenced by wsf::AirCombat::EventPipeInterface::AddedToSimulation(), wsf::annotation::EventPipeInterface::AddedToSimulation(), wsf::cyber::SimulationExtension::AddedToSimulation(), wsf::p6dof::EventPipeInterface::AddedToSimulation(), wsf::six_dof::EventPipeInterface::AddedToSimulation(), wsf::space::EventPipeInterface::AddedToSimulation(), and WsfMilInterface::AddedToSimulation().

Bookmark()

void WsfEventPipeInterface::Bookmark	(	double	aSimTime,
		const std::string &	aMsgType,
		const std::string &	aMsgText )

References WsfSimulationExtension::GetSimulation(), and SendImmediate().

Referenced by UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

CreateScriptClass()

std::unique_ptr< UtScriptClass > WsfEventPipeInterface::CreateScriptClass ( const std::string & aClassName, UtScriptTypes * aScriptTypesPtr )

static

Referenced by WsfScriptManager::RegisterTypes().

Find()

WsfEventPipeInterface * WsfEventPipeInterface::Find ( const WsfSimulation & aSimulation )

static

References WsfSimulation::FindExtension(), WsfEventPipeInterface(), and WsfSimulationExtension::WsfSimulation.

Referenced by wsf::AirCombat::EventPipeInterface::AddedToSimulation(), wsf::annotation::EventPipeInterface::AddedToSimulation(), wsf::cyber::SimulationExtension::AddedToSimulation(), wsf::p6dof::EventPipeInterface::AddedToSimulation(), wsf::six_dof::EventPipeInterface::AddedToSimulation(), wsf::space::EventPipeInterface::AddedToSimulation(), and WsfMilInterface::AddedToSimulation().

GetCombinedOptions()

const WsfEventPipeOptions & WsfEventPipeInterface::GetCombinedOptions ( ) const

inline

GetEventId()

int WsfEventPipeInterface::GetEventId

(

const std::string &

aEventName

)

const

Referenced by wsf::AirCombat::EventPipe::EventPipe(), wsf::annotation::EventPipe::EventPipe(), wsf::cyber::EventPipe::EventPipe(), wsf::p6dof::EventPipe::EventPipe(), wsf::six_dof::EventPipe::EventPipe(), wsf::space::EventPipe::EventPipe(), operator=(), and WsfMilEventPipe::WsfMilEventPipe().

GetOutputFileName()

const std::string & WsfEventPipeInterface::GetOutputFileName

(

)

const

Referenced by operator=().

HandleScheduledEntityStateRequest()

double WsfEventPipeInterface::HandleScheduledEntityStateRequest	(	double	aTime,
		size_t	aPlatformId )

Parameters

aTime	is the current time
aPlatformId	is the platform of interest if the entity no longer exists we delete the event if an update occurred within the interval, no message is sent and the event is rescheduled to meet the interval if an update hasn't occurred, a message is sent and the event is rescheduled to meet the interval

Returns

0.0 if the event should be deleted, and the time of the next event otherwise

References WsfSimulation::GetPlatformByIndex(), WsfSimulationExtension::GetSimulation(), and Platform().

operator=()

WsfEventPipeInterface & WsfEventPipeInterface::operator= ( const WsfEventPipeInterface & aPipeInterface )

delete

References GetEventId(), GetOutputFileName(), SendDependent(), SendImmediate(), SendModeActive(), SendPartStatus(), SendVisualPartDefinition(), and WsfEventPipeInterface().

Pack() [1/5]

void WsfEventPipeInterface::Pack ( WsfEventPipe::Covariance & aData, const UtCovariance & aCovariance )

static

Pack() [2/5]

void WsfEventPipeInterface::Pack ( WsfEventPipe::EM_Interaction & aData, const WsfEM_Interaction & aInteraction )

static

References WsfEM_Interaction::cRCVR_ALTITUDE_LIMITS, WsfEM_Interaction::cRCVR_ANGLE_LIMITS, WsfEM_Interaction::cRCVR_HORIZON_MASKING, WsfEM_Interaction::cRCVR_RANGE_LIMITS, WsfEM_Interaction::cRCVR_TERRAIN_MASKING, WsfEM_Interaction::cSIGNAL_LEVEL, WsfEM_Interaction::cXMTR_ALTITUDE_LIMITS, WsfEM_Interaction::cXMTR_ANGLE_LIMITS, WsfEM_Interaction::cXMTR_HORIZON_MASKING, WsfEM_Interaction::cXMTR_RANGE_LIMITS, WsfEM_Interaction::cXMTR_TERRAIN_MASKING, WsfEM_Interaction::GetTarget(), WsfEM_Interaction::GetTransmitter(), WsfEM_Interaction::mAbsorptionFactor, WsfEM_Interaction::mCheckedStatus, WsfEM_Interaction::mClutterPower, WsfEM_Interaction::mDetectionThreshold, WsfEM_Interaction::mFailedStatus, WsfEM_Interaction::mInfraredSig, WsfEM_Interaction::mInfraredSigAz, WsfEM_Interaction::mInfraredSigEl, WsfEM_Interaction::mInterferencePower, WsfEM_Interaction::LocationData::mIsValid, WsfEM_Interaction::LocationData::mLocWCS, WsfEM_Interaction::mMaskingFactor, WsfEM_Interaction::mOpticalReflectivity, WsfEM_Interaction::mOpticalSig, WsfEM_Interaction::mOpticalSigAz, WsfEM_Interaction::mOpticalSigEl, WsfEM_Interaction::mPixelCount, WsfEM_Interaction::mPowerDensityAtTarget, WsfEM_Interaction::mPropagationFactor, WsfEM_Interaction::mRadarSig, WsfEM_Interaction::mRadarSigAz, WsfEM_Interaction::mRadarSigEl, WsfEM_Interaction::mRcvdPower, WsfEM_Interaction::mRcvrBeam, WsfEM_Interaction::mRcvrLoc, WsfEM_Interaction::mRcvrNoisePower, WsfEM_Interaction::mRcvrToTgt, WsfEM_Interaction::mSignalToNoise, WsfEM_Interaction::mTgtLoc, WsfEM_Interaction::mTgtToRcvr, WsfEM_Interaction::mTgtToXmtr, WsfEM_Interaction::mXmtdPower, WsfEM_Interaction::mXmtrBeam, WsfEM_Interaction::mXmtrLoc, WsfEM_Interaction::mXmtrToTgt, WsfEM_Interaction::mZoneAttenuationValue, and Pack().

Pack() [3/5]

void WsfEventPipeInterface::Pack ( WsfEventPipe::EM_Interaction_BeamData & aData, const WsfEM_Interaction::BeamData & aBeam )

static

References WsfEM_Interaction::BeamData::mAz, WsfEM_Interaction::BeamData::mEl, and WsfEM_Interaction::BeamData::mGain.

Pack() [4/5]

void WsfEventPipeInterface::Pack ( WsfEventPipe::EM_Interaction_RelativeData & aData, const WsfEM_Interaction::RelativeData & aRelative )

static

References WsfEM_Interaction::RelativeData::mAz, WsfEM_Interaction::RelativeData::mEl, and WsfEM_Interaction::RelativeData::mRange.

Pack() [5/5]

void WsfEventPipeInterface::Pack ( WsfEventPipe::Track_Id & aData, const WsfTrackId & aId )

static

References WsfTrackId::GetLocalTrackNumber(), and WsfTrackId::GetOwningPlatformId().

Referenced by Pack(), PackTrack(), and WsfMilEventPipe::WeaponFired().

PackTrack()

void WsfEventPipeInterface::PackTrack ( WsfEventPipe::Track & aTrackData, const WsfTrack & aTrack )

static

References WsfTrack::cIFF_UNKNOWN, WsfTrack::GetIFF_Status(), WsfTrack::GetOriginatorIndex(), WsfTrack::GetPixelCount(), WsfSimulation::GetPlatformByIndex(), WsfTrack::GetSensorModeId(), WsfTrack::GetSensorNameId(), WsfTrack::GetSignalToNoise(), WsfTrack::GetSimulation(), WsfMeasurement::GetSpatialDomain(), WsfTrack::GetStartTime(), WsfTrack::GetTargetIndex(), WsfTrack::GetTrackId(), WsfTrack::GetTrackQuality(), WsfTrack::GetUpdateCount(), WsfTrack::GetUpdateTime(), WsfTrack::Is3D(), Pack(), Platform(), WsfTrack::SignalToNoiseValid(), and WSF_SPATIAL_DOMAIN_UNKNOWN.

Platform() [1/2]

unsigned int WsfEventPipeInterface::Platform ( const WsfPlatform & aPlatform )

static

References WsfPlatform::GetIndex(), and Platform().

Referenced by HandleScheduledEntityStateRequest(), WsfMilEventPipe::JammingRequestCanceled(), WsfMilEventPipe::JammingRequestInitiated(), WsfMilEventPipe::JammingRequestUpdated(), PackTrack(), Platform(), WsfMilEventPipe::PlatformKilled(), RecordBool(), RecordDouble(), RecordInt(), RecordString(), SendModeActive(), WsfMilEventPipe::SendModeActive(), SendPartStatus(), SendVisualPartDefinition(), WsfMilEventPipe::TaskAssigned(), UpdateArticulation(), WsfMilEventPipe::WeaponFired(), WsfMilEventPipe::WeaponQuantityChanged(), WsfMilEventPipe::WeaponTerminated(), and WsfMilEventPipe::WeaponTurnedOff().

Platform() [2/2]

unsigned int WsfEventPipeInterface::Platform ( size_t aPlatformIndex )

static

Record()

void WsfEventPipeInterface::Record	(	double	aSimTime,
		WsfPlatform *	aPlatform,
		const std::string &	aKey,
		double	aValue )

References RecordDouble().

RecordBool()

void WsfEventPipeInterface::RecordBool	(	const WsfPlatform &	aPlatform,
		const std::string &	aKey,
		bool	aValue )

References WsfSimulation::GetSimTime(), WsfSimulationExtension::GetSimulation(), Platform(), SendDependent(), and simTime.

Referenced by UT_DEFINE_SCRIPT_METHOD().

RecordDouble()

void WsfEventPipeInterface::RecordDouble	(	const WsfPlatform &	aPlatform,
		const std::string &	aKey,
		double	aValue )

References WsfSimulation::GetSimTime(), WsfSimulationExtension::GetSimulation(), Platform(), SendDependent(), and simTime.

Referenced by Record(), UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

RecordInt()

void WsfEventPipeInterface::RecordInt	(	const WsfPlatform &	aPlatform,
		const std::string &	aKey,
		int	aValue )

References WsfSimulation::GetSimTime(), WsfSimulationExtension::GetSimulation(), Platform(), SendDependent(), and simTime.

Referenced by UT_DEFINE_SCRIPT_METHOD().

RecordString()

void WsfEventPipeInterface::RecordString	(	const WsfPlatform &	aPlatform,
		const std::string &	aKey,
		const std::string &	aValue )

References WsfSimulation::GetSimTime(), WsfSimulationExtension::GetSimulation(), Platform(), SendDependent(), and simTime.

Referenced by UT_DEFINE_SCRIPT_METHOD(), and UT_DEFINE_SCRIPT_METHOD().

RemoveLogger()

void WsfEventPipeInterface::RemoveLogger

(

WsfEventPipeLogger *

aLoggerPtr

)

SendDependent()

void WsfEventPipeInterface::SendDependent	(	double	aSimTime,
		const WsfPlatform &	aPlatform,
		std::unique_ptr< WsfEventPipe::MsgBase >	aMessagePtr )

References WsfPlatform::GetIndex(), WsfPlatform::IsExternallyControlled(), WsfPlatform::IsInitialized(), and SendImmediate().

Referenced by operator=(), RecordBool(), RecordDouble(), RecordInt(), RecordString(), SendModeActive(), SendPartStatus(), SendVisualPartDefinition(), and UpdateArticulation().

SendImmediate()

void WsfEventPipeInterface::SendImmediate	(	double	aSimTime,
		bool	aExternal,
		std::unique_ptr< WsfEventPipe::MsgBase >	aMessagePtr )

Referenced by Bookmark(), operator=(), and SendDependent().

SendModeActive()

void WsfEventPipeInterface::SendModeActive	(	double	aSimTime,
		WsfSensor *	aSensorPtr,
		WsfSensorMode *	aModePtr,
		bool	aActive )

References WsfSimulation::AddEvent(), WsfSensorMode::GetFrameTime(), WsfNamed::GetName(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfSimulationExtension::GetSimulation(), WsfUniqueId::GetUniqueId(), Platform(), and SendDependent().

Referenced by operator=(), and SendPartStatus().

SendPartStatus()

void WsfEventPipeInterface::SendPartStatus	(	double	aSimTime,
		WsfPlatformPart *	aPartPtr,
		int	aType )

References WsfSensor::GetCurrentMode(), WsfNamed::GetName(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfUniqueId::GetUniqueId(), WsfPlatformPart::IsBroken(), WsfPlatformPart::IsOperational(), WsfPlatformPart::IsTurnedOn(), Platform(), SendDependent(), and SendModeActive().

Referenced by operator=().

SendVisualPartDefinition()

void WsfEventPipeInterface::SendVisualPartDefinition	(	double	aSimTime,
		WsfVisualPart *	aPartPtr,
		int	aType )

References WsfVisualPart::GetIcon(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), Platform(), and SendDependent().

Referenced by operator=().

UpdateArticulation()

void WsfEventPipeInterface::UpdateArticulation	(	double	aSimTime,
		WsfArticulatedPart *	aPartPtr,
		int	aPartType,
		double	aAdditionalAz = 0.0,
		double	aAdditionalEl = 0.0 )

References WsfArticulatedPart::GetCurrentOrientationECS(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfPlatformPart::IsTurnedOn(), Platform(), and SendDependent().

Referenced by UpdatePartArticulation().

UpdatePartArticulation()

void WsfEventPipeInterface::UpdatePartArticulation	(	double	aSimTime,
		size_t	aPlatformId,
		WsfStringId &	aPartNameId )

References WsfArticulatedPart::cSLEW_FIXED, WsfComponentList::GetComponent(), WsfSimulation::GetPlatformByIndex(), WsfSimulationExtension::GetSimulation(), and UpdateArticulation().

---

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

• WsfEventPipeInterface.hpp
• WsfEventPipeInterface.cpp