WsfConfigureEclipseReport Class Reference

The scenario extension used to configure the Eclipse reports object. More...

#include <WsfEclipseReport.hpp>

Inheritance diagram for WsfConfigureEclipseReport:

Collaboration diagram for WsfConfigureEclipseReport:

Public Member Functions
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	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
Public Member Functions inherited from WsfEclipseReportData
	WsfEclipseReportData ()

Additional Inherited Members
Public Types inherited from WsfEclipseReportData
using	EclipseIntervalList = std::list<EclipseInterval>
using	EclipseMap = std::map<WsfStringId, EclipseIntervalList>
Public Attributes inherited from WsfEclipseReportData
bool	mReportAll
EclipseMap	mEclipseMap
std::string	mFileName
std::string	mFormat
Protected Member Functions inherited from WsfExtension
void	InitializeExtensionName (const std::string &aName)

Detailed Description

The scenario extension used to configure the Eclipse reports object.

Member Function Documentation

ProcessInput()

bool WsfConfigureEclipseReport::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 WsfEclipseReportData::mEclipseMap, WsfEclipseReportData::mFileName, WsfEclipseReportData::mFormat, and WsfEclipseReportData::mReportAll.

SimulationCreated()

void WsfConfigureEclipseReport::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(), WsfEclipseReportData::mEclipseMap, WsfEclipseReportData::mReportAll, and WsfSimulation::RegisterExtension().

---

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

• WsfEclipseReport.hpp
• WsfEclipseReport.cpp