#include <WsfDE_FileManager.hpp>

Inheritance diagram for WsfDE_FileManager:

[legend]

Collaboration diagram for WsfDE_FileManager:

[legend]

Public Member Functions
	WsfDE_FileManager ()=default
	~WsfDE_FileManager () override=default
std::unique_ptr< WsfDE_FileHandle >	GetOrLoadFile (const std::string &aFileName)
Public Member Functions inherited from WsfSimulationExtension
	WsfSimulationExtension ()
	~WsfSimulationExtension () override=default
WsfSimulation &	GetSimulation () const
const WsfScenario &	GetScenario () const
virtual void	AddedToSimulation ()
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 WsfDE_FileManager &	Get (const WsfSimulation *aSimulationPtr)
	Provide static access to the extension for the given `aSimulationPtr`.
static void	__private_SetSim (WsfSimulationExtension &aExtension, WsfSimulation *aSimPtr)

Static Public Attributes
static constexpr const char *	cEXTENSION_NAME {"wsf_de_file_manager"}

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

Detailed Description

This simulation extension provides a central repository for loaded DE files.

This allows for the clients of the JPL Development Ephemeris files to store only a reference to the file, and maintain separate work spaces to use during interpolation.

Constructor & Destructor Documentation

◆ WsfDE_FileManager()

WsfDE_FileManager::WsfDE_FileManager ( )

default

Referenced by Get(), and ~WsfDE_FileManager().

◆ ~WsfDE_FileManager()

WsfDE_FileManager::~WsfDE_FileManager ( )

overridedefault

References WsfDE_FileManager(), and WsfSimulationExtension::WsfSimulation.

Member Function Documentation

◆ Get()

WsfDE_FileManager & WsfDE_FileManager::Get ( const WsfSimulation * aSimulationPtr )

static

Provide static access to the extension for the given aSimulationPtr.

References cEXTENSION_NAME, WsfSimulation::GetExtension(), WsfDE_FileManager(), and WsfSimulationExtension::WsfSimulation.

Referenced by WsfJupiterMonopoleTerm::Initialize(), WsfMoonMonopoleTerm::Initialize(), WsfSunMonopoleTerm::Initialize(), and UT_DEFINE_SCRIPT_METHOD().

◆ GetOrLoadFile()

std::unique_ptr< WsfDE_FileHandle > WsfDE_FileManager::GetOrLoadFile ( const std::string & aFileName )

Get a handle to a JPL Development Ephemeris File

This method will return a new handle to the DE file with the given name. If there is a problem loading the file, this will throw a WsfDE_File::Error with information about the error. If a file with the given aFileName is already loaded, this will not reload the file, but merely return a new handle to that file.

Parameters

aFileName - The name of a file for which a handle will be returned.

Returns: - A handle to the named file.

Referenced by WsfJupiterMonopoleTerm::Initialize(), WsfMoonMonopoleTerm::Initialize(), WsfSunMonopoleTerm::Initialize(), and UT_DEFINE_SCRIPT_METHOD().

Member Data Documentation

◆ cEXTENSION_NAME

const char* WsfDE_FileManager::cEXTENSION_NAME {"wsf_de_file_manager"}

staticconstexpr

Referenced by Get(), and WsfSpaceExtension::SimulationCreated().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members