WsfScenario Class Reference

Contains the data required to create a simulation, and acts as the entry point for input file processing. More...

#include <WsfScenario.hpp>

Collaboration diagram for WsfScenario:

Public Types
using	ScenarioExtensionMap = std::map<std::string, WsfScenarioExtension*>
using	ComponentFactoryList = std::vector<std::unique_ptr<WsfComponentFactoryBase>>
using	InputFunction = std::function<bool(UtInput&)>

Public Member Functions
	WsfScenario (WsfApplication &aApplication)
	WsfScenario (const WsfScenario &aSrc)=delete
WsfScenario &	operator= (const WsfScenario &)=delete
virtual	~WsfScenario ()=default
void	SetSimulationInput (WsfSimulationInput *aSimulationInput)
WsfApplication &	GetApplication () const
	Return a reference to the application to which this scenario is associated.
void	LoadFromFile (const std::string &aFileName)
void	LoadFromStream (UtInput &aInput)
bool	ProcessInput (UtInput &aInput)
void	CompleteLoad ()
void	ConfigureInput (UtInput &aInput)
bool	LoadIsComplete () const
void	ScenarioChange ()
bool	LoadPlatformInstance (UtInput &aInput)
void	SimulationCreated (WsfSimulation &aSimulation) const

Static Public Member Functions
static WsfScenario &	FromInput (UtInput &aInput)

Testing of expected/unexpected errors.
These are methods used by applications that generate errors and test to make sure they occur. Normally all errors are 'unexpected'.
using	ClassificationLevel = std::pair<std::string, UtColor>
class	ErrorTracker
WsfApplication *	mApplicationPtr
bool	mHadUnexpectedError
bool	mTestingForInputError
bool	mGotError
bool	mExpectInputError
bool	mExtensionsInOrder
bool	mLoadIsComplete
std::unique_ptr< UtInput >	mInputPtr
std::unique_ptr< WsfDeferredInput >	mDeferredInputPtr
int	mOpenConditionalBlocks
WsfStringTable	mStringTable
std::unique_ptr< WsfSimulationInput >	mSimulationInputPtr
UtScriptTypes *	mScriptTypesPtr
std::unique_ptr< UtScriptEnvironment >	mScriptEnvironmentPtr
std::unique_ptr< WsfScriptManager >	mScriptManagerPtr
std::unique_ptr< WsfEnvironment >	mEnvironmentPtr
std::unique_ptr< UtAtmosphere >	mAtmospherePtr
std::unique_ptr< WsfMessageTable >	mMessageTablePtr
std::unique_ptr< WsfPathFinderList >	mPathFinderListPtr
std::unique_ptr< wsf::TerrainInterface >	mTerrainInterfacePtr
std::unique_ptr< WsfIFF_Manager >	mIFF_ManagerPtr
std::vector< std::string >	mInputFiles
std::vector< InputFunction >	mInputFunctions
bool	mUseQuantitativeTrackQuality
std::vector< ClassificationLevel >	mClassificationsList
ClassificationLevel	mClassification
std::set< std::string >	mTrigraphsSet
std::set< std::string >	mCaveatsSet
size_t	mLevelIndex {ut::npos}
std::string	mSimulationName
unsigned int	mInitialRunNumber
	Monte Carlo.
unsigned int	mFinalRunNumber
	The final run number to be executed.
unsigned int	mRunNumberIncrement
	The increment between the run numbers.
long int	mInitialRandomSeed
	The seed used to generate sRandomSeeds.
long int	mInitialSeed
std::vector< long int >	mRandomSeeds
	A list of random number seeds indexed by run number.
std::vector< std::unique_ptr< WsfPlatform > >	mInputPlatforms
	The list of input platforms.
std::unique_ptr< WsfPlatformAvailability >	mPlatformAvailabilityPtr
	The 'platform_availability' of input platforms.
bool	HadUnexpectedError () const
bool	ExpectInputError () const
	Returns true in an error is expected.
const std::string &	GetSimulationName () const
virtual bool	ProcessInputP (UtInput &aInput)
bool	TypesProcessInput (UtInput &aInput)
bool	ExpectError () const
void	ExpectError (bool aExpectError)
	Declare if an error is expected.
void	CheckErrorFailure ()
	Check to see if an unexpected error occurred.
void	LoadFromStreamP (UtInput &aInput)
void	FileOpenCallback (const std::string &aFileName)
	Callback invoked by UtInput when opening a nested include file.
bool	ProcessExtensionInput (UtInput &aInput)
void	SortExtensions ()
void	BuildClassificationString ()
	Builds a string that holds the classification of a file along with its trigraphs and caveats.
size_t	FindClassificationLevel (const std::string &aLevel) const

Known type lists.
WsfAdvancedBehaviorTreeNodeTypes *	mAdvancedBehaviorTreeNodeTypesPtr
WsfAeroTypes *	mAeroTypesPtr
WsfAntennaPatternTypes *	mAntennaPatternTypesPtr
WsfBehaviorTreeNodeTypes *	mBehaviorTreeNodeTypesPtr
WsfCallbackTypes *	mCallbackTypesPtr
wsf::comm::Types *	mCommTypesPtr
WsfCorrelationStrategyTypes *	mCorrelationTypesPtr
WsfEM_ClutterTypes *	mEM_ClutterTypesPtr
WsfEM_AttenuationTypes *	mEM_AttenuationTypesPtr
WsfEM_PropagationTypes *	mEM_PropagationTypesPtr
WsfFilterTypes *	mFilterTypesPtr
WsfFuelTypes *	mFuelTypesPtr
WsfFusionStrategyTypes *	mFusionTypesPtr
WsfGroupTypes *	mGroupTypesPtr
WsfIntersectMeshTypes *	mIntersectMeshTypesPtr
WsfMaskingPatternTypes *	mMaskingPatternTypesPtr
wsf::comm::medium::Types *	mMediumTypesPtr
WsfMoverTypes *	mMoverTypesPtr
wsf::comm::NetworkTypes *	mNetworkTypesPtr
WsfNoiseCloudTypes *	mNoiseCloudTypesPtr
WsfPathFinderTypes *	mPathFinderTypesPtr
WsfPlatformTypes *	mPlatformTypesPtr
WsfProcessorTypes *	mProcessorTypesPtr
wsf::comm::ProtocolTypes *	mCommProtocolTypesPtr
WsfRouteTypes *	mRouteTypesPtr
wsf::comm::router::Types *	mRouterTypesPtr
wsf::comm::router::ProtocolTypes *	mRouterProtocolTypesPtr
WsfSensorErrorModelTypes *	mSensorErrorModelTypesPtr
WsfSensorTypes *	mSensorTypesPtr
WsfRadarSignatureTypes *	mRadarSignatureTypesPtr
WsfRouteNetworkTypes *	mRouteNetworkTypesPtr
wsf::TrackExtrapolationStrategyTypes *	mTrackExtrapolationStrategyTypesPtr
WsfTrackReportingStrategyTypes *	mTrackReportingStrategyTypesPtr
WsfThermalSystemTypes *	mThermalSystemTypesPtr
WsfThermalSystemComponentTypes *	mThermalSystemComponentTypesPtr
WsfVisualPartTypes *	mVisualPartTypesPtr
WsfZoneTypes *	mZoneTypesPtr
std::vector< std::unique_ptr< WsfObjectTypeListBaseI > >	mAllTypeLists
	All of the type lists in order of creation.
std::map< std::string, WsfObjectTypeListBaseI * >	mTypesListByKind
	All of the type lists by type.
std::unique_ptr< WsfSignatureList >	mSignatureListPrototypePtr
	Pointer to the prototype signature list.
std::unique_ptr< WsfExtensionList >	mExtensionListPtr
	The list of scenario extensions attached to the scenario.
ComponentFactoryList	mComponentFactoryList
	This list of component factories attached to the scenario.

Access to miscellaneous objects maintained by the scenario.
WsfDeferredInput &	GetDeferredInput ()
WsfSystemLog &	GetSystemLog () const
UtScriptTypes *	GetScriptTypes () const
WsfScriptManager *	GetScriptManager () const
WsfScriptContext *	GetScriptContext () const
WsfEnvironment &	GetEnvironment () const
const WsfMessageTable *	GetMessageTable () const
UtAtmosphere &	GetAtmosphere () const
WsfPathFinderList &	GetPathFinderList () const
WsfSimulationInput &	GetSimulationInput () const
wsf::TerrainInterface *	GetTerrainInterface () const
	Valid only after WsfScenario::CompleteLoad().
WsfIFF_Manager *	GetIFF_Manager () const
	Returns the IFF manager. The IFF manager is shared by multiple simulations, and must be const after CompleteLoad().
const WsfStringTable &	Strings () const
const std::vector< std::string > &	GetInputFiles () const
	Returns the input files given to LoadFromFile().
void	AddInputProcessor (const InputFunction &aFunction)
UtScriptEnvironment &	GetScriptEnvironment () const
UtInput &	GetInput () const
	Return the input object used to read scenario inputs.

Scenario extension registration and query methods.
WsfScenarioExtension *	FindExtension (const std::string &aName) const
WsfScenarioExtension &	GetExtension (const std::string &aName) const
void	RegisterExtension (const std::string &aName, std::unique_ptr< WsfScenarioExtension > aExtensionPtr)
void	ExtensionDepends (const std::string &aExtensionName, const std::string &aDependsOnExtensionName, bool aRequired)
const WsfExtensionList &	GetExtensions () const

Component factory registration and access.
void	RegisterComponentFactory (std::unique_ptr< WsfComponentFactoryBase > aFactoryPtr)
const ComponentFactoryList &	GetComponentFactoryList () const

Methods to find and clone objects within the type lists.
WsfObject *	FindType (const std::string &aTypeKind, WsfStringId aTypeName) const
template<typename T>
T *	FindTypeT (const std::string &aTypeName)
WsfObject *	CloneType (const std::string &aTypeKind, WsfStringId aTypeName) const
template<typename T>
T *	CloneTypeT (WsfStringId aTypeName) const
void	AddTypeList (std::unique_ptr< WsfObjectTypeListBaseI > aTypeListPtr)
WsfObjectTypeListBaseI *	GetTypes (const std::string &aTypesKind) const
	Returns the type list of the given name, or null if it does not exist.
std::vector< WsfObjectTypeListBaseI * >	GetTypeLists () const

Access to known type lists.
WsfAdvancedBehaviorTreeNodeTypes &	GetAdvancedBehaviorTreeNodeTypes () const
WsfAeroTypes &	GetAeroTypes () const
WsfAntennaPatternTypes &	GetAntennaPatternTypes () const
WsfBehaviorTreeNodeTypes &	GetBehaviorTreeNodeTypes () const
WsfCallbackTypes &	GetCallbackTypes () const
wsf::comm::Types &	GetCommTypes () const
WsfCorrelationStrategyTypes &	GetCorrelationTypes () const
WsfEM_AttenuationTypes &	GetEM_AttenuationTypes () const
WsfEM_ClutterTypes &	GetEM_ClutterTypes () const
WsfEM_PropagationTypes &	GetEM_PropagationTypes () const
WsfFilterTypes &	GetFilterTypes () const
WsfFuelTypes &	GetFuelTypes () const
WsfFusionStrategyTypes &	GetFusionTypes () const
WsfGroupTypes &	GetGroupTypes () const
WsfIntersectMeshTypes &	GetIntersectMeshTypes () const
WsfMaskingPatternTypes &	GetMaskingPatternTypes () const
wsf::comm::medium::Types &	GetMediumTypes () const
WsfMoverTypes &	GetMoverTypes () const
wsf::comm::NetworkTypes &	GetNetworkTypes () const
WsfNoiseCloudTypes &	GetNoiseCloudTypes () const
WsfPathFinderTypes &	GetPathFinderTypes () const
WsfPlatformTypes &	GetPlatformTypes () const
WsfProcessorTypes &	GetProcessorTypes () const
wsf::comm::ProtocolTypes &	GetProtocolTypes () const
WsfRadarSignatureTypes &	GetRadarSignatureTypes () const
WsfRouteTypes &	GetRouteTypes () const
WsfRouteNetworkTypes &	GetRouteNetworkTypes () const
wsf::comm::router::Types &	GetRouterTypes () const
wsf::comm::router::ProtocolTypes &	GetRouterProtocolTypes () const
WsfSensorErrorModelTypes &	GetSensorErrorModelTypes () const
WsfSensorTypes &	GetSensorTypes () const
WsfThermalSystemTypes &	GetThermalSystemTypes () const
WsfThermalSystemComponentTypes &	GetThermalSystemComponentTypes () const
wsf::TrackExtrapolationStrategyTypes &	GetTrackExtrapolationStrategyTypes () const
WsfTrackReportingStrategyTypes &	GetTrackReportingStrategyTypes () const
WsfVisualPartTypes &	GetVisualPartTypes () const
WsfZoneTypes &	GetZoneTypes () const

Monte-Carlo iteration control
The following methods can be used to perform a series of monte-carlo iterations, e.g.: for (unsigned int runNumber = simInput.GetInitalRunNumber(); runNumber <= simInput.GetFinalRunNumber();) { WsfSimulation* simPtr = app.CreateSimulation(scenario, options); ... run simulation delete simPtr; runNumber += simInput.GetRunNumberIncrement(); }
unsigned int	GetInitalRunNumber () const
	Get the run number of the initial iteration.
unsigned int	GetFinalRunNumber () const
	Get the run number of the final iteration.
unsigned int	GetRunNumberIncrement () const
	Get the increment between run numbers.
void	SetInitialRunNumber (unsigned int aInitialRunNumber)
	Set the initial run number.
void	SetFinalRunNumber (unsigned int aFinalRunNumber)
	Set the final run number.
void	SetRunNumberIncrement (unsigned int aRunNumberIncrement)
	Set the increment between run numbers.
long int	GetRandomSeed (unsigned int aRunNumber) const
	Get/Set the random seed for this specified run number.
long int	GetInitialSeed () const
void	SetInitialSeed (long int aInitialSeed)
const std::string &	GetClassificationString () const
const UtColor &	GetClassificationColor () const

Input platform methods.
bool	AddInputPlatform (std::unique_ptr< WsfPlatform > aPlatformPtr)
WsfPlatform *	GetInputPlatformByName (WsfStringId aNameId)
const WsfPlatform *	GetInputPlatformByName (WsfStringId aNameId) const
unsigned int	GetInputPlatformCount () const
WsfPlatform *	GetInputPlatformEntry (unsigned int aEntry) const
bool	PlatformIsAvailable (WsfPlatform *aPlatformPtr, WsfSimulation &aSimulation) const
bool	UseQuantitativeTrackQuality () const
	Return whether the simulation is using quantitative track quality.

Prototype WsfSignatureList maintenance.
const WsfSignatureList &	GetSignatureListPrototype () const
WsfSignatureList &	GetSignatureListPrototype ()

Detailed Description

Contains the data required to create a simulation, and acts as the entry point for input file processing.

Member Typedef Documentation

ClassificationLevel

using WsfScenario::ClassificationLevel = std::pair<std::string, UtColor>

protected

ComponentFactoryList

using WsfScenario::ComponentFactoryList = std::vector<std::unique_ptr<WsfComponentFactoryBase>>

InputFunction

using WsfScenario::InputFunction = std::function<bool(UtInput&)>

ScenarioExtensionMap

using WsfScenario::ScenarioExtensionMap = std::map<std::string, WsfScenarioExtension*>

Constructor & Destructor Documentation

WsfScenario() [1/2]

WsfScenario::WsfScenario

(

WsfApplication &

aApplication

)

References ConfigureInput(), GetScriptTypes(), mAllTypeLists, mApplicationPtr, mAtmospherePtr, mComponentFactoryList, mDeferredInputPtr, mEnvironmentPtr, mExpectInputError, mExtensionListPtr, mExtensionsInOrder, mFinalRunNumber, mGotError, mHadUnexpectedError, mIFF_ManagerPtr, mInitialRandomSeed, mInitialRunNumber, mInitialSeed, mInputFiles, mInputFunctions, mInputPlatforms, mInputPtr, mLoadIsComplete, mMessageTablePtr, mOpenConditionalBlocks, mPathFinderListPtr, mPlatformAvailabilityPtr, mRandomSeeds, mRunNumberIncrement, mScriptEnvironmentPtr, mScriptManagerPtr, mScriptTypesPtr, mSignatureListPrototypePtr, mSimulationInputPtr, mStringTable, mTerrainInterfacePtr, mTestingForInputError, mTypesListByKind, mUseQuantitativeTrackQuality, and RegisterExtension().

Referenced by FromInput(), GetInputPlatformByName(), operator=(), and WsfScenario().

WsfScenario() [2/2]

WsfScenario::WsfScenario ( const WsfScenario & aSrc )

delete

References WsfScenario().

~WsfScenario()

virtual WsfScenario::~WsfScenario ( )

virtualdefault

References SetSimulationInput().

Member Function Documentation

AddInputPlatform()

bool WsfScenario::AddInputPlatform

(

std::unique_ptr< WsfPlatform >

aPlatformPtr

)

Add an 'initial state' or 'input' platform.

Add a platform that is to be considered part of the initial state of the simulation. This method can only be used to add platforms prior to calling WsfSimulation::Initialize. This is typically used by WsfSimulationLoader to add platforms defined in an input file.

It is an error to invoke this after WsfSimulation::Initialize has been called.

Parameters

aPlatformPtr

Pointer to the platform to be added. This class assumes ownership of the platform.

Returns

'true' if the platform was added or 'false' if an not.

Note

The list of 'initial state' platforms is maintained separately from the list of 'active' platforms. The 'initial state' platforms are copied to the list of 'active' platforms by WsfSimulation::Initialize.

References mInputPlatforms, and ok.

Referenced by LoadPlatformInstance().

AddInputProcessor()

void WsfScenario::AddInputProcessor

(

const InputFunction &

aFunction

)

References mInputFunctions.

AddTypeList()

void WsfScenario::AddTypeList

(

std::unique_ptr< WsfObjectTypeListBaseI >

aTypeListPtr

)

References mAllTypeLists, and mTypesListByKind.

Referenced by wsf::coverage::ScenarioExtension::AddedToScenario(), wsf::cyber::ScenarioExtension::AddedToScenario(), wsf::space::AtmosphereScenarioExtension::AddedToScenario(), WsfMilExtension::AddedToScenario(), and WsfSpaceExtension::AddedToScenario().

BuildClassificationString()

void WsfScenario::BuildClassificationString ( )

protected

Builds a string that holds the classification of a file along with its trigraphs and caveats.

References mCaveatsSet, mClassification, mClassificationsList, mLevelIndex, and mTrigraphsSet.

Referenced by CompleteLoad().

CheckErrorFailure()

void WsfScenario::CheckErrorFailure ( )

protected

Check to see if an unexpected error occurred.

References mExpectInputError, mGotError, mHadUnexpectedError, and mTestingForInputError.

Referenced by CompleteLoad(), ExpectError(), and LoadFromFile().

CloneType()

WsfObject * WsfScenario::CloneType	(	const std::string &	aTypeKind,
		WsfStringId	aTypeName ) const

Clone a type object of the specified kind and name.

Parameters

aTypeKind	The kind of type object that is to be cloned (e.g.: "sensor", "processor", etc.). This is generally the 3rd argument to the constructor of WsfObjectTypeList<T>.
aTypeName	The name of the type object that is to be cloned.

Returns

The pointer to a copy of the requested object. This will be the null pointer if the requested object could not be found.

References WsfObjectTypeListBaseI::Clone(), and GetTypes().

Referenced by CloneTypeT(), WsfP6DOF_Mover::CommonSubobjectJettisonTasks(), and WsfExplicitWeapon::Fire().

CloneTypeT()

template<typename T>

T * WsfScenario::CloneTypeT ( WsfStringId aTypeName ) const

inline

A typesafe version of CloneType.

Parameters

aTypeName

The name of the type object to be located.

References CloneType().

Referenced by WsfEM_XmtrRcvr::ProcessInput(), and WsfHybridMover::ProcessInput().

CompleteLoad()

void WsfScenario::CompleteLoad

(

)

References BuildClassificationString(), CheckErrorFailure(), WsfScenarioExtension::Complete(), WsfScenarioExtension::Complete2(), FindExtension(), GetZoneTypes(), WsfZoneTypes::InitializeZones(), mAllTypeLists, mDeferredInputPtr, mExtensionListPtr, mExtensionsInOrder, mFinalRunNumber, mGotError, mInitialRandomSeed, mInputPlatforms, mInputPtr, mLoadIsComplete, mMessageTablePtr, mRandomSeeds, mSimulationInputPtr, and mTerrainInterfacePtr.

Referenced by WsfStandardApplication::ProcessInputFiles().

ConfigureInput()

void WsfScenario::ConfigureInput

(

UtInput &

aInput

)

References mExtensionsInOrder, and SortExtensions().

Referenced by LoadFromStreamP(), ProcessInput(), and WsfScenario().

ExpectError() [1/2]

bool WsfScenario::ExpectError ( ) const

inlineprotected

References mExpectInputError.

Referenced by ProcessInputP().

ExpectError() [2/2]

void WsfScenario::ExpectError ( bool aExpectError )

protected

Declare if an error is expected.

References CheckErrorFailure(), mExpectInputError, and mGotError.

ExpectInputError()

bool WsfScenario::ExpectInputError ( ) const

inline

Returns true in an error is expected.

References mExpectInputError.

ExtensionDepends()

void WsfScenario::ExtensionDepends	(	const std::string &	aExtensionName,
		const std::string &	aDependsOnExtensionName,
		bool	aRequired )

Add a new extension dependency. This guarantees that one extension is initialized before another. Because the initialization order is inherited by the simulation extensions, the dependency only needs declared here. This will override any dependencies defined in the application.

Parameters

aExtensionName	The name of the dependent extension
aDependsOnExtensionName	The name of the extension to be initialized first
aRequired	'true' if the dependent extension cannot be used without the other 'false' if the dependent extension can still be used without the other

References mExtensionListPtr.

FileOpenCallback()

void WsfScenario::FileOpenCallback ( const std::string & aFileName )

protected

Callback invoked by UtInput when opening a nested include file.

References GetSystemLog(), and WsfSystemLog::WriteLogEntry().

Referenced by LoadFromFile().

FindClassificationLevel()

size_t WsfScenario::FindClassificationLevel ( const std::string & aLevel ) const

protected

References mClassificationsList.

Referenced by ProcessInputP().

FindExtension()

WsfScenarioExtension * WsfScenario::FindExtension

(

const std::string &

aName

)

const

Return pointer to the extension with the given name.

Returns

null if the extension does not exist.

References mExtensionListPtr.

Referenced by CompleteLoad(), Fires::FiresTables::Find(), ToolManager::Find(), wsf::dis::ScenarioExtension::Find(), wsf::simdis::ScenarioExtension::Find(), WsfEventPipeExtension::Find(), WsfExtInput::Find(), WsfL16_Extension::Find(), WsfMilExtension::Find(), WsfMultiresolutionMultirunTable::Find(), WsfSensorPlotExtension::Find(), WsfXIO_Extension::Find(), engage::InputConfig::FindExtension(), Fires::FiresPath::FiresPath(), wsf::cyber::ScenarioExtension::Get(), wsf::EarthGravityModelExtension::Get(), wsf::OMS_UCI_Extension::Get(), WsfMilExtension::Get(), WsfSpaceExtension::Get(), WsfSOSM_Sensor::Initialize(), wsf::six_dof::PointMassMover::PointMassMover(), WsfDisInput::ProcessDeviceInput(), WsfBallisticMissileLaunchComputer::ProcessInput(), ProcessInputP(), wsf::six_dof::RigidBodyMover::RigidBodyMover(), SimulationCreated(), and weapon_tools().

FindType()

WsfObject * WsfScenario::FindType	(	const std::string &	aTypeKind,
		WsfStringId	aTypeName ) const

Find a type object of the specified kind and name.

Parameters

aTypeKind	The kind of type object that is to be found (e.g.: "sensor", "processor", etc.). This is generally the 3rd argument to the constructor of WsfObjectTypeList<T>.
aTypeName	The name of the type object that is to be found.

Returns

The pointer to the requested object. This will be the null pointer if the requested object could not be found.

References WsfObjectTypeListBaseI::Find(), and GetTypes().

Referenced by WsfExtEmission::AddSensor(), FindTypeT(), WsfChaffWeapon::Initialize(), WsfNavigationMesh::ProcessInput(), WsfPathFinder::ProcessInput(), WsfTerrainPathFinder::ProcessInput(), WsfZoneDefinition::ProcessInput(), WsfRoute::ProcessNavigationInput(), and UT_DEFINE_SCRIPT_METHOD().

FindTypeT()

template<typename T>

T * WsfScenario::FindTypeT ( const std::string & aTypeName )

inline

A typesafe version of FindType.

Parameters

aTypeName

The name of the type object to be located.

References FindType().

Referenced by WsfATG_WeaponLAR::ProcessInput(), WsfESA_AntennaPattern::ESA_Data::ProcessInput(), and UT_DEFINE_SCRIPT_METHOD().

FromInput()

WsfScenario & WsfScenario::FromInput ( UtInput & aInput )

static

References WsfScenario().

Referenced by WsfBehaviorTree::CreateNode(), wsf::multiresolution::GetObjectTypeList(), ATG_LAR_And_LC_Generator::ProcessInput(), Fires::FiresLaunchComputer::ProcessInput(), wsf::altloc::Component::ProcessInput(), wsf::six_dof::PointMassMover::ProcessInput(), wsf::six_dof::RigidBodyMover::ProcessInput(), WsfAirToAirLaunchComputer::ProcessInput(), WsfALARM_AntennaPattern::ALARM_Data::ProcessInput(), WsfATG_WeaponLAR::ProcessInput(), WsfBallisticMissileLaunchComputer::ProcessInput(), WsfBrawlerMover::ProcessInput(), WsfCompositeSensor::ProcessInput(), WsfEM_ITU_Attenuation::ProcessInput(), WsfEM_Rcvr::ProcessInput(), WsfEM_Xmtr::ProcessInput(), WsfEM_XmtrRcvr::ProcessInput(), WsfESA_AntennaPattern::ESA_Data::ProcessInput(), WsfEW_EA_EP::ProcessInput(), WsfEW_FalseTargetEffect::FT_Data::ProcessInput(), WsfEW_SLB_Effect::ProcessInput(), WsfEW_SLC_Effect::ProcessInput(), WsfEW_Technique::ProcessInput(), WsfNavigationMesh::ProcessInput(), WsfObject::ProcessInput(), WsfOTH_RadarSensor::OTH_Beam::ProcessInput(), WsfP6DOF_Mover::ProcessInput(), WsfPathFinder::ProcessInput(), WsfRadarSensor::RadarBeam::ProcessInput(), WsfRouteMover::ProcessInput(), WsfRouteNetwork::ProcessInput(), WsfScriptStateMachine::State::ProcessInput(), WsfSensorMode::ProcessInput(), WsfTerrainPathFinder::ProcessInput(), WsfThermalSystem::ProcessInput(), WsfThermalSystemComponent::ProcessInput(), WsfZoneDefinition::ProcessInput(), and WsfRoute::ProcessNavigationInput().

GetAdvancedBehaviorTreeNodeTypes()

WsfAdvancedBehaviorTreeNodeTypes & WsfScenario::GetAdvancedBehaviorTreeNodeTypes ( ) const

inline

References mAdvancedBehaviorTreeNodeTypesPtr.

GetAeroTypes()

WsfAeroTypes & WsfScenario::GetAeroTypes ( ) const

inline

References mAeroTypesPtr.

Referenced by WsfAeroTypes::Get(), and WsfAeroTypes::Get().

GetAntennaPatternTypes()

WsfAntennaPatternTypes & WsfScenario::GetAntennaPatternTypes ( ) const

inline

References mAntennaPatternTypesPtr.

Referenced by WsfAntennaPatternTypes::Get(), and WsfAntennaPatternTypes::Get().

GetApplication()

WsfApplication & WsfScenario::GetApplication ( ) const

inline

Return a reference to the application to which this scenario is associated.

References mApplicationPtr.

Referenced by WsfSpaceExtension::AddedToScenario(), WsfSimulation::GetApplication(), ProcessInputP(), and SimulationCreated().

GetAtmosphere()

UtAtmosphere & WsfScenario::GetAtmosphere ( ) const

inline

References mAtmospherePtr.

Referenced by wsf::six_dof::Environment::AddedToScenario(), WsfBrawlerFuel::CalcConsumptionRate(), WsfAirMover::GetThrottlePosition(), ATG_LAR_And_LC_Generator::LARGenUpdate(), ATA_LaunchComputerGenerator::ProcessInput(), ATG_LAR_And_LC_Generator::ProcessInput(), ATA_LaunchComputerGenerator::ResolveNames(), ATA_LaunchComputerGenerator::WriteOutputFile(), ATG_LAR_And_LC_Generator::WriteOutputFile(), WsfAeroTypes::WsfAeroTypes(), and WsfLaunchComputerTypes::WsfLaunchComputerTypes().

GetBehaviorTreeNodeTypes()

WsfBehaviorTreeNodeTypes & WsfScenario::GetBehaviorTreeNodeTypes ( ) const

inline

References mBehaviorTreeNodeTypesPtr.

Referenced by WsfBehaviorTree::CreateNode().

GetCallbackTypes()

WsfCallbackTypes & WsfScenario::GetCallbackTypes ( ) const

inline

References mCallbackTypesPtr.

Referenced by WsfCallbackTypes::Get(), and WsfCallbackTypes::Get().

GetClassificationColor()

const UtColor & WsfScenario::GetClassificationColor ( ) const

inline

References mClassification.

GetClassificationString()

const std::string & WsfScenario::GetClassificationString ( ) const

inline

References mClassification.

Referenced by WsfStandardApplication::InitializeSimulation(), and wsf::event::output::SimulationExtension::OpenFile().

GetCommTypes()

wsf::comm::Types & WsfScenario::GetCommTypes ( ) const

inline

References mCommTypesPtr.

Referenced by wsf::comm::Types::Get(), and wsf::comm::Types::Get().

GetComponentFactoryList()

const ComponentFactoryList & WsfScenario::GetComponentFactoryList ( ) const

inline

References mComponentFactoryList.

GetCorrelationTypes()

WsfCorrelationStrategyTypes & WsfScenario::GetCorrelationTypes ( ) const

inline

References mCorrelationTypesPtr.

Referenced by WsfCorrelationStrategyTypes::Get(), and WsfCorrelationStrategyTypes::Get().

GetDeferredInput()

WsfDeferredInput & WsfScenario::GetDeferredInput

(

)

References mDeferredInputPtr.

Referenced by WsfEW_EffectTypes::LoadInstance(), WsfEW_TechniqueTypes::LoadInstance(), WsfFilterTypes::LoadInstance(), WsfRouteTypes::LoadInstance(), LoadPlatformInstance(), WsfPlatformTypes::LoadType(), wsf::altloc::Component::ProcessInput(), WsfEW_FalseTargetEffect::FT_Data::ProcessInput(), and WsfRoute::ProcessNavigationInput().

GetEM_AttenuationTypes()

WsfEM_AttenuationTypes & WsfScenario::GetEM_AttenuationTypes ( ) const

inline

References mEM_AttenuationTypesPtr.

Referenced by WsfEM_AttenuationTypes::Get(), and WsfEM_AttenuationTypes::Get().

GetEM_ClutterTypes()

WsfEM_ClutterTypes & WsfScenario::GetEM_ClutterTypes ( ) const

inline

References mEM_ClutterTypesPtr.

Referenced by WsfEM_ClutterTypes::Get(), and WsfEM_ClutterTypes::Get().

GetEM_PropagationTypes()

WsfEM_PropagationTypes & WsfScenario::GetEM_PropagationTypes ( ) const

inline

References mEM_PropagationTypesPtr.

Referenced by WsfEM_PropagationTypes::Get(), and WsfEM_PropagationTypes::Get().

GetEnvironment()

WsfEnvironment & WsfScenario::GetEnvironment ( ) const

inline

References mEnvironmentPtr.

Referenced by wsf::six_dof::Environment::AddedToScenario(), WsfEM_ALARM_Attenuation::atmosphere::attenuation(), WsfEM_ALARM_Clutter::Initialize(), WsfNoiseCloud::Initialize(), and WsfRadarMTI_AdjSignalProcessor::Initialize().

GetExtension()

WsfScenarioExtension & WsfScenario::GetExtension

(

const std::string &

aName

)

const

Return the extension with the given name.

Exceptions

UnknownExtension

if the extension does not exist.

References mExtensionListPtr.

Referenced by WsfP6DOF_Mover::CommonSubobjectJettisonTasks(), WsfMultiresolutionTypes< DerivedComponent >::Get(), WsfMultiresolutionTypes< DerivedComponent >::Get(), IADSC2ScenarioExtension::GetGlobalLogger(), WsfP6DOF_Mover::InitializeSubobject(), and WsfP6DOF_Mover::ProcessInput().

GetExtensions()

const WsfExtensionList & WsfScenario::GetExtensions ( ) const

inline

References mExtensionListPtr.

GetFilterTypes()

WsfFilterTypes & WsfScenario::GetFilterTypes ( ) const

inline

References mFilterTypesPtr.

Referenced by WsfFilterTypes::Get(), and WsfFilterTypes::Get().

GetFinalRunNumber()

unsigned int WsfScenario::GetFinalRunNumber ( ) const

inline

Get the run number of the final iteration.

References mFinalRunNumber.

Referenced by WsfSimulation::GetFinalRunNumber(), WsfStandardApplication::InitializeSimulation(), and main().

GetFuelTypes()

WsfFuelTypes & WsfScenario::GetFuelTypes ( ) const

inline

References mFuelTypesPtr.

Referenced by WsfFuelTypes::Get(), and WsfFuelTypes::Get().

GetFusionTypes()

WsfFusionStrategyTypes & WsfScenario::GetFusionTypes ( ) const

inline

References mFusionTypesPtr.

Referenced by WsfFusionStrategyTypes::Get(), and WsfFusionStrategyTypes::Get().

GetGroupTypes()

WsfGroupTypes & WsfScenario::GetGroupTypes ( ) const

inline

References mGroupTypesPtr.

Referenced by WsfGroupTypes::Get(), WsfGroupTypes::Get(), WsfGroupList::ProcessInput(), and WsfGroupList::ProcessInput().

GetIFF_Manager()

WsfIFF_Manager * WsfScenario::GetIFF_Manager ( ) const

inline

Returns the IFF manager. The IFF manager is shared by multiple simulations, and must be const after CompleteLoad().

References mIFF_ManagerPtr.

GetInitalRunNumber()

unsigned int WsfScenario::GetInitalRunNumber ( ) const

inline

Get the run number of the initial iteration.

References mInitialRunNumber.

Referenced by main().

GetInitialSeed()

long int WsfScenario::GetInitialSeed ( ) const

inline

References mInitialSeed.

GetInput()

UtInput & WsfScenario::GetInput ( ) const

inline

Return the input object used to read scenario inputs.

References mInputPtr.

Referenced by WsfStandardApplication::ProcessCommandLineCommands(), and WsfTSPI_Mover::SetFileName().

GetInputFiles()

const std::vector< std::string > & WsfScenario::GetInputFiles ( ) const

inline

Returns the input files given to LoadFromFile().

References mInputFiles.

GetInputPlatformByName() [1/2]

WsfPlatform * WsfScenario::GetInputPlatformByName

(

WsfStringId

aNameId

)

Return a pointer to the 'input' platform given the string ID of the platform name.

Returns

The pointer to the platform or 0 if the platform does not exist.

References mInputPlatforms, and platformPtr.

Referenced by WsfConfigureAccessReport::Complete(), GetInputPlatformByName(), LoadPlatformInstance(), wsf::altloc::Component::ProcessInput(), and WsfTrack::ProcessInputBlock().

GetInputPlatformByName() [2/2]

const WsfPlatform * WsfScenario::GetInputPlatformByName

(

WsfStringId

aNameId

)

const

Return a pointer to the 'input' platform given the string ID of the platform name.

Returns

The pointer to the platform or 0 if the platform does not exist.

References GetInputPlatformByName(), and WsfScenario().

GetInputPlatformCount()

unsigned int WsfScenario::GetInputPlatformCount

(

)

const

Return the number of platforms in the input platform list.

Returns

the number of platform in the input platform list.

References mInputPlatforms.

Referenced by WsfConfigureAccessReport::Complete(), and notifyOfPlatformsNotPresentInSimulation().

GetInputPlatformEntry()

WsfPlatform * WsfScenario::GetInputPlatformEntry

(

unsigned int

aEntry

)

const

Return a specific entry from the list of input platforms.

Parameters

aEntry

The slot of the desired entry. It must be valid, i.e.: 0 <= aEntry < GetInputPlatformCount().

Returns

Pointer to the requested input platform.

References mInputPlatforms.

Referenced by WsfConfigureAccessReport::Complete(), and notifyOfPlatformsNotPresentInSimulation().

GetIntersectMeshTypes()

WsfIntersectMeshTypes & WsfScenario::GetIntersectMeshTypes ( ) const

inline

References mIntersectMeshTypesPtr.

Referenced by WsfIntersectMeshTypes::Get(), and WsfIntersectMeshTypes::Get().

GetMaskingPatternTypes()

WsfMaskingPatternTypes & WsfScenario::GetMaskingPatternTypes ( ) const

inline

References mMaskingPatternTypesPtr.

Referenced by WsfMaskingPatternTypes::Get(), and WsfMaskingPatternTypes::Get().

GetMediumTypes()

wsf::comm::medium::Types & WsfScenario::GetMediumTypes ( ) const

inline

References mMediumTypesPtr.

Referenced by wsf::comm::medium::Types::Get().

GetMessageTable()

const WsfMessageTable * WsfScenario::GetMessageTable ( ) const

inline

References mMessageTablePtr.

Referenced by wsf::comm::Comm::SendSetup().

GetMoverTypes()

WsfMoverTypes & WsfScenario::GetMoverTypes ( ) const

inline

References mMoverTypesPtr.

Referenced by WsfMoverTypes::Get(), and WsfMoverTypes::Get().

GetNetworkTypes()

wsf::comm::NetworkTypes & WsfScenario::GetNetworkTypes ( ) const

inline

References mNetworkTypesPtr.

Referenced by wsf::comm::NetworkTypes::Get(), and wsf::comm::NetworkTypes::Get().

GetNoiseCloudTypes()

WsfNoiseCloudTypes & WsfScenario::GetNoiseCloudTypes ( ) const

inline

References mNoiseCloudTypesPtr.

Referenced by WsfNoiseCloudTypes::Get(), and WsfNoiseCloudTypes::Get().

GetPathFinderList()

WsfPathFinderList & WsfScenario::GetPathFinderList ( ) const

inline

References mPathFinderListPtr.

Referenced by WsfPathFinderTypes::LoadInstance(), and WsfRouteMover::ProcessInput().

GetPathFinderTypes()

WsfPathFinderTypes & WsfScenario::GetPathFinderTypes ( ) const

inline

References mPathFinderTypesPtr.

GetPlatformTypes()

WsfPlatformTypes & WsfScenario::GetPlatformTypes ( ) const

inline

References mPlatformTypesPtr.

Referenced by WsfPlatformTypes::Get(), WsfPlatformTypes::Get(), WsfP6DOF_Mover::InitializeSubobject(), LoadPlatformInstance(), and wsf::coverage::RectangularGrid::PreparePlatforms().

GetProcessorTypes()

WsfProcessorTypes & WsfScenario::GetProcessorTypes ( ) const

inline

References mProcessorTypesPtr.

Referenced by WsfProcessorTypes::Get(), and WsfProcessorTypes::Get().

GetProtocolTypes()

wsf::comm::ProtocolTypes & WsfScenario::GetProtocolTypes ( ) const

inline

References mCommProtocolTypesPtr.

Referenced by wsf::comm::ProtocolTypes::Get(), and wsf::comm::ProtocolTypes::Get().

GetRadarSignatureTypes()

WsfRadarSignatureTypes & WsfScenario::GetRadarSignatureTypes ( ) const

inline

References mRadarSignatureTypesPtr.

Referenced by WsfRadarSignatureTypes::Get(), and WsfRadarSignatureTypes::Get().

GetRandomSeed()

long int WsfScenario::GetRandomSeed

(

unsigned int

aRunNumber

)

const

Get/Set the random seed for this specified run number.

References mInitialSeed, and mRandomSeeds.

Referenced by WsfSimulation::WsfSimulation().

GetRouteNetworkTypes()

WsfRouteNetworkTypes & WsfScenario::GetRouteNetworkTypes ( ) const

inline

References mRouteNetworkTypesPtr.

Referenced by WsfRouteNetworkTypes::Get(), and WsfRouteNetworkTypes::Get().

GetRouterProtocolTypes()

wsf::comm::router::ProtocolTypes & WsfScenario::GetRouterProtocolTypes ( ) const

inline

References mRouterProtocolTypesPtr.

Referenced by wsf::comm::router::ProtocolTypes::Get(), and wsf::comm::router::ProtocolTypes::Get().

GetRouterTypes()

wsf::comm::router::Types & WsfScenario::GetRouterTypes ( ) const

inline

References mRouterTypesPtr.

Referenced by wsf::comm::router::Types::Get(), and wsf::comm::router::Types::Get().

GetRouteTypes()

WsfRouteTypes & WsfScenario::GetRouteTypes ( ) const

inline

References mRouteTypesPtr.

Referenced by WsfRouteTypes::Get(), and WsfRouteTypes::Get().

GetRunNumberIncrement()

unsigned int WsfScenario::GetRunNumberIncrement ( ) const

inline

Get the increment between run numbers.

References mRunNumberIncrement.

Referenced by main().

GetScriptContext()

WsfScriptContext * WsfScenario::GetScriptContext

(

)

const

Returns the global script context.

Note

This should only be used BEFORE the simulation is created. The simulation will use a copy of this context!

References mScriptManagerPtr.

Referenced by IADSC2ScenarioExtension::AddedToScenario(), and wsf::cyber::Attack::Initialize().

GetScriptEnvironment()

UtScriptEnvironment & WsfScenario::GetScriptEnvironment ( ) const

inline

References mScriptEnvironmentPtr.

GetScriptManager()

WsfScriptManager * WsfScenario::GetScriptManager ( ) const

inline

References mScriptManagerPtr.

GetScriptTypes()

UtScriptTypes * WsfScenario::GetScriptTypes ( ) const

inline

References mScriptTypesPtr.

Referenced by UT_DEFINE_SCRIPT_METHOD(), and WsfScenario().

GetSensorErrorModelTypes()

WsfSensorErrorModelTypes & WsfScenario::GetSensorErrorModelTypes ( ) const

inline

References mSensorErrorModelTypesPtr.

Referenced by WsfSensorErrorModelTypes::Get(), and WsfSensorErrorModelTypes::Get().

GetSensorTypes()

WsfSensorTypes & WsfScenario::GetSensorTypes ( ) const

inline

References mSensorTypesPtr.

Referenced by WsfSensorTypes::Get(), and WsfSensorTypes::Get().

GetSignatureListPrototype() [1/2]

WsfSignatureList & WsfScenario::GetSignatureListPrototype ( )

inline

References mSignatureListPrototypePtr.

GetSignatureListPrototype() [2/2]

const WsfSignatureList & WsfScenario::GetSignatureListPrototype ( ) const

inline

References mSignatureListPrototypePtr.

Referenced by WsfAcousticSignature::RegisterInterface(), WsfInfraredSignature::RegisterInterface(), WsfInherentContrast::RegisterInterface(), WsfOpticalReflectivity::RegisterInterface(), WsfOpticalSignature::RegisterInterface(), and WsfRadarSignature::RegisterInterface().

GetSimulationInput()

WsfSimulationInput & WsfScenario::GetSimulationInput ( ) const

inline

References mSimulationInputPtr.

Referenced by WsfEM_ALARM_Clutter::ComputeClutterPower(), WsfOTH_RadarSensor::OTH_Beam::Initialize(), WsfRadarSensor::RadarBeam::Initialize(), WsfEventStepSimulation::WsfEventStepSimulation(), and WsfFrameStepSimulation::WsfFrameStepSimulation().

GetSimulationName()

const std::string & WsfScenario::GetSimulationName ( ) const

inline

Returns the name given to the simulation. Empty if not specified.

References mSimulationName.

GetSystemLog()

WsfSystemLog & WsfScenario::GetSystemLog

(

)

const

Return a reference to the system log object.

Note

This is a convenience method that simply returns a reference to the object within the application.

References mApplicationPtr.

Referenced by wsf::TerrainInterface::AddBathymetry(), wsf::TerrainInterface::AddDtedDirectory(), WsfEventPipeInterface::AddedToSimulation(), wsf::TerrainInterface::AddGeotiffDirectory(), wsf::TerrainInterface::AddRawDtedDirectory(), FileOpenCallback(), WsfSOSM_Interface::FileReferenced(), wsf::TerrainInterface::LoadCME_File(), wsf::event::output::SimulationExtension::OpenFile(), WsfTSPI_Mover::OpenFile(), WsfAirToAirLaunchComputer::ProcessInput(), WsfBallisticMissileLaunchComputer::ProcessInput(), WsfSOSM_Interface::ProcessInput(), ProcessInputP(), WsfALARM_AntennaPattern::ALARM_Data::ReadPattern(), WsfVariableBase::ResolveReference(), wsf::TerrainInterface::SetFloatGridDirectory(), and wsf::TerrainInterface::SetFloatGridFile().

GetTerrainInterface()

wsf::TerrainInterface * WsfScenario::GetTerrainInterface ( ) const

inline

Valid only after WsfScenario::CompleteLoad().

References mTerrainInterfacePtr.

Referenced by wsf::six_dof::Environment::AddedToScenario(), and wsf::TerrainInterface::Get().

GetThermalSystemComponentTypes()

WsfThermalSystemComponentTypes & WsfScenario::GetThermalSystemComponentTypes ( ) const

inline

References mThermalSystemComponentTypesPtr.

Referenced by WsfThermalSystem::ProcessInput(), and WsfThermalSystemComponent::ProcessInput().

GetThermalSystemTypes()

WsfThermalSystemTypes & WsfScenario::GetThermalSystemTypes ( ) const

inline

References mThermalSystemTypesPtr.

Referenced by WsfThermalSystemTypes::Get(), and WsfThermalSystemTypes::Get().

GetTrackExtrapolationStrategyTypes()

wsf::TrackExtrapolationStrategyTypes & WsfScenario::GetTrackExtrapolationStrategyTypes ( ) const

inline

References mTrackExtrapolationStrategyTypesPtr.

Referenced by wsf::TrackExtrapolationStrategyTypes::Get(), and wsf::TrackExtrapolationStrategyTypes::Get().

GetTrackReportingStrategyTypes()

WsfTrackReportingStrategyTypes & WsfScenario::GetTrackReportingStrategyTypes ( ) const

inline

References mTrackReportingStrategyTypesPtr.

Referenced by WsfTrackReportingStrategyTypes::Get(), and WsfTrackReportingStrategyTypes::Get().

GetTypeLists()

std::vector< WsfObjectTypeListBaseI * > WsfScenario::GetTypeLists ( ) const

inline

References mAllTypeLists.

Referenced by WsfMultiresolutionTypesRegistration::GetMultiresolutionTypes(), and ProcessInputP().

GetTypes()

WsfObjectTypeListBaseI * WsfScenario::GetTypes

(

const std::string &

aTypesKind

)

const

Returns the type list of the given name, or null if it does not exist.

References mTypesListByKind.

Referenced by CloneType(), WsfOrbitalEvent::Create(), FindType(), wsf::coverage::CoverageTypes::Get(), wsf::coverage::GridTypes::Get(), wsf::coverage::MeasureOutputTypes::Get(), wsf::coverage::MeasureTypes::Get(), wsf::space::AtmosphereTypes::Get(), wsf::space::OrbitalPropagatorConditionTypes::Get(), WsfAttitudeControllerTypes::Get(), WsfOrbitalDynamicsTermTypes::Get(), WsfOrbitalIntegratorTypes::Get(), WsfOrbitalManeuveringTypes::Get(), WsfOrbitalMissionEventTypes::Get(), and wsf::multiresolution::GetObjectTypeList().

GetVisualPartTypes()

WsfVisualPartTypes & WsfScenario::GetVisualPartTypes ( ) const

inline

References mVisualPartTypesPtr.

Referenced by WsfVisualPartTypes::Get(), and WsfVisualPartTypes::Get().

GetZoneTypes()

WsfZoneTypes & WsfScenario::GetZoneTypes ( ) const

inline

References mZoneTypesPtr.

Referenced by CompleteLoad(), WsfZoneTypes::Get(), WsfZoneTypes::Get(), wsf::coverage::ZoneBasedGrid::InitializeP(), and wsf::coverage::ZoneBasedGrid::PreparePlatforms().

HadUnexpectedError()

bool WsfScenario::HadUnexpectedError ( ) const

inline

Returns true if an unexpected input error was encountered. Unless input testing is in process (noted by the command 'expect_input_error [true|false]' in the input stream), all input errors are 'unexpected'.

References mHadUnexpectedError.

Referenced by WsfStandardApplication::ProcessInputFiles().

LoadFromFile()

void WsfScenario::LoadFromFile

(

const std::string &

aFileName

)

Load simulation input from the file with the specified name.

Parameters

aFileName

The name of a text file to be opened and loaded.

Exceptions

if	errors are encountered.

References CheckErrorFailure(), WsfScenarioExtension::FileLoaded(), FileOpenCallback(), LoadFromStreamP(), mExtensionListPtr, mGotError, mInputFiles, and mInputPtr.

Referenced by WsfStandardApplication::ProcessInputFiles().

LoadFromStream()

void WsfScenario::LoadFromStream

(

UtInput &

aInput

)

Load simulation input from the file with the specified stream.

Parameters

aInput

Reference to the input stream.

Exceptions

if	errors are encountered.

References LoadFromStreamP(), and mDeferredInputPtr.

LoadFromStreamP()

void WsfScenario::LoadFromStreamP ( UtInput & aInput )

protected

References ConfigureInput(), and ProcessInputP().

Referenced by LoadFromFile(), and LoadFromStream().

LoadIsComplete()

bool WsfScenario::LoadIsComplete ( ) const

inline

References mLoadIsComplete.

Referenced by WsfSimulation::WsfSimulation().

LoadPlatformInstance()

bool WsfScenario::LoadPlatformInstance

(

UtInput &

aInput

)

Add or edit an instance of a 'type object' of this class on a platform.

Parameters

aInput

The input stream.

Returns

'true' if the command was processed or 'false' if not.

Exceptions

UtInput::ExceptionBase

(or derived class) if an error was encountered.

References AddInputPlatform(), WsfDeferredInput::DelayLoad(), GetDeferredInput(), GetInputPlatformByName(), GetPlatformTypes(), LoadPlatformInstance(), platformPtr, WsfPlatform::ProcessInputBlock(), and WsfDeferredInput::Requires().

Referenced by LoadPlatformInstance(), and ProcessInputP().

operator=()

WsfScenario & WsfScenario::operator= ( const WsfScenario & )

delete

References WsfScenario().

PlatformIsAvailable()

bool WsfScenario::PlatformIsAvailable	(	WsfPlatform *	aPlatformPtr,
		WsfSimulation &	aSimulation ) const

Determine if an input platform defined in the scenario is to actually be added to a simulation. A user may use the 'platform_availability' block to control what platforms in a scenario are to actually be added to the simulation.

Parameters

aPlatformPtr	[input] Pointer to the platform being considered for addition.
aSimulation	[input] The simulation into which the platform will possibly be added.

Returns

'true' if the platform should be added to the simulation, or 'false' if not.

References mPlatformAvailabilityPtr.

ProcessExtensionInput()

bool WsfScenario::ProcessExtensionInput ( UtInput & aInput )

protected

References mExtensionListPtr, and WsfScenarioExtension::ProcessInput().

Referenced by ProcessInputP().

ProcessInput()

bool WsfScenario::ProcessInput

(

UtInput &

aInput

)

References ConfigureInput(), and ProcessInputP().

Referenced by ProcessInputP().

ProcessInputP()

bool WsfScenario::ProcessInputP ( UtInput & aInput )

protectedvirtual

References ExpectError(), FindClassificationLevel(), FindExtension(), GetApplication(), wsf::version::GetMajorVersion(), wsf::version::GetMinorVersion(), wsf::version::GetPatchVersion(), WsfApplication::GetRegisteredFeatures(), GetSystemLog(), GetTypeLists(), WsfScriptManager::GetTypes(), LoadPlatformInstance(), mApplicationPtr, mAtmospherePtr, mCaveatsSet, mClassificationsList, mEnvironmentPtr, mFinalRunNumber, mIFF_ManagerPtr, mInitialRandomSeed, mInitialRunNumber, mInitialSeed, mInputFunctions, mLevelIndex, mMessageTablePtr, mOpenConditionalBlocks, mPlatformAvailabilityPtr, mRandomSeeds, mScriptManagerPtr, mSimulationInputPtr, mSimulationName, mTestingForInputError, mTrigraphsSet, mUseQuantitativeTrackQuality, ProcessExtensionInput(), ProcessInput(), SetFinalRunNumber(), SetInitialRunNumber(), SetRunNumberIncrement(), and TypesProcessInput().

Referenced by LoadFromStreamP(), and ProcessInput().

RegisterComponentFactory()

void WsfScenario::RegisterComponentFactory

(

std::unique_ptr< WsfComponentFactoryBase >

aFactoryPtr

)

References mComponentFactoryList.

Referenced by wsf::comm::ProtocolTypes::ProtocolTypes(), wsf::comm::router::ProtocolTypes::ProtocolTypes(), wsf::cyber::ConstraintTypes::RegisterComponentFactory(), wsf::cyber::Protect::RegisterComponentFactory(), wsf::UCI_ComponentTypes::RegisterComponentFactory(), WsfChaffEjector::RegisterComponentFactory(), WsfCommandChain::RegisterComponentFactory(), WsfCTD_SensorComponent::RegisterComponentFactory(), WsfEW_CommComponent::RegisterComponentFactory(), WsfEW_SensorComponent::RegisterComponentFactory(), WsfExclusionSensorComponent::RegisterComponentFactory(), WsfGeoPoint::RegisterComponentFactory(), WsfMoonLOS_SensorComponent::RegisterComponentFactory(), WsfNavigationErrors::RegisterComponentFactory(), WsfSolarElevationAtTargetSensorComponent::RegisterComponentFactory(), WsfSolarIlluminationComponent::RegisterComponentFactory(), WsfTRIMSIM_SensorComponent::RegisterComponentFactory(), WsfWeaponPlatformExtension::RegisterComponentFactory(), WsfWeaponTaskManager::RegisterComponentFactory(), wsf::comm::medium::Types::Types(), wsf::comm::router::Types::Types(), wsf::comm::Types::Types(), WsfAttitudeControllerTypes::WsfAttitudeControllerTypes(), WsfCallbackTypes::WsfCallbackTypes(), WsfEW_EA_EP_Types::WsfEW_EA_EP_Types(), WsfFuelTypes::WsfFuelTypes(), WsfIntersectMeshTypes::WsfIntersectMeshTypes(), WsfMoverTypes::WsfMoverTypes(), WsfMultiresolutionTypes< DerivedComponent >::WsfMultiresolutionTypes(), WsfOrbitalManeuveringTypes::WsfOrbitalManeuveringTypes(), WsfOrbitalMissionEventTypes::WsfOrbitalMissionEventTypes(), WsfProcessorTypes::WsfProcessorTypes(), WsfSensorTypes::WsfSensorTypes(), WsfThermalSystemTypes::WsfThermalSystemTypes(), WsfVisualPartTypes::WsfVisualPartTypes(), WsfWeaponTypes::WsfWeaponTypes(), and WsfZoneTypes::WsfZoneTypes().

RegisterExtension()

void WsfScenario::RegisterExtension	(	const std::string &	aName,
		std::unique_ptr< WsfScenarioExtension >	aExtensionPtr )

Register an extension.

Parameters

aName	[input] Name of the extension being registered
aExtensionPtr	[input] A pointer to the extension instance to be registered. Upon successful registration this class assumes ownership of the registered object and will be responsible for its deletion.

Exceptions

DuplicateExtension

if an extension of the same name already exists.

References mExtensionListPtr.

Referenced by Register_BallisticMissileLaunchComputer(), WsfPrivate::RegisterScenarioExtension(), engage::ApplicationExtension::ScenarioCreated(), wsf::cyber::ApplicationExtension::ScenarioCreated(), wsf::dis::ApplicationExtension::ScenarioCreated(), and WsfScenario().

ScenarioChange()

void WsfScenario::ScenarioChange

(

)

To be called before modification of the scenario. If the scenario is in an immutable state, throws an exception

References mLoadIsComplete.

SetFinalRunNumber()

void WsfScenario::SetFinalRunNumber

(

unsigned int

aFinalRunNumber

)

Set the final run number.

References mFinalRunNumber, and mRandomSeeds.

Referenced by ProcessInputP().

SetInitialRunNumber()

void WsfScenario::SetInitialRunNumber

(

unsigned int

aInitialRunNumber

)

Set the initial run number.

References mInitialRunNumber, and mRandomSeeds.

Referenced by ProcessInputP().

SetInitialSeed()

void WsfScenario::SetInitialSeed ( long int aInitialSeed )

inline

References mInitialSeed.

SetRunNumberIncrement()

void WsfScenario::SetRunNumberIncrement

(

unsigned int

aRunNumberIncrement

)

Set the increment between run numbers.

References mRunNumberIncrement.

Referenced by ProcessInputP().

SetSimulationInput()

void WsfScenario::SetSimulationInput

(

WsfSimulationInput *

aSimulationInput

)

Sets the simulation input object, replacing the existing input object. Allows an application to override simulation inputs

Note

Must be called before the first file is loaded

References mInputFiles, and mSimulationInputPtr.

Referenced by ~WsfScenario().

SimulationCreated()

void WsfScenario::SimulationCreated

(

WsfSimulation &

aSimulation

)

const

Callback from a simulation to indicate that it has been created and is initializing. This method is called by WsfSimulation::Initialize() immediately upon entry. Its main function is to ensure that all extensions registered to the application and scenario are notified of the creation of the simulation. The extensions

Note

This method should not be called directly by the user code.

References FindExtension(), GetApplication(), mExtensionListPtr, and WsfScenarioExtension::SimulationCreated().

SortExtensions()

void WsfScenario::SortExtensions ( )

protected

References mExtensionListPtr, and mExtensionsInOrder.

Referenced by ConfigureInput().

Strings()

const WsfStringTable & WsfScenario::Strings ( ) const

inline

References mStringTable.

TypesProcessInput()

bool WsfScenario::TypesProcessInput ( UtInput & aInput )

protected

References mAllTypeLists, and mTerrainInterfacePtr.

Referenced by ProcessInputP().

UseQuantitativeTrackQuality()

bool WsfScenario::UseQuantitativeTrackQuality ( ) const

inline

Return whether the simulation is using quantitative track quality.

References mUseQuantitativeTrackQuality.

Friends And Related Symbol Documentation

ErrorTracker

friend class ErrorTracker

friend

References ErrorTracker.

Referenced by ErrorTracker.

Member Data Documentation

mAdvancedBehaviorTreeNodeTypesPtr

WsfAdvancedBehaviorTreeNodeTypes* WsfScenario::mAdvancedBehaviorTreeNodeTypesPtr

protected

Referenced by GetAdvancedBehaviorTreeNodeTypes().

mAeroTypesPtr

WsfAeroTypes* WsfScenario::mAeroTypesPtr

protected

Referenced by GetAeroTypes().

mAllTypeLists

std::vector<std::unique_ptr<WsfObjectTypeListBaseI> > WsfScenario::mAllTypeLists

protected

All of the type lists in order of creation.

Referenced by AddTypeList(), CompleteLoad(), GetTypeLists(), TypesProcessInput(), and WsfScenario().

mAntennaPatternTypesPtr

WsfAntennaPatternTypes* WsfScenario::mAntennaPatternTypesPtr

protected

Referenced by GetAntennaPatternTypes().

mApplicationPtr

WsfApplication* WsfScenario::mApplicationPtr

protected

Referenced by GetApplication(), GetSystemLog(), ProcessInputP(), and WsfScenario().

mAtmospherePtr

std::unique_ptr<UtAtmosphere> WsfScenario::mAtmospherePtr

protected

Referenced by GetAtmosphere(), ProcessInputP(), and WsfScenario().

mBehaviorTreeNodeTypesPtr

WsfBehaviorTreeNodeTypes* WsfScenario::mBehaviorTreeNodeTypesPtr

protected

Referenced by GetBehaviorTreeNodeTypes().

mCallbackTypesPtr

WsfCallbackTypes* WsfScenario::mCallbackTypesPtr

protected

Referenced by GetCallbackTypes().

mCaveatsSet

std::set<std::string> WsfScenario::mCaveatsSet

protected

Referenced by BuildClassificationString(), and ProcessInputP().

mClassification

ClassificationLevel WsfScenario::mClassification

protected

Referenced by BuildClassificationString(), GetClassificationColor(), and GetClassificationString().

mClassificationsList

std::vector<ClassificationLevel> WsfScenario::mClassificationsList

protected

Referenced by BuildClassificationString(), FindClassificationLevel(), and ProcessInputP().

mCommProtocolTypesPtr

wsf::comm::ProtocolTypes* WsfScenario::mCommProtocolTypesPtr

protected

Referenced by GetProtocolTypes().

mCommTypesPtr

wsf::comm::Types* WsfScenario::mCommTypesPtr

protected

Referenced by GetCommTypes().

mComponentFactoryList

ComponentFactoryList WsfScenario::mComponentFactoryList

protected

This list of component factories attached to the scenario.

Referenced by GetComponentFactoryList(), RegisterComponentFactory(), and WsfScenario().

mCorrelationTypesPtr

WsfCorrelationStrategyTypes* WsfScenario::mCorrelationTypesPtr

protected

Referenced by GetCorrelationTypes().

mDeferredInputPtr

std::unique_ptr<WsfDeferredInput> WsfScenario::mDeferredInputPtr

protected

Referenced by CompleteLoad(), GetDeferredInput(), LoadFromStream(), and WsfScenario().

mEM_AttenuationTypesPtr

WsfEM_AttenuationTypes* WsfScenario::mEM_AttenuationTypesPtr

protected

Referenced by GetEM_AttenuationTypes().

mEM_ClutterTypesPtr

WsfEM_ClutterTypes* WsfScenario::mEM_ClutterTypesPtr

protected

Referenced by GetEM_ClutterTypes().

mEM_PropagationTypesPtr

WsfEM_PropagationTypes* WsfScenario::mEM_PropagationTypesPtr

protected

Referenced by GetEM_PropagationTypes().

mEnvironmentPtr

std::unique_ptr<WsfEnvironment> WsfScenario::mEnvironmentPtr

protected

Referenced by GetEnvironment(), ProcessInputP(), and WsfScenario().

mExpectInputError

bool WsfScenario::mExpectInputError

protected

Referenced by CheckErrorFailure(), ExpectError(), ExpectError(), ExpectInputError(), and WsfScenario().

mExtensionListPtr

std::unique_ptr<WsfExtensionList> WsfScenario::mExtensionListPtr

protected

The list of scenario extensions attached to the scenario.

Referenced by CompleteLoad(), ExtensionDepends(), FindExtension(), GetExtension(), GetExtensions(), LoadFromFile(), ProcessExtensionInput(), RegisterExtension(), SimulationCreated(), SortExtensions(), and WsfScenario().

mExtensionsInOrder

bool WsfScenario::mExtensionsInOrder

protected

Referenced by CompleteLoad(), ConfigureInput(), SortExtensions(), and WsfScenario().

mFilterTypesPtr

WsfFilterTypes* WsfScenario::mFilterTypesPtr

protected

Referenced by GetFilterTypes().

mFinalRunNumber

unsigned int WsfScenario::mFinalRunNumber

protected

The final run number to be executed.

Referenced by CompleteLoad(), GetFinalRunNumber(), ProcessInputP(), SetFinalRunNumber(), and WsfScenario().

mFuelTypesPtr

WsfFuelTypes* WsfScenario::mFuelTypesPtr

protected

Referenced by GetFuelTypes().

mFusionTypesPtr

WsfFusionStrategyTypes* WsfScenario::mFusionTypesPtr

protected

Referenced by GetFusionTypes().

mGotError

bool WsfScenario::mGotError

protected

Referenced by CheckErrorFailure(), CompleteLoad(), ExpectError(), LoadFromFile(), and WsfScenario().

mGroupTypesPtr

WsfGroupTypes* WsfScenario::mGroupTypesPtr

protected

Referenced by GetGroupTypes().

mHadUnexpectedError

bool WsfScenario::mHadUnexpectedError

protected

Referenced by CheckErrorFailure(), HadUnexpectedError(), and WsfScenario().

mIFF_ManagerPtr

std::unique_ptr<WsfIFF_Manager> WsfScenario::mIFF_ManagerPtr

protected

Referenced by GetIFF_Manager(), ProcessInputP(), and WsfScenario().

mInitialRandomSeed

long int WsfScenario::mInitialRandomSeed

protected

The seed used to generate sRandomSeeds.

Referenced by CompleteLoad(), ProcessInputP(), and WsfScenario().

mInitialRunNumber

unsigned int WsfScenario::mInitialRunNumber

protected

Monte Carlo.

The first run number to be executed.

Referenced by GetInitalRunNumber(), ProcessInputP(), SetInitialRunNumber(), and WsfScenario().

mInitialSeed

long int WsfScenario::mInitialSeed

protected

Referenced by GetInitialSeed(), GetRandomSeed(), ProcessInputP(), SetInitialSeed(), and WsfScenario().

mInputFiles

std::vector<std::string> WsfScenario::mInputFiles

protected

Referenced by GetInputFiles(), LoadFromFile(), SetSimulationInput(), and WsfScenario().

mInputFunctions

std::vector<InputFunction> WsfScenario::mInputFunctions

protected

Referenced by AddInputProcessor(), ProcessInputP(), and WsfScenario().

mInputPlatforms

std::vector<std::unique_ptr<WsfPlatform> > WsfScenario::mInputPlatforms

protected

The list of input platforms.

Referenced by AddInputPlatform(), CompleteLoad(), GetInputPlatformByName(), GetInputPlatformCount(), GetInputPlatformEntry(), and WsfScenario().

mInputPtr

std::unique_ptr<UtInput> WsfScenario::mInputPtr

protected

Referenced by CompleteLoad(), GetInput(), LoadFromFile(), and WsfScenario().

mIntersectMeshTypesPtr

WsfIntersectMeshTypes* WsfScenario::mIntersectMeshTypesPtr

protected

Referenced by GetIntersectMeshTypes().

mLevelIndex

size_t WsfScenario::mLevelIndex {ut::npos}

protected

Referenced by BuildClassificationString(), and ProcessInputP().

mLoadIsComplete

bool WsfScenario::mLoadIsComplete

protected

When true, indicates that CompleteLoad() has been called. If this is true, all data in this class should remain immutable

Referenced by CompleteLoad(), LoadIsComplete(), ScenarioChange(), and WsfScenario().

mMaskingPatternTypesPtr

WsfMaskingPatternTypes* WsfScenario::mMaskingPatternTypesPtr

protected

Referenced by GetMaskingPatternTypes().

mMediumTypesPtr

wsf::comm::medium::Types* WsfScenario::mMediumTypesPtr

protected

Referenced by GetMediumTypes().

mMessageTablePtr

std::unique_ptr<WsfMessageTable> WsfScenario::mMessageTablePtr

protected

Referenced by CompleteLoad(), GetMessageTable(), ProcessInputP(), and WsfScenario().

mMoverTypesPtr

WsfMoverTypes* WsfScenario::mMoverTypesPtr

protected

Referenced by GetMoverTypes().

mNetworkTypesPtr

wsf::comm::NetworkTypes* WsfScenario::mNetworkTypesPtr

protected

Referenced by GetNetworkTypes().

mNoiseCloudTypesPtr

WsfNoiseCloudTypes* WsfScenario::mNoiseCloudTypesPtr

protected

Referenced by GetNoiseCloudTypes().

mOpenConditionalBlocks

int WsfScenario::mOpenConditionalBlocks

protected

Referenced by ProcessInputP(), and WsfScenario().

mPathFinderListPtr

std::unique_ptr<WsfPathFinderList> WsfScenario::mPathFinderListPtr

protected

Referenced by GetPathFinderList(), and WsfScenario().

mPathFinderTypesPtr

WsfPathFinderTypes* WsfScenario::mPathFinderTypesPtr

protected

Referenced by GetPathFinderTypes().

mPlatformAvailabilityPtr

std::unique_ptr<WsfPlatformAvailability> WsfScenario::mPlatformAvailabilityPtr

protected

The 'platform_availability' of input platforms.

Referenced by PlatformIsAvailable(), ProcessInputP(), and WsfScenario().

mPlatformTypesPtr

WsfPlatformTypes* WsfScenario::mPlatformTypesPtr

protected

Referenced by GetPlatformTypes().

mProcessorTypesPtr

WsfProcessorTypes* WsfScenario::mProcessorTypesPtr

protected

Referenced by GetProcessorTypes().

mRadarSignatureTypesPtr

WsfRadarSignatureTypes* WsfScenario::mRadarSignatureTypesPtr

protected

Referenced by GetRadarSignatureTypes().

mRandomSeeds

std::vector<long int> WsfScenario::mRandomSeeds

protected

A list of random number seeds indexed by run number.

Referenced by CompleteLoad(), GetRandomSeed(), ProcessInputP(), SetFinalRunNumber(), SetInitialRunNumber(), and WsfScenario().

mRouteNetworkTypesPtr

WsfRouteNetworkTypes* WsfScenario::mRouteNetworkTypesPtr

protected

Referenced by GetRouteNetworkTypes().

mRouterProtocolTypesPtr

wsf::comm::router::ProtocolTypes* WsfScenario::mRouterProtocolTypesPtr

protected

Referenced by GetRouterProtocolTypes().

mRouterTypesPtr

wsf::comm::router::Types* WsfScenario::mRouterTypesPtr

protected

Referenced by GetRouterTypes().

mRouteTypesPtr

WsfRouteTypes* WsfScenario::mRouteTypesPtr

protected

Referenced by GetRouteTypes().

mRunNumberIncrement

unsigned int WsfScenario::mRunNumberIncrement

protected

The increment between the run numbers.

Referenced by GetRunNumberIncrement(), SetRunNumberIncrement(), and WsfScenario().

mScriptEnvironmentPtr

std::unique_ptr<UtScriptEnvironment> WsfScenario::mScriptEnvironmentPtr

protected

Referenced by GetScriptEnvironment(), and WsfScenario().

mScriptManagerPtr

std::unique_ptr<WsfScriptManager> WsfScenario::mScriptManagerPtr

protected

Referenced by GetScriptContext(), GetScriptManager(), ProcessInputP(), and WsfScenario().

mScriptTypesPtr

UtScriptTypes* WsfScenario::mScriptTypesPtr

protected

Referenced by GetScriptTypes(), and WsfScenario().

mSensorErrorModelTypesPtr

WsfSensorErrorModelTypes* WsfScenario::mSensorErrorModelTypesPtr

protected

Referenced by GetSensorErrorModelTypes().

mSensorTypesPtr

WsfSensorTypes* WsfScenario::mSensorTypesPtr

protected

Referenced by GetSensorTypes().

mSignatureListPrototypePtr

std::unique_ptr<WsfSignatureList> WsfScenario::mSignatureListPrototypePtr

protected

Pointer to the prototype signature list.

Referenced by GetSignatureListPrototype(), GetSignatureListPrototype(), and WsfScenario().

mSimulationInputPtr

std::unique_ptr<WsfSimulationInput> WsfScenario::mSimulationInputPtr

protected

Referenced by CompleteLoad(), GetSimulationInput(), ProcessInputP(), SetSimulationInput(), and WsfScenario().

mSimulationName

std::string WsfScenario::mSimulationName

protected

Referenced by GetSimulationName(), and ProcessInputP().

mStringTable

WsfStringTable WsfScenario::mStringTable

protected

Referenced by Strings(), and WsfScenario().

mTerrainInterfacePtr

std::unique_ptr<wsf::TerrainInterface> WsfScenario::mTerrainInterfacePtr

protected

Referenced by CompleteLoad(), GetTerrainInterface(), TypesProcessInput(), and WsfScenario().

mTestingForInputError

bool WsfScenario::mTestingForInputError

protected

Referenced by CheckErrorFailure(), ProcessInputP(), and WsfScenario().

mThermalSystemComponentTypesPtr

WsfThermalSystemComponentTypes* WsfScenario::mThermalSystemComponentTypesPtr

protected

Referenced by GetThermalSystemComponentTypes().

mThermalSystemTypesPtr

WsfThermalSystemTypes* WsfScenario::mThermalSystemTypesPtr

protected

Referenced by GetThermalSystemTypes().

mTrackExtrapolationStrategyTypesPtr

wsf::TrackExtrapolationStrategyTypes* WsfScenario::mTrackExtrapolationStrategyTypesPtr

protected

Referenced by GetTrackExtrapolationStrategyTypes().

mTrackReportingStrategyTypesPtr

WsfTrackReportingStrategyTypes* WsfScenario::mTrackReportingStrategyTypesPtr

protected

Referenced by GetTrackReportingStrategyTypes().

mTrigraphsSet

std::set<std::string> WsfScenario::mTrigraphsSet

protected

Referenced by BuildClassificationString(), and ProcessInputP().

mTypesListByKind

std::map<std::string, WsfObjectTypeListBaseI*> WsfScenario::mTypesListByKind

protected

All of the type lists by type.

Referenced by AddTypeList(), GetTypes(), and WsfScenario().

mUseQuantitativeTrackQuality

bool WsfScenario::mUseQuantitativeTrackQuality

protected

Referenced by ProcessInputP(), UseQuantitativeTrackQuality(), and WsfScenario().

mVisualPartTypesPtr

WsfVisualPartTypes* WsfScenario::mVisualPartTypesPtr

protected

Referenced by GetVisualPartTypes().

mZoneTypesPtr

WsfZoneTypes* WsfScenario::mZoneTypesPtr

protected

Referenced by GetZoneTypes().

---

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

• WsfScenario.hpp
• WsfScenario.cpp