WSF
WsfSpaceExtension Class Reference

#include <WsfSpace.hpp>

Inheritance diagram for WsfSpaceExtension:
Collaboration diagram for WsfSpaceExtension:

Public Member Functions

void AddedToScenario () override
void SimulationCreated (WsfSimulation &aSimulation) override
WsfOrbitalPropagatorTypesGetOrbitalPropagatorTypes () const
wsf::space::OrbitalTargetingCostTypesGetOrbitalTargetingCostTypes () const
Public Member Functions inherited from WsfScenarioExtension
 WsfScenarioExtension ()
 ~WsfScenarioExtension () override
WsfScenarioGetScenario () const
WsfApplicationGetApplication () const
virtual bool ProcessInput (UtInput &aInput)
virtual void FileLoaded (const std::string &aFileName)
virtual bool Complete ()
virtual bool Complete2 ()
virtual bool AlwaysCreate ()
Public Member Functions inherited from WsfExtension
virtual ~WsfExtension ()=default
const std::string & GetExtensionName () const

Static Public Member Functions

static WsfSpaceExtensionGet (const WsfScenario &aScenario)

Additional Inherited Members

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

Member Function Documentation

◆ AddedToScenario()

void WsfSpaceExtension::AddedToScenario ( )
overridevirtual

Called when the extension has been added to the scenario. This is typically used to register new component type objects and object factories, e.g.:

WsfScenario& scenario(GetScenario());
WsfMoverTypes::Get(scenario).AddCoreType("MY_MOVER", new MyMover(scenario));
WsfAntennaPatterTypes::Get(scenario).AddObjectFactor(MyAntennaPattern::ObjectFactory);
static WSF_EXPORT WsfMoverTypes & Get(WsfScenario &aScenario)
Return a modifiable reference to the type list associated with the specified scenario.
Definition WsfMoverTypes.cpp:53
bool AddCoreType(WsfStringId aId, std::unique_ptr< T > aDefinitionPtr)
Definition WsfObjectTypeList.hpp:102
WsfScenario & GetScenario() const
Definition WsfScenarioExtension.hpp:46
friend class WsfScenario
Definition WsfScenarioExtension.hpp:39

Script classes must NOT be registered here because they are global to the entire application. They should be registered in WsfApplication::AddedToApplication.

Note
GetScenario() and GetApplication() are now valid.

Reimplemented from WsfScenarioExtension.

References WsfObjectTypeList< T >::Add(), WsfOpticalSignatureTypes::AddObjectFactory(), WsfScenario::AddTypeList(), wsf::TrackExtrapolationIds::cSPACE_KINEMATIC_STATE_EXTRAPOLATION, WsfApplication::ExtensionDepends(), WsfEventPipeExtension::Find(), wsf::TrackExtrapolationStrategyTypes::Get(), WsfFusionStrategyTypes::Get(), WsfMoverTypes::Get(), WsfOpticalSignatureTypes::Get(), WsfProcessorTypes::Get(), WsfScenario::GetApplication(), wsf::TrackExtrapolationStrategyTypes::GetDefaultStrategy(), WsfScenarioExtension::GetScenario(), WsfOrbitalAttitudeChangeEvent::GetTypeId(), WsfOrbitalScriptEvent::GetTypeId(), WsfOrbitalStagingEvent::GetTypeId(), wsf::space::J2_PerturbationOrbitalPropagator::ObjectFactory(), wsf::space::KeplerianOrbitalPropagator::ObjectFactory(), WsfIntegratingPropagator::ObjectFactory(), WsfNORAD_OrbitalPropagator::ObjectFactory(), WsfSpaceOpticalSignature::ObjectFactory(), wsf::space::EventPipe::RegisterEvents(), wsf::TrackExtrapolationStrategy::RegisterExtrapolation(), and WsfScenarioExtension::WsfScenario.

◆ Get()

WsfSpaceExtension & WsfSpaceExtension::Get ( const WsfScenario & aScenario)
static

Returns a reference to the space extension associated with a given scenario.

Note
This will throw an exception if the extension does not exist.

References WsfScenario::FindExtension(), and WsfScenarioExtension::WsfScenario.

Referenced by wsf::space::OrbitalTargetingCostTypes::Get(), wsf::space::OrbitalTargetingCostTypes::Get(), WsfOrbitalPropagatorTypes::Get(), and WsfOrbitalPropagatorTypes::Get().

◆ GetOrbitalPropagatorTypes()

WsfOrbitalPropagatorTypes & WsfSpaceExtension::GetOrbitalPropagatorTypes ( ) const
inline

◆ GetOrbitalTargetingCostTypes()

wsf::space::OrbitalTargetingCostTypes & WsfSpaceExtension::GetOrbitalTargetingCostTypes ( ) const
inline

◆ SimulationCreated()

void WsfSpaceExtension::SimulationCreated ( WsfSimulation & aSimulation)
overridevirtual

Called when a simulation has been created. (Technically this is called upon entry to WsfSimulation::Initialize()). This is typically used when a scenario extension also requires a simulation extension. The method would typically register the simulation extension as follows:

aSimulation.RegisterExtension("my_ext", new MySimulationExtension());
Parameters
aSimulationThe simulation that is being created. See note below!
Note
This is called upon entry to WsfSimulation::Initialize() and nothing can be assumed about the state of the simulation.
See also
WsfSimulationExtension, WsfApplicationExtension::SimulationCreated

Reimplemented from WsfScenarioExtension.

References WsfCSV_EventOutputData::AddDataTags(), WsfCSV_EventOutputData::AppendDataTags(), WsfConstellationManager::cEXTENSION_NAME, WsfDE_FileManager::cEXTENSION_NAME, WsfCSV_EventOutput::Find(), WsfEventOutput::Find(), WsfScriptObserver::Find(), Register_event_output(), and WsfSimulation::RegisterExtension().


The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved