Functions
WSF_EXPORT bool	DebugEnabled (WsfDisInterface *aInterfacePtr)
WSF_EXPORT WsfDisPlatform *	FindDisPlatform (WsfDisInterface *aInterfacePtr, const DisEntityId &aEntityId)
WSF_EXPORT WsfDisPlatform *	GetDisPlatform (WsfDisInterface *aInterfacePtr, size_t aPlatformIndex)
WSF_EXPORT void	GetEntityIdFromIndex (WsfDisInterface *aInterfacePtr, size_t aPlatformIndex, DisEntityId &aEntityId)
WSF_EXPORT WsfExtInterface *	GetExtInterface (WsfDisInterface *aInterfacePtr)
WSF_EXPORT DisUint32	GetNextRequestNumber (WsfDisInterface *aInterfacePtr)
WSF_EXPORT DisUint8	GetReliabilityService (WsfDisInterface *aInterfacePtr)
WSF_EXPORT const WsfScenario &	GetScenario (WsfDisInterface *aInterfacePtr)
WSF_EXPORT WsfSimulation &	GetSimulation (WsfDisInterface *aInterfacePtr)
WSF_EXPORT double	GetSimTime (WsfDisInterface *aInterfacePtr)
WSF_EXPORT double	GetTimeFromPdu (WsfDisInterface *aInterfacePtr, DisPdu &aPdu)
WSF_EXPORT void	PutPdu (WsfDisInterface *aInterfacePtr, double aSimTime, std::unique_ptr< DisPdu > aPduPtr)
WSF_EXPORT void	SimTimeToDisClockTime (double aSimTime, DisClockTime &aDisClockTime)
WSF_EXPORT bool	WsfToDisPlayers (WsfDisInterface aInterfacePtr, size_t aOriginatingIndex, size_t aRequestingIndex, size_t aRespondingIndex, bool &aSenderIsRequestor, bool &aSenderIsResponder, bool &aRequestorIsLocal, bool &aResponderIsLocal, WsfDisPlatform &aRequesterPtr, WsfDisPlatform *&aResponderPtr, DisEntityId &aOriginatingId, DisEntityId &aRequestorId, DisEntityId &aResponderId)
WSF_EXPORT bool	DisToWsfPlayers (WsfDisInterface aInterfacePtr, const DisEntityId &aOriginatingId, const DisEntityId &aRequestorId, const DisEntityId &aResponderId, bool &aSenderIsRequestor, bool &aSenderIsResponder, bool &aRequestorIsLocal, bool &aResponderIsLocal, WsfDisPlatform &aRequesterPtr, WsfDisPlatform *&aResponderPtr, size_t &aRequestingIndex, size_t &aRespondingIndex)

Detailed Description

A collection of utility functions that eliminate the need to include WsfDisInterface.hpp.

WsfDisInterface.hpp is a very complex header file and simply including it causes the compile time for a file to increase dramatically. By implementing the following methods below, which are simply pass-through to the same-named method in WsfDisInterface, the inclusion of WsfDisInterface.hpp was removed from many files.

There is obviously a very small run-time penalty because of the extra level of indirection, but any extra time is dwarfed by the rest of the simulation.

See also: WsfDisInterface.

Function Documentation

◆ DebugEnabled()

bool WsfDisUtil::DebugEnabled ( WsfDisInterface * aInterfacePtr )

References WsfDisInput::DebugEnabled().

Referenced by WsfDisActionRequestR::ParseData(), WsfDisSetDataR::ParseTimeParameters(), WsfDisSetRecordR::PopulateReply(), WsfDisRecordQueryR::PopulateResponse(), WsfDisSetDataR::PopulateResponse(), WsfDisActionRequest::Process(), WsfDisDataQuery::Process(), WsfDisDataQueryR::Process(), WsfDisDirectedEnergyFire::Process(), WsfDisRemoveEntity::Process(), WsfDisSetData::Process(), WsfDisSetRecordR::Process(), WsfDisStartResume::Process(), WsfDisStopFreeze::Process(), WsfDisStopFreezeR::Process(), WsfDisCreateEntityR::ProcessCreateEntityRequest(), WsfDisActionRequestR::ProcessJoinExercise(), WsfDisActionResponse::ProcessJoinExerciseResponseTo(), WsfDisActionResponseR::ProcessJoinExerciseResponseTo(), WsfDisRemoveEntityR::ProcessRemoveEntityRequest(), WsfDisActionRequestR::ProcessResignExercise(), WsfDisActionResponse::ProcessResponseTo(), WsfDisActionResponseR::ProcessResponseTo(), WsfDisDataR::ProcessResponseTo(), WsfDisSetDataR::ProcessSetDataRequest(), WsfDisSetRecordR::ProcessSetRecordRequest(), WsfDisStartResumeR::ProcessStartCommand(), WsfDisActionRequestR::ProcessTimeAdvance(), WsfDisActionRequestR::ProduceResponse(), WsfDisDataQueryR::ProduceResponse(), WsfDisAcknowledgeR::TimedOut(), WsfDisActionRequestR::TimedOut(), WsfDisCreateEntityR::TimedOut(), WsfDisDataQueryR::TimedOut(), WsfDisRecordQueryR::TimedOut(), WsfDisRemoveEntityR::TimedOut(), WsfDisSetDataR::TimedOut(), WsfDisSetRecordR::TimedOut(), WsfDisStartResumeR::TimedOut(), and WsfDisStopFreezeR::TimedOut().

◆ DisToWsfPlayers()

bool WsfDisUtil::DisToWsfPlayers	(	WsfDisInterface *	aInterfacePtr,
		const DisEntityId &	aOriginatingId,
		const DisEntityId &	aRequestorId,
		const DisEntityId &	aResponderId,
		bool &	aSenderIsRequestor,
		bool &	aSenderIsResponder,
		bool &	aRequestorIsLocal,
		bool &	aResponderIsLocal,
		WsfDisPlatform *&	aRequesterPtr,
		WsfDisPlatform *&	aResponderPtr,
		size_t &	aRequestingIndex,
		size_t &	aRespondingIndex )

References WsfDisInterface::FindDisPlatform(), WsfPlatform::GetIndex(), WsfDisPlatform::GetPlatform(), and WsfPlatform::IsExternallyControlled().

Referenced by WsfDisRepairComplete::Process(), WsfDisRepairResponse::Process(), WsfDisResupplyOffer::Process(), and WsfDisServiceRequest::Process().

◆ FindDisPlatform()

WsfDisPlatform * WsfDisUtil::FindDisPlatform	(	WsfDisInterface *	aInterfacePtr,
		const DisEntityId &	aEntityId )

References WsfDisInterface::FindDisPlatform().

Referenced by WsfDisWeaponEvents::InitiateWeaponTransfer(), WsfDisDetonation::Process(), WsfDisDirectedEnergyFire::Process(), WsfDisEmission::Process(), WsfDisEntityDamageStatus::Process(), WsfDisEntityState::Process(), WsfDisFire::Process(), WsfDisRemoveEntity::Process(), WsfDisResupplyCancel::Process(), WsfDisResupplyReceived::Process(), WsfDisWeaponEvents::TransferPlatformToInternalControl(), and WsfDisEmission::UpdateSysBeamMapping().

◆ GetDisPlatform()

WsfDisPlatform * WsfDisUtil::GetDisPlatform	(	WsfDisInterface *	aInterfacePtr,
		size_t	aPlatformIndex )

References WsfDisInterface::GetDisPlatform().

Referenced by WsfDisVisualization::BehaviorChange(), WsfDisWeaponEvents::DirectedEnergyWeaponFired(), WsfDisWeaponEvents::DirectedEnergyWeaponHit(), WsfDisVisualization::VisibleChange(), and WsfDisWeaponEvents::WeaponTerminated().

◆ GetEntityIdFromIndex()

void WsfDisUtil::GetEntityIdFromIndex	(	WsfDisInterface *	aInterfacePtr,
		size_t	aPlatformIndex,
		DisEntityId &	aEntityId )

References WsfDisInterface::GetEntityIdFromIndex().

◆ GetExtInterface()

WsfExtInterface * WsfDisUtil::GetExtInterface ( WsfDisInterface * aInterfacePtr )

References WsfDisInterface::GetExtInterface().

Referenced by WsfDisVisualization::BehaviorChange(), WsfDisWeaponEvents::DirectedEnergyWeaponFired(), WsfDisPlatform::ForceUpdate(), WsfDisEmission::GetExtEmission(), WsfDisPlatform::MessageTransmitted(), WsfDisPlatform::MoverUpdated(), WsfDisPlatform::PlatformDeleted(), WsfDisPlatform::PlatformInitialized(), WsfDisDetonation::Process(), WsfDisEmission::Process(), WsfDisResupplyOffer::Process(), WsfDisResupplyReceived::Process(), WsfDisServiceRequest::Process(), WsfDisPlatform::SendEmissionsPDU(), WsfDisPlatform::SendOrQueueEmissionsPDU(), WsfDisWeaponEvents::WeaponTerminated(), WsfDisDirectedEnergyFire::WsfDisDirectedEnergyFire(), WsfDisDirectedEnergyFire::WsfDisDirectedEnergyFire(), WsfDisFire::WsfDisFire(), WsfDisPlatform::WsfDisPlatform(), WsfDisVisualization::WsfDisVisualization(), and WsfDisWeaponEvents::WsfDisWeaponEvents().

◆ GetNextRequestNumber()

DisUint32 WsfDisUtil::GetNextRequestNumber ( WsfDisInterface * aInterfacePtr )

References WsfDisInterface::GetNextRequestNumber().

Referenced by WsfDisActionRequest::WsfDisActionRequest(), WsfDisActionRequestR::WsfDisActionRequestR(), WsfDisCreateEntity::WsfDisCreateEntity(), WsfDisCreateEntityR::WsfDisCreateEntityR(), WsfDisData::WsfDisData(), WsfDisDataQuery::WsfDisDataQuery(), WsfDisDataQueryR::WsfDisDataQueryR(), WsfDisRecordQueryR::WsfDisRecordQueryR(), WsfDisRecordR::WsfDisRecordR(), WsfDisRemoveEntity::WsfDisRemoveEntity(), WsfDisRemoveEntityR::WsfDisRemoveEntityR(), WsfDisSetData::WsfDisSetData(), WsfDisSetDataR::WsfDisSetDataR(), WsfDisSetRecordR::WsfDisSetRecordR(), WsfDisStartResume::WsfDisStartResume(), WsfDisStartResumeR::WsfDisStartResumeR(), WsfDisStopFreeze::WsfDisStopFreeze(), and WsfDisStopFreezeR::WsfDisStopFreezeR().

◆ GetReliabilityService()

DisUint8 WsfDisUtil::GetReliabilityService ( WsfDisInterface * aInterfacePtr )

References WsfDisInterface::GetReliabilityService().

Referenced by WsfDisActionRequestR::WsfDisActionRequestR(), WsfDisCreateEntityR::WsfDisCreateEntityR(), WsfDisDataQueryR::WsfDisDataQueryR(), WsfDisDataR::WsfDisDataR(), WsfDisRecordQueryR::WsfDisRecordQueryR(), WsfDisRecordR::WsfDisRecordR(), WsfDisRemoveEntityR::WsfDisRemoveEntityR(), WsfDisSetDataR::WsfDisSetDataR(), WsfDisSetRecordR::WsfDisSetRecordR(), WsfDisStartResumeR::WsfDisStartResumeR(), and WsfDisStopFreezeR::WsfDisStopFreezeR().

◆ GetScenario()

const WsfScenario & WsfDisUtil::GetScenario ( WsfDisInterface * aInterfacePtr )

References WsfDisInterface::GetScenario().

Referenced by WsfDisDirectedEnergyFire::Process(), and WsfDisFileDevice::WsfDisFileDevice().

◆ GetSimTime()

◆ GetSimulation()

WsfSimulation & WsfDisUtil::GetSimulation ( WsfDisInterface * aInterfacePtr )

References WsfSimulationExtension::GetSimulation().

Referenced by WsfDisVisualization::Connected(), WsfDisExchange::ExchangeQueried(), WsfDisIO_Thread::Initialize(), WsfDisSetDataR::PopulateResponse(), WsfDisAcknowledgeR::Process(), WsfDisData::Process(), WsfDisDataQuery::Process(), WsfDisDesignator::Process(), WsfDisDirectedEnergyFire::Process(), WsfDisEmission::Process(), WsfDisEntityState::Process(), WsfDisFire::Process(), WsfDisRemoveEntity::Process(), WsfDisRepairComplete::Process(), WsfDisRepairResponse::Process(), WsfDisResupplyCancel::Process(), WsfDisResupplyOffer::Process(), WsfDisResupplyReceived::Process(), WsfDisServiceRequest::Process(), WsfDisSetData::Process(), WsfDisSetRecordR::Process(), WsfDisSignal::Process(), WsfDisStartResume::Process(), WsfDisStopFreeze::Process(), WsfDisTransferOwnership::Process(), WsfDisTransmitter::Process(), WsfDisActionResponse::ProcessJoinExerciseResponseTo(), WsfDisActionResponseR::ProcessJoinExerciseResponseTo(), WsfDisSetDataR::ProcessSetDataRequest(), WsfDisStartResumeR::ProcessStartCommand(), WsfDisDataQueryR::ProduceResponse(), WsfDisPlatform::SendOrQueueEmissionsPDU(), WsfDisPlatform::SetEntityState(), WsfDisPlatform::TrySendCMEData(), WsfDisMover::Update(), WsfDisEmission::UpdateSensor(), WsfDisDraw::WsfDisDraw(), and WsfDisDraw::WsfDisDraw().

◆ GetTimeFromPdu()

double WsfDisUtil::GetTimeFromPdu	(	WsfDisInterface *	aInterfacePtr,
		DisPdu &	aPdu )

References WsfDisInterface::GetTimeFromPdu().

Referenced by WsfDisDataQuery::Process(), WsfDisDataQueryR::Process(), WsfDisDirectedEnergyFire::Process(), WsfDisEmission::Process(), WsfDisEntityState::Process(), WsfDisFire::Process(), WsfDisSetData::Process(), WsfDisSetRecordR::Process(), WsfDisStopFreezeR::Process(), and WsfDisSetDataR::ProcessSetDataRequest().

◆ PutPdu()

void WsfDisUtil::PutPdu	(	WsfDisInterface *	aInterfacePtr,
		double	aSimTime,
		std::unique_ptr< DisPdu >	aPduPtr )

References WsfDisInterface::PutPdu().