engage::RunConfig Class Reference

#include <RunConfig.hpp>

Public Types
typedef std::list< OutputConfig >	OutputList

Public Member Functions
	RunConfig (const InputConfig &aInputConfig)
bool	Complete (int aRunIndex, int aBaseTaskIndex)
	This is called when all of the input has been read.
bool	ProcessInput (UtInput &aInput)
const OutputList &	GetOutputList () const
	Return a reference to the OutputConfig object.
const SiteConfig &	GetSiteConfig () const
	Return a reference to the SiteConfig object.
const TargetConfig &	GetTargetConfig () const
	Return a reference to the TargetConfig object.
std::string	GetRecordFileName (const Task &aTask) const
std::string	GetEventOutputFileName (const Task &aTask) const
int	GetRepetitionCount () const
	Get the repetition count for this run.
int	GetRunIndex () const
	Return the run index for this run.
int	GetTaskCount () const
	Return the number of tasks needed to complete this run.
const Utilities &	GetUtilities () const
	Return a reference to the utilities object for coordinate conversions.
bool	CreatePlatforms (Simulation &aSimulation, const Task &aTask) const
Task	MakeTask (int aTaskIndex) const
std::string	GetPkTargetType () const
	Return the target type for Pk Table generation.
std::string	GetPkSiteType () const
	Return the site type for Pk table generation.
bool	IsPkTableGen () const
	Return if Pk table generation is enabled for this run.
bool	IsSiteGrid () const
	Return if the grid is a site grid.
std::string	GetPkPath () const
	Return the Pk table output directory path.
bool	IsPkPeriodicFlush () const
	Return if the grid should be periodically flushed.
std::string	GetPkLengthUnit () const
	Return the units used for Pk table length output.
std::string	GetPkVelocityUnit () const
	Return the units used for Pk table speed output.

Member Typedef Documentation

OutputList

typedef std::list<OutputConfig> engage::RunConfig::OutputList

Constructor & Destructor Documentation

RunConfig()

engage::RunConfig::RunConfig

(

const InputConfig &

aInputConfig

)

References engage::cTRACKING.

Member Function Documentation

Complete()

bool engage::RunConfig::Complete	(	int	aRunIndex,
		int	aBaseTaskIndex )

This is called when all of the input has been read.

References engage::OutputConfig::GetRateTableName(), ok, and engage::OutputConfig::SetRateTable().

Referenced by engage::InputConfig::Complete().

CreatePlatforms()

bool engage::RunConfig::CreatePlatforms	(	Simulation &	aSimulation,
		const Task &	aTask ) const

Create the platforms for the associated task index. Create the launcher, tracker and target platforms and inject them into the simulation.

Parameters

aSimulation	[input] The simulation into which the platforms are to be injected.
aTask	[input] The task.

Returns

true if successful or false if not.

References ok.

Referenced by engage::Task::Execute().

GetEventOutputFileName()

std::string engage::RunConfig::GetEventOutputFileName

(

const Task &

aTask

)

const

References engage::Task::GetRepetition(), engage::Task::GetSiteIndex(), and engage::Task::GetTargetIndex().

GetOutputList()

const OutputList & engage::RunConfig::GetOutputList ( ) const

inline

Return a reference to the OutputConfig object.

GetPkLengthUnit()

std::string engage::RunConfig::GetPkLengthUnit ( ) const

inline

Return the units used for Pk table length output.

Referenced by engage::TaskOutput::FlushPk().

GetPkPath()

std::string engage::RunConfig::GetPkPath ( ) const

inline

Return the Pk table output directory path.

Referenced by engage::TaskOutput::FlushPk().

GetPkSiteType()

std::string engage::RunConfig::GetPkSiteType ( ) const

inline

Return the site type for Pk table generation.

GetPkTargetType()

std::string engage::RunConfig::GetPkTargetType ( ) const

inline

Return the target type for Pk Table generation.

GetPkVelocityUnit()

std::string engage::RunConfig::GetPkVelocityUnit ( ) const

inline

Return the units used for Pk table speed output.

Referenced by engage::TaskOutput::FlushPk().

GetRecordFileName()

std::string engage::RunConfig::GetRecordFileName

(

const Task &

aTask

)

const

References engage::Task::GetRepetition(), engage::Task::GetSiteIndex(), and engage::Task::GetTargetIndex().

GetRepetitionCount()

int engage::RunConfig::GetRepetitionCount ( ) const

inline

Get the repetition count for this run.

Referenced by engage::TaskOutput::InsertPk().

GetRunIndex()

int engage::RunConfig::GetRunIndex ( ) const

inline

Return the run index for this run.

Referenced by engage::TaskOutput::InsertPk(), and engage::SimulationScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT().

GetSiteConfig()

const SiteConfig & engage::RunConfig::GetSiteConfig ( ) const

inline

Return a reference to the SiteConfig object.

Referenced by engage::TaskOutput::InsertPk().

GetTargetConfig()

const TargetConfig & engage::RunConfig::GetTargetConfig ( ) const

inline

Return a reference to the TargetConfig object.

Referenced by engage::TaskOutput::InsertPk().

GetTaskCount()

int engage::RunConfig::GetTaskCount ( ) const

inline

Return the number of tasks needed to complete this run.

Referenced by engage::InputConfig::Complete(), and engage::InputConfig::MakeTask().

GetUtilities()

const Utilities & engage::RunConfig::GetUtilities ( ) const

inline

Return a reference to the utilities object for coordinate conversions.

Referenced by engage::TargetConfig::CreatePlatform().

IsPkPeriodicFlush()

bool engage::RunConfig::IsPkPeriodicFlush ( ) const

inline

Return if the grid should be periodically flushed.

Referenced by engage::TaskOutput::InsertPk().

IsPkTableGen()

bool engage::RunConfig::IsPkTableGen ( ) const

inline

Return if Pk table generation is enabled for this run.

IsSiteGrid()

bool engage::RunConfig::IsSiteGrid ( ) const

inline

Return if the grid is a site grid.

MakeTask()

Task engage::RunConfig::MakeTask

(

int

aTaskIndex

)

const

Create a task object that represents the task with the specified global task index.

Parameters

aTaskIndex

[input] The global task index of the task.

Returns

The Task object that represents the supplied global task index.

References targetIndex().

Referenced by engage::InputConfig::MakeTask().

ProcessInput()

bool engage::RunConfig::ProcessInput

(

UtInput &

aInput

)

References engage::OutputConfig::ProcessInput().

---

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

• RunConfig.hpp
• RunConfig.cpp