WSF
WsfXIO_Extension Class Reference

#include <WsfXIO_Extension.hpp>

Access to primary XIO objects created by the XIO extension.

Applications that use WSF_REGISTER_EXTENSION to request XIO services can use these methods to gain access to the XIO objects created by the extension. This is sometimes needed to force specific input values or to register new packet types.

static WSF_EXPORT WsfXIO_InputDataFind (const WsfScenario &aScenario)
 Return a pointer to the WsfXIO_InputData object for a given scenario.
static WSF_EXPORT WsfXIO_InterfaceFind (const WsfSimulation &aSimulation)
 Return a pointer to the WsfXIO_Interface object for a given simulation.

Access to lower level objects.

These are typically used internally by the XIO simulation components.

static WSF_EXPORT WsfXIO_SimulationFindSimulation (const WsfSimulation &aSimulation)
 Return a pointer to the WsfXIO_Simulation object for a given simulation.
static WSF_EXPORT WsfXIO_DisExtensionFindDisExtension (const WsfSimulation &aSimulation)
 Return a pointer to the WsfXIO_DisExtension object for a given simulation.

Detailed Description

Register the XIO application extension in a WSF application. A WSF application registers the XIO interface by including the following in their code:

WSF_REGISTER_EXTENSION(app, xio_interface);
#define WSF_REGISTER_EXTENSION(APP, NAME)
Definition WsfApplication.hpp:212

NOTE: You do not need to include this file to do the above.

This will register the scenario extension to process the 'xio_interface' block. If the scenario input includes a non-trivial 'xio_interface' block the extension will then register a simulation extension that provides all the XIO simulation services.

The static methods in this class simply provide access to the various low level components.

Member Function Documentation

◆ Find() [1/2]

WsfXIO_InputData * WsfXIO_Extension::Find ( const WsfScenario & aScenario)
static

Return a pointer to the WsfXIO_InputData object for a given scenario.

References WsfScenario::FindExtension().

Referenced by wsf::xio::EventPipe::EventPipe().

◆ Find() [2/2]

WsfXIO_Interface * WsfXIO_Extension::Find ( const WsfSimulation & aSimulation)
static

Return a pointer to the WsfXIO_Interface object for a given simulation.

References WsfSimulation::FindExtension().

◆ FindDisExtension()

WsfXIO_DisExtension * WsfXIO_Extension::FindDisExtension ( const WsfSimulation & aSimulation)
static

Return a pointer to the WsfXIO_DisExtension object for a given simulation.

References WsfSimulation::FindExtension().

◆ FindSimulation()

WsfXIO_Simulation * WsfXIO_Extension::FindSimulation ( const WsfSimulation & aSimulation)
static

Return a pointer to the WsfXIO_Simulation object for a given simulation.

References WsfSimulation::FindExtension().


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