wsf::AirCombat::EventPipeInterface Class Reference

Note that the interface is a WsfSimulationExtension. More...

#include <WsfAirCombatEventPipe.hpp>

Inheritance diagram for wsf::AirCombat::EventPipeInterface:

Collaboration diagram for wsf::AirCombat::EventPipeInterface:

Public Member Functions
	EventPipeInterface ()
	The EventPipeInterface constructor.
	~EventPipeInterface () override=default
void	AddedToSimulation () override
	Called when the extension is added to the simulation.
Public Member Functions inherited from WsfSimulationExtension
	WsfSimulationExtension ()
	~WsfSimulationExtension () override=default
WsfSimulation &	GetSimulation () const
const WsfScenario &	GetScenario () const
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 EventPipeInterface &	Get (const WsfSimulation &aSimulation)
	Get the EventPipeInterface associated with aSimulation.
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

Note that the interface is a WsfSimulationExtension.

It is not a WsfEventPipeInterface.

Constructor & Destructor Documentation

EventPipeInterface()

wsf::AirCombat::EventPipeInterface::EventPipeInterface

(

)

The EventPipeInterface constructor.

All it does is set its internal pointer to an EventPipe to nullptr.

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

~EventPipeInterface()

wsf::AirCombat::EventPipeInterface::~EventPipeInterface ( )

overridedefault

References EventPipeInterface(), and WsfSimulationExtension::WsfSimulation.

Member Function Documentation

AddedToSimulation()

void wsf::AirCombat::EventPipeInterface::AddedToSimulation ( )

overridevirtual

Called when the extension is added to the simulation.

This creates the AirCombat::EventPipe and adds it as a logger to a WsfEventPipeInterface found in the simulation.

Reimplemented from WsfSimulationExtension.

References WsfEventPipeInterface::AddLogger(), WsfEventPipeInterface::Find(), and WsfSimulationExtension::GetSimulation().

Get()

wsf::AirCombat::EventPipeInterface & wsf::AirCombat::EventPipeInterface::Get ( const WsfSimulation & aSimulation )

static

Get the EventPipeInterface associated with aSimulation.

References EventPipeInterface(), WsfSimulation::FindExtension(), WsfSimulationExtension::WsfSimulation, and WsfSimulationExtension::WsfSimulationExtension().

---

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

• WsfAirCombatEventPipe.hpp
• WsfAirCombatEventPipe.cpp