A utility that produces Eclipse reports. Eclipse Reports provide start time, end time, and the duration the platform is in Earth's shadow. Results do not take into account Earth's oblateness or change in sun's position over one orbital period. More...

#include <WsfEclipseReport.hpp>

Inheritance diagram for WsfEclipseReport:

[legend]

Collaboration diagram for WsfEclipseReport:

[legend]

Classes
class	EclipseEvent

Public Member Functions
	WsfEclipseReport (const WsfEclipseReportData &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	PlatformInitializedHandler (double aSimTime, WsfPlatform *aPlatformPtr)
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 WsfEclipseReportData
	WsfEclipseReportData ()

Friends
class	EclipseEvent

Additional Inherited Members
static void	__private_SetSim (WsfSimulationExtension &aExtension, WsfSimulation *aSimPtr)
Protected Types inherited from WsfEclipseReportData
using	EclipseIntervalList = std::list<EclipseInterval>
using	EclipseMap = std::map<WsfStringId, EclipseIntervalList>
Protected Attributes inherited from WsfEclipseReportData
bool	mReportAll
EclipseMap	mEclipseMap
std::string	mFileName
std::string	mFormat

Detailed Description

A utility that produces Eclipse reports. Eclipse Reports provide start time, end time, and the duration the platform is in Earth's shadow. Results do not take into account Earth's oblateness or change in sun's position over one orbital period.

Constructor & Destructor Documentation

◆ WsfEclipseReport()

WsfEclipseReport::WsfEclipseReport ( const WsfEclipseReportData & aData )

explicit

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

Referenced by WsfEclipseReport::EclipseEvent::EclipseEvent().

Member Function Documentation

◆ Initialize()

bool WsfEclipseReport::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(), WsfEclipseReportData::mEclipseMap, WsfEclipseReportData::mReportAll, WsfObserver::OrbitalManeuverCompleted(), WsfObserver::PlatformInitialized(), PlatformInitializedHandler(), WsfObserver::SimulationComplete(), and SimulationCompleteHandler().

◆ PlatformInitializedHandler()

void WsfEclipseReport::PlatformInitializedHandler	(	double	aSimTime,
		WsfPlatform *	aPlatformPtr )

protected

References WsfPlatform::GetMover(), WsfObject::GetName(), WsfEclipseReportData::mEclipseMap, and WsfEclipseReportData::mReportAll.

Referenced by Initialize().

◆ SimulationCompleteHandler()

void WsfEclipseReport::SimulationCompleteHandler ( double aSimTime )

protected

Use the SimulationCompleted callaback to write detection inteval output to the specified file.

References WsfEclipseReportData::mEclipseMap, WsfEclipseReportData::mFileName, and WsfEclipseReportData::mFormat.

Referenced by Initialize().

◆ EclipseEvent

friend class EclipseEvent

friend

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

Classes

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members