#include <WsfSimulationExtension.hpp>

Inheritance diagram for WsfSimulationExtension:

[legend]

Collaboration diagram for WsfSimulationExtension:

Public Member Functions
	WsfSimulationExtension ()
	~WsfSimulationExtension () override=default
WsfSimulation &	GetSimulation () const
const WsfScenario &	GetScenario () const
Public Member Functions inherited from WsfExtension
virtual	~WsfExtension ()=default
const std::string &	GetExtensionName () const

Friends
class	WsfSimulation

Notifications from the simulation.
These are called in the order they are listed.
virtual void	AddedToSimulation ()
virtual bool	Initialize ()
virtual bool	PrepareExtension ()
virtual bool	PlatformsInitialized ()
virtual void	PendingStart ()
virtual void	Start ()
virtual void	Complete (double aSimTime)
static void	__private_SetSim (WsfSimulationExtension &aExtension, WsfSimulation *aSimPtr)

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

Detailed Description

A base class for 'simulation extensions'.

An simulation extension is a object created and registered with an simulation object. The simulation object will notify registered simulation extensions when the simulation is initialized, started or completed.

An application extension may instantiate and register a derived version of this class, typically from within the derived class method WsfApplicationExtension::SimulationCreated(). A simulation extension is TYPICALLY necessary only if the application extension also registered an input extension as the simulation extension typically uses the data read by the input extension. There may be cases, however, where an input extension is created but the inputs are only used by instances of extension-created type objects. In this case a simulation extension MAY not be necessary. Your mileage may vary...

Note: The instance is owned by the simulation object once it is registered.

Constructor & Destructor Documentation

◆ WsfSimulationExtension()

WsfSimulationExtension::WsfSimulationExtension ( )

Referenced by __private_SetSim(), wsf::AirCombat::EventPipeInterface::Get(), wsf::cyber::SimulationExtension::Get(), wsf::p6dof::EventPipeInterface::Get(), wsf::six_dof::EventPipeInterface::Get(), wsf::space::EventPipeInterface::Get(), IADSC2SimulationExtension::IADSC2SimulationExtension(), wsf::six_dof::ObjectManager::ObjectManager(), engage::SimulationExtension::SimulationExtension(), WsfAccessReport::WsfAccessReport(), WsfBallisticMissileLaunchComputerSharedData::WsfBallisticMissileLaunchComputerSharedData(), WsfEclipseEventManager::WsfEclipseEventManager(), WsfEclipseReport::WsfEclipseReport(), WsfLOS_Manager::WsfLOS_Manager(), WsfP6DOF_ObjectManager::WsfP6DOF_ObjectManager(), WsfScriptObserver::WsfScriptObserver(), WsfSimulation, and XWsfOSM_Traffic::XWsfOSM_Traffic().

◆ ~WsfSimulationExtension()

WsfSimulationExtension::~WsfSimulationExtension ( )

overridedefault

Member Function Documentation

◆ __private_SetSim()

void WsfSimulationExtension::__private_SetSim	(	WsfSimulationExtension &	aExtension,
		WsfSimulation *	aSimPtr )

inlinestatic

References WsfSimulation, and WsfSimulationExtension().

◆ AddedToSimulation()

void WsfSimulationExtension::AddedToSimulation ( )

virtual

Called in response to WsfSimulation::RegisterExtension. The extension has now been registered in the simulation.

Reimplemented in engage::SimulationExtension, IADSC2SimulationExtension, wsf::AirCombat::EventPipeInterface, wsf::altloc::SimulationExtension, wsf::annotation::EventPipeInterface, wsf::cyber::SimulationExtension, wsf::p6dof::EventPipeInterface, wsf::simdis::Interface, wsf::six_dof::EventPipeInterface, wsf::six_dof::ObjectManager, wsf::space::EventPipeInterface, wsf::UCI_InterfaceExtension, WsfDisInterface, WsfEventPipeInterface, WsfL16::Interface, WsfMilInterface, WsfMTT_Interface, WsfP6DOF_ObjectManager, WsfScriptObserver, WsfWeaponServer, and XWsfOSM_Traffic.

◆ Complete()

void WsfSimulationExtension::Complete ( double aSimTime )

virtual

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

aSimTime The final simulation time of the simulation.

Reimplemented in wsf::coverage::SimulationExtension, wsf::six_dof::ObjectManager, and WsfP6DOF_ObjectManager.

Referenced by WsfSimulation::Complete().

◆ GetScenario()

const WsfScenario & WsfSimulationExtension::GetScenario ( ) const

Returns the scenario in which this extension is registered.

Note: Do not call this method before registering this extension

Referenced by wsf::cyber::SimulationExtension::AddedToSimulation(), wsf::simdis::Interface::AddedToSimulation(), wsf::UCI_InterfaceExtension::AddedToSimulation(), WsfEventPipeInterface::AddedToSimulation(), WsfExtInterface::CreateExternalPlatform(), wsf::cyber::SimulationExtension::Initialize(), XWsfAirTraffic::Initialize(), XWsfOSM_Traffic::Initialize(), XWsfSeaTraffic::Vehicle::Initialize(), wsf::event::output::SimulationExtension::OpenFile(), wsf::comm::NetworkManager::PlatformsInitialized(), WsfWeaponServer::ProcessCommand(), WsfExtInterface::SelectPlatformType(), and WsfWeaponServer::WsfWeaponServer().

◆ GetSimulation()

WsfSimulation & WsfSimulationExtension::GetSimulation ( ) const

inline

Returns the simulation to which this extension is registered.

Note: This is not valid until AddedToSimulation() has been called.

References WsfSimulation.

◆ Initialize()

bool WsfSimulationExtension::Initialize ( )

virtual

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 in engage::SimulationExtension, wsf::comm::NetworkManager, wsf::coverage::SimulationExtension, wsf::cyber::SimulationExtension, wsf::six_dof::ObjectManager, WsfAccessReport, WsfBallisticMissileLaunchComputerSharedData, WsfDisInterface, WsfEclipseEventManager, WsfEclipseReport, WsfL16::Interface, WsfLaserDesignations, WsfLOS_Manager, WsfMTT_Interface, WsfP6DOF_ObjectManager, WsfScriptObserver, WsfWeaponServer, XWsfAirTraffic, XWsfOSM_Traffic, XWsfRoadTraffic, and XWsfSeaTraffic.

Referenced by WsfL16::Interface::Initialize(), and WsfSimulation::Initialize().

◆ PendingStart()

void WsfSimulationExtension::PendingStart ( )

virtual

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 in wsf::comm::NetworkManager, and wsf::coverage::SimulationExtension.

Referenced by WsfSimulation::Initialize().

◆ PlatformsInitialized()

bool WsfSimulationExtension::PlatformsInitialized ( )

virtual

Called during WsfSimulation::Initialize, via WsfSimulation::AddInputPlatforms(), after all platforms have undergone Initialize() calls. This is called to allow any extension to perform processing that may be predicated on platforms being added to the simulation, with all platforms and components having undergone calls to Initialize(), but prior to calls to Initialize2() having been performed.

Reimplemented in wsf::comm::NetworkManager.

Referenced by WsfSimulation::AddInputPlatforms().

◆ PrepareExtension()

bool WsfSimulationExtension::PrepareExtension ( )

virtual

Called in response to a call to WsfSimulation::Initialize and WsfSimulation::PrepareSimulation.

A simulation extension will typically implement either WsfSimulationExtension::Initialize or WsfSimulationExtension::PrepareExtension, or a combination of both. The main difference is that:

WsfSimulationExtension::Initialize is called only when a simulation is initialized after being loaded from input files (the normal mode of operation).
WsfSimulation::PrepareExecution is called in the former case AND when a simulation is reloaded from a snapshot.

The primary criteria for deciding which method to use is to look at the extension and see if it uses any external resources such as files or sockets. If the extension uses external resources and wants to support snapshotting then it MUST use this this method so it can (re)establish connections to external resources (A snapshot cannot save the state of an open file or socket and so it must be reopened.)

Reimplemented in wsf::event::output::SimulationExtension, wsf::six_dof::ObjectManager, WsfDisInterface, WsfExtInterface, and WsfP6DOF_ObjectManager.

Referenced by WsfSimulation::Initialize(), and WsfSimulation::PrepareSimulation().

◆ Start()

void WsfSimulationExtension::Start ( )

virtual

Called in response to a call to WsfSimulation::Start. WsfSimulation::Start is typically called immediately before entry in the main event loop. The simulation is in its initial state, although the extension may also add additional platforms. using WsfSimulation::AddPlatform.

Reimplemented in wsf::annotation::EventPipeInterface, wsf::six_dof::ObjectManager, WsfP6DOF_ObjectManager, and WsfScriptObserver.

Referenced by WsfSimulation::Start().