A utility that produces access reports for which platforms have visibility with each other. Access Reports provide start time, end time, and the duration for platforms that have access (visibility) with each other. Access is computed by detecting platform(s) with sensors, using SensorDetectionChanged callbacks. A variety of options are avaialbable for specifying detecting platform(s), detected platform(s), and detecting sensor(s). More...

#include <WsfAccessReport.hpp>

Inheritance diagram for WsfAccessReport:

[legend]

Collaboration diagram for WsfAccessReport:

[legend]

Public Member Functions
	WsfAccessReport (const WsfAccessReportData &aData)
bool	Initialize () override
Public Member Functions inherited from WsfSimulationExtension
	WsfSimulationExtension ()
	~WsfSimulationExtension () override=default
WsfSimulation &	GetSimulation () const
const WsfScenario &	GetScenario () const
virtual void	AddedToSimulation ()
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

Protected Member Functions
void	SensorDetectionChangedHandler (double aSimTime, WsfSensor *aSensorPtr, size_t aTargetIndex, WsfSensorResult &aResult)
	Use the SensorDetectionChanged callback to store detection interval results.
void	SimulationCompleteHandler (double aSimTime)
	Use the SimulationCompleted callaback to write detection inteval output to the specified file.
Protected Member Functions inherited from WsfExtension
void	InitializeExtensionName (const std::string &aName)
Protected Member Functions inherited from WsfAccessReportData
	WsfAccessReportData ()

Additional Inherited Members
static void	__private_SetSim (WsfSimulationExtension &aExtension, WsfSimulation *aSimPtr)
Protected Types inherited from WsfAccessReportData
using	DetectionIntervalList = std::list<DetectionInterval>
using	DetectorDetecteeMap = std::map<DetectorDetecteeKey, DetectionIntervalList>
using	KeyInputs = std::list<DetectorDetecteeKey>
Protected Attributes inherited from WsfAccessReportData
KeyInputs	mKeyInputs
DetectorDetecteeMap	mDetectorDetecteeMap
std::string	mDefaultSensor
std::string	mFileName
std::string	mFormat

Detailed Description

A utility that produces access reports for which platforms have visibility with each other. Access Reports provide start time, end time, and the duration for platforms that have access (visibility) with each other. Access is computed by detecting platform(s) with sensors, using SensorDetectionChanged callbacks. A variety of options are avaialbable for specifying detecting platform(s), detected platform(s), and detecting sensor(s).

Constructor & Destructor Documentation

◆ WsfAccessReport()

WsfAccessReport::WsfAccessReport ( const WsfAccessReportData & aData )

explicit

References WsfAccessReportData::WsfAccessReportData(), and WsfSimulationExtension::WsfSimulationExtension().

Member Function Documentation

◆ Initialize()

bool WsfAccessReport::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 WsfSimulation::GetDateTime(), WsfSimulationExtension::GetSimulation(), WsfDateTime::GetStartDateAndTime(), WsfAccessReportData::mKeyInputs, WsfObserver::SensorDetectionChanged(), SensorDetectionChangedHandler(), WsfObserver::SimulationComplete(), and SimulationCompleteHandler().