wsf::UCI_InterfaceExtension Class Reference

The OMS / UCI Interface Object to the UCI middleware. More...

#include <WsfUCI_InterfaceExtension.hpp>

Inheritance diagram for wsf::UCI_InterfaceExtension:

Collaboration diagram for wsf::UCI_InterfaceExtension:

Public Member Functions
	UCI_InterfaceExtension ()=default
	UCI_InterfaceExtension (const UCI_InterfaceExtension &aSrc)=default
virtual	~UCI_InterfaceExtension ()=default
UCI_InterfaceExtension &	operator= (const UCI_InterfaceExtension &aRhs)=delete
void	AddedToSimulation () override
UCI_Interface *	GetInterface () const
	Return the first interface in the map.
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 const char *	GetExtensionName ()
static const UCI_InterfaceExtension *	Get (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)

Detailed Description

The OMS / UCI Interface Object to the UCI middleware.

Constructor & Destructor Documentation

UCI_InterfaceExtension() [1/2]

wsf::UCI_InterfaceExtension::UCI_InterfaceExtension ( )

explicitdefault

Referenced by Get(), operator=(), and UCI_InterfaceExtension().

UCI_InterfaceExtension() [2/2]

wsf::UCI_InterfaceExtension::UCI_InterfaceExtension ( const UCI_InterfaceExtension & aSrc )

default

References UCI_InterfaceExtension().

~UCI_InterfaceExtension()

virtual wsf::UCI_InterfaceExtension::~UCI_InterfaceExtension ( )

virtualdefault

Member Function Documentation

AddedToSimulation()

void wsf::UCI_InterfaceExtension::AddedToSimulation ( )

overridevirtual

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

Reimplemented from WsfSimulationExtension.

References wsf::OMS_UCI_Extension::GetExtensionName(), GetInterface(), and WsfSimulationExtension::GetScenario().

Referenced by operator=().

Get()

const UCI_InterfaceExtension * wsf::UCI_InterfaceExtension::Get ( WsfSimulation & aSimulation )

static

References WsfSimulation::FindExtension(), GetExtensionName(), UCI_InterfaceExtension(), and WsfSimulationExtension::WsfSimulation.

Referenced by UCI_Util::GetInterface(), UCI_Util::GetInterface(), wsf::UCI_Component::GetInterface(), and wsf::UCI_Computer::Initialize().

GetExtensionName()

const char * wsf::UCI_InterfaceExtension::GetExtensionName ( )

inlinestatic

Referenced by Get(), and wsf::OMS_UCI_Extension::SimulationCreated().

GetInterface()

UCI_Interface * wsf::UCI_InterfaceExtension::GetInterface

(

)

const

Return the first interface in the map.

Referenced by AddedToSimulation().

operator=()

UCI_InterfaceExtension & wsf::UCI_InterfaceExtension::operator= ( const UCI_InterfaceExtension & aRhs )

delete

References AddedToSimulation(), and UCI_InterfaceExtension().

---

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

• WsfUCI_InterfaceExtension.hpp
• WsfUCI_InterfaceExtension.cpp