WsfAnnotationExtension Class Reference

#include <WsfAnnotation.hpp>

Inheritance diagram for WsfAnnotationExtension:

Collaboration diagram for WsfAnnotationExtension:

Public Member Functions
	WsfAnnotationExtension ()
void	AddedToScenario () override
bool	ProcessInput (UtInput &aInput) override
void	SimulationCreated (WsfSimulation &aSimulation) override
Public Member Functions inherited from WsfScenarioExtension
	WsfScenarioExtension ()
	~WsfScenarioExtension () override
WsfScenario &	GetScenario () const
WsfApplication &	GetApplication () const
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
Public Member Functions inherited from WsfAnnotationInput
bool	ProcessAnnotationInput (UtInput &aInput)
void	ProcessDecorationInput (UtInput &aInput)
void	ProcessPoiInput (UtInput &aInput)
void	ProcessRangeRingInput (UtInput &aInput)
AnnotationData::AnnotationInfo	GetAnnotationInfo () const

Additional Inherited Members
Protected Member Functions inherited from WsfExtension
void	InitializeExtensionName (const std::string &aName)
Protected Attributes inherited from WsfAnnotationInput
AnnotationData::AnnotationInfo	mAnnotationInfo

Constructor & Destructor Documentation

WsfAnnotationExtension()

WsfAnnotationExtension::WsfAnnotationExtension ( )

inline

Member Function Documentation

AddedToScenario()

void WsfAnnotationExtension::AddedToScenario ( )

overridevirtual

Called when the extension has been added to the scenario. This is typically used to register new component type objects and object factories, e.g.:

WsfScenario& scenario(GetScenario());
WsfMoverTypes::Get(scenario).AddCoreType("MY_MOVER", new MyMover(scenario));
WsfAntennaPatterTypes::Get(scenario).AddObjectFactor(MyAntennaPattern::ObjectFactory);

Script classes must NOT be registered here because they are global to the entire application. They should be registered in WsfApplication::AddedToApplication.

Note

GetScenario() and GetApplication() are now valid.

Reimplemented from WsfScenarioExtension.

References WsfEventPipeExtension::Find(), WsfScenarioExtension::GetScenario(), and wsf::annotation::EventPipe::RegisterEvents().

ProcessInput()

bool WsfAnnotationExtension::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.

References WsfAnnotationInput::ProcessAnnotationInput().

SimulationCreated()

void WsfAnnotationExtension::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 WsfAnnotationInput::mAnnotationInfo, and WsfSimulation::RegisterExtension().

---

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

• WsfAnnotation.hpp
• WsfAnnotation.cpp