wsf::simdis::ScenarioExtension Class Reference

#include <WsfSIMDIS_Interface.hpp>

Inheritance diagram for wsf::simdis::ScenarioExtension:

Collaboration diagram for wsf::simdis::ScenarioExtension:

Public Member Functions
	ScenarioExtension ()
void	SimulationCreated (WsfSimulation &aSimulation) override
bool	ProcessInput (UtInput &aInput) override
const std::string &	GetOutputFilename () const
const std::string &	GetHitIcon () const
const std::string &	GetKillIcon () const
const double	GetEventDuration () const
const bool	EnableBeams () const
const std::string &	GetBeamColor (const std::string &aSensorTypeName) const
const double	GetLatitude () const
const double	GetLongitude () const
const double	GetAltitude () const
const char	GetFHN (const std::string &aSide) const
Public Member Functions inherited from WsfScenarioExtension
	WsfScenarioExtension ()
	~WsfScenarioExtension () override
WsfScenario &	GetScenario () const
WsfApplication &	GetApplication () const
virtual void	AddedToScenario ()
virtual void	FileLoaded (const std::string &aFileName)
virtual bool	Complete ()
virtual bool	Complete2 ()
virtual bool	AlwaysCreate ()
Public Member Functions inherited from WsfExtension
virtual	~WsfExtension ()=default
const std::string &	GetExtensionName () const

Static Public Member Functions
static ScenarioExtension *	Find (const WsfScenario &aScenario)

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

Detailed Description

Scenario Extension. Reads scenario input related to output to SIMDIS asi files

Constructor & Destructor Documentation

ScenarioExtension()

wsf::simdis::ScenarioExtension::ScenarioExtension

(

)

References WsfScenarioExtension::WsfScenarioExtension().

Referenced by Find().

Member Function Documentation

EnableBeams()

const bool wsf::simdis::ScenarioExtension::EnableBeams ( ) const

inline

Find()

wsf::simdis::ScenarioExtension * wsf::simdis::ScenarioExtension::Find ( const WsfScenario & aScenario )

static

References WsfScenario::FindExtension(), ScenarioExtension(), and WsfScenarioExtension::WsfScenario.

GetAltitude()

const double wsf::simdis::ScenarioExtension::GetAltitude ( ) const

inline

GetBeamColor()

const std::string & wsf::simdis::ScenarioExtension::GetBeamColor

(

const std::string &

aSensorTypeName

)

const

GetEventDuration()

const double wsf::simdis::ScenarioExtension::GetEventDuration ( ) const

inline

GetFHN()

const char wsf::simdis::ScenarioExtension::GetFHN

(

const std::string &

aSide

)

const

GetHitIcon()

const std::string & wsf::simdis::ScenarioExtension::GetHitIcon ( ) const

inline

GetKillIcon()

const std::string & wsf::simdis::ScenarioExtension::GetKillIcon ( ) const

inline

GetLatitude()

const double wsf::simdis::ScenarioExtension::GetLatitude ( ) const

inline

GetLongitude()

const double wsf::simdis::ScenarioExtension::GetLongitude ( ) const

inline

GetOutputFilename()

const std::string & wsf::simdis::ScenarioExtension::GetOutputFilename ( ) const

inline

ProcessInput()

bool wsf::simdis::ScenarioExtension::ProcessInput ( UtInput & aInput )

overridevirtual

Process potential input for the extension. This method examines the current input command to determine if it is one that is recognized by the extension. If it is one recognized by the extension then it processes the command and returns 'true', otherwise it returns 'false'.

Parameters

aInput

a reference to a UtInput object.

Returns

'true' if the command was one recognized by the extension or 'false' if not.

Exceptions

UtInput::ExceptionBase

(or an object derived from it) if the command was recognized but contains some sort of error.

Reimplemented from WsfScenarioExtension.

SimulationCreated()

void wsf::simdis::ScenarioExtension::SimulationCreated ( WsfSimulation & aSimulation )

overridevirtual

Called when a simulation has been created. (Technically this is called upon entry to WsfSimulation::Initialize()). This is typically used when a scenario extension also requires a simulation extension. The method would typically register the simulation extension as follows:

aSimulation.RegisterExtension("my_ext", new MySimulationExtension());

Parameters

aSimulation

The simulation that is being created. See note below!

Note

This is called upon entry to WsfSimulation::Initialize() and nothing can be assumed about the state of the simulation.

See also

WsfSimulationExtension, WsfApplicationExtension::SimulationCreated

Reimplemented from WsfScenarioExtension.

References WsfExtension::GetExtensionName(), and WsfSimulation::RegisterExtension().

---

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

• WsfSIMDIS_Interface.hpp
• WsfSIMDIS_Interface.cpp