WSF
wsf::coverage::SimulationExtension Class Reference

#include <WsfCoverageSimulationExtension.hpp>

Inheritance diagram for wsf::coverage::SimulationExtension:
Collaboration diagram for wsf::coverage::SimulationExtension:

Public Member Functions

 SimulationExtension (const ScenarioExtension &aScenarioExtension)
 SimulationExtension (const SimulationExtension &aOther)=default
 ~SimulationExtension () override=default
SimulationExtensionClone () const override
bool ProcessInput (UtInput &aInput) override
bool Initialize () override
void PendingStart () override
void Complete (double aSimTime) override
GridGetGrid (const std::string &aGridName) const
CoverageGetCoverage (const std::string &aCoverageName) const
Public Member Functions inherited from WsfCloneableSimulationExtension
 WsfCloneableSimulationExtension ()=default
Public Member Functions inherited from WsfSimulationExtension
 WsfSimulationExtension ()
 ~WsfSimulationExtension () override=default
WsfSimulationGetSimulation () const
const WsfScenarioGetScenario () const
virtual void AddedToSimulation ()
virtual bool PrepareExtension ()
virtual bool PlatformsInitialized ()
virtual void Start ()
Public Member Functions inherited from WsfExtension
virtual ~WsfExtension ()=default
const std::string & GetExtensionName () const

Static Public Member Functions

static const SimulationExtensionGet (const WsfSimulation &aSimulation)
static void __private_SetSim (WsfSimulationExtension &aExtension, WsfSimulation *aSimPtr)

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ SimulationExtension() [1/2]

wsf::coverage::SimulationExtension::SimulationExtension ( const ScenarioExtension & aScenarioExtension)
inlineexplicit

◆ SimulationExtension() [2/2]

wsf::coverage::SimulationExtension::SimulationExtension ( const SimulationExtension & aOther)
default

References SimulationExtension().

◆ ~SimulationExtension()

wsf::coverage::SimulationExtension::~SimulationExtension ( )
overridedefault

Member Function Documentation

◆ Clone()

SimulationExtension * wsf::coverage::SimulationExtension::Clone ( ) const
inlineoverridevirtual

◆ Complete()

void wsf::coverage::SimulationExtension::Complete ( double aSimTime)
overridevirtual

Called in response to a call to WsfSimulation::Complete. This method is used to release any resources (close files or sockets, delete objects, etc.) that were allocated by the Initialize/PrepareExtension methods or otherwise allocated during the execution of the simulation. No other events or observer callbacks will be dispatched after this is called.

Parameters
aSimTimeThe final simulation time of the simulation.

Reimplemented from WsfSimulationExtension.

References WsfSimulationExtension::GetSimulation().

◆ Get()

const SimulationExtension & wsf::coverage::SimulationExtension::Get ( const WsfSimulation & aSimulation)
static

◆ GetCoverage()

Coverage * wsf::coverage::SimulationExtension::GetCoverage ( const std::string & aCoverageName) const

◆ GetGrid()

Grid * wsf::coverage::SimulationExtension::GetGrid ( const std::string & aGridName) const

◆ Initialize()

bool wsf::coverage::SimulationExtension::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 WsfSimulationExtension::GetSimulation().

◆ PendingStart()

void wsf::coverage::SimulationExtension::PendingStart ( )
overridevirtual

Called in response to a call to WsfSimulation::Initialize complete and pending start state. PendingStart is typically called immediately after the simulation is initialized in the main event loop. The simulation is in its pending start state, although the extension may also add additional platforms. using WsfSimulation::AddPlatform.

Reimplemented from WsfSimulationExtension.

References WsfSimulationExtension::GetSimulation().

◆ ProcessInput()

bool wsf::coverage::SimulationExtension::ProcessInput ( UtInput & aInput)
overridevirtual

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