DtScenarioExplorer Class Reference

class DtScenarioExplorer: More...

Inheritance diagram for DtScenarioExplorer:

Public Member Functions
	DtScenarioExplorer ()
	default constructor
	DtScenarioExplorer (const DtScenario &scenario)
	real constructor
virtual	~DtScenarioExplorer ()
	destructor
	DtScenarioExplorer (const DtScenarioExplorer &orig)
	copy constructor
DtScenarioExplorer &	operator= (const DtScenarioExplorer &orig)
	assignment operator
virtual bool	init ()
	Initialization. Must be called before any other functions are called.
virtual bool	init (const DtSimulationModelSet &sms)
	Initializes from supplied sms file. Does not need to have a seed scenario to parse sms files.
virtual bool	readScenarioFile (const DtFilename &filename)
	Read itself from file.
virtual DtFilename	terrainDatabaseFilename () const
	Get the terrain database filename.
virtual DtFilename	componentAttachmentTableFilename () const
	Get the component attachment table filename.
virtual DtFilename	orderOfBattleFilename () const
	Get the order of battle filename.
virtual DtFilename	scenarioScriptsFilename () const
	Get the scenario scripts filename.
virtual DtFilename	orbatFilename () const
	Get the orbat filename.
virtual DtFilename	planFilename () const
	Get the plan filename.
virtual DtFilename	parameterDatabaseFilename () const
	Get the parameter database filename.
virtual DtFilename	forceHostilityFilename () const
virtual DtFilename	scenarioExtrasFilename () const
virtual const std::vector < DtFilename > &	physicalWorldFilenames () const
	Get the physical world settings files.
virtual const std::vector < DtFilename > &	detonationParametersFilenames () const
	Get the detonation parameters files.
virtual const std::vector < DtFilename > &	indirectArtilleryTypesFilenames () const
	Get the indirect artillery types files.
virtual const std::vector < DtFilename > &	commModelFilenames () const
	Get the comm model settings files.
virtual DtFilename	objectMapFilename () const
	Get the object map filename.
virtual DtReal	timeMultiplier () const
	Get the time multiplier.
virtual bool	autoReorganize () const
	Get the auto reorganize flag.
virtual long int	randomNumberSeed () const
	Get the random number seed.
virtual DtString	frameRateModeString () const
	Get frame rate mode.
virtual DtFrameMode	frameRateMode () const
virtual DtReal	frameDeltaTime () const
	Get frame delta time.
virtual DtTime	runDurationTime ()
	Get the run duration time.
virtual DtTime	simTime () const
	Get simulation time.
virtual DtTime	runDurationTime () const
	Get run duration time.
virtual DtTime	exerciseStartTime () const
	Get exercise start date and time.
virtual DtFilename	filename () const
virtual bool	isValid (bool allowEmptyFilenames=true) const
	Returns true if all information necessary to load the scenario is present.
virtual double	version () const
	The version of the scenario file.
virtual void	processModelSets ()
	Processes all the model sets found in the myScenario object.
virtual void	loadCoreModelSets ()
	Loads the "core" model sets, which are the ones automatically loaded before any others, if they exist in the directory structure.
virtual void	processSimulationModelSets (const std::vector< DtString > &smsFiles)
	Processes all model sets, adding to existing sets.
virtual const std::vector < DtFilename > &	modelSetForceFilenames () const
DtScenario *	scenario () const
	Returns scenario associated with explorer.
virtual void	addFilename (std::vector< DtFilename > &, const DtFilename &map) const
virtual void	setSimulationModelSetFilenames (const std::vector< DtFilename > &s)
virtual void	setSimulationModelSetFilenames (const DtRwNLengthStringVector &)
virtual DtFilename	globalPlanFilename () const
	Get the global plan filename.
virtual const std::vector < DtFilename > &	additionalOpdFilenames () const
	Additional OPD files that will be appended (in the order specified) to the main OPD file for this scenario.
virtual DtRwNLengthStringVector	simulationModelSetFilenames ()
	Simulation model set files that want to be loaded for this scenario.
std::vector < DtSimulationModelSet * > &	modelSets ()
	The following methods are used for the front-end only.
const std::vector < DtSimulationModelSet * > &	modelSets () const
virtual const std::vector < DtFilename > &	modelSetFilenames () const
	Returns a list of all (unique) model set palette names that should be loaded in support of this scenario.

Protected Member Functions
virtual void	clearModelSets ()
virtual void	mergeAdditionalOpdFiles ()
virtual void	processModelSet (DtSimulationModelSet *)
virtual void	processIncludedSMSs (std::vector< DtSimulationModelSet * > &loadedSets, DtSimulationModelSet *set, DtReaderWriter::SearchPaths &searchPaths)
virtual void	loadIncludedSets (DtSimulationModelSet *set, std::vector< DtSimulationModelSet * > &loadedSetsStarted, std::vector< DtSimulationModelSet * > &loadedSetsCompleted, DtReaderWriter::SearchPaths &parentSearchPaths, DtReaderWriter::SearchPaths &childSearchPaths, DtReaderWriter::SearchPaths &allPaths)
	Loads SMSs included by "set", and recurses into those if necessary.

Protected Attributes
DtScenario *	myScenario
DtFilename	myParameterDatabaseFilename
DtFilename	myForceHostilityFilename
DtFilename	myScenarioExtrasFilename
std::vector < DtSimulationModelSet * >	myModelSets
std::vector< DtFilename >	myPhysicalWorldFilenames
std::vector< DtFilename >	myDetonationParametersFilenames
std::vector< DtFilename >	myIndirectArtilleryTypesFilenames
std::vector< DtFilename >	myAdditionalOpdFilenames
std::vector< DtFilename >	myCommModelFilenames
std::vector< DtFilename >	myModelSetForceFilenames
	The following member variables are used in the front-end only.
std::vector< DtFilename >	myModelSetFilenames

Detailed Description

class DtScenarioExplorer:

The DtScenarioExplorer class will inspect a scenario for any simulation model set files. If any exist, it will load the files and then present the user, through the interface, the files that are contained within those model set files

Constructor & Destructor Documentation

DtScenarioExplorer::DtScenarioExplorer

(

)

default constructor

DtScenarioExplorer::DtScenarioExplorer

(

const DtScenario &

scenario

)

real constructor

virtual DtScenarioExplorer::~DtScenarioExplorer ( )

virtual

destructor

DtScenarioExplorer::DtScenarioExplorer

(

const DtScenarioExplorer &

orig

)

copy constructor

Member Function Documentation

DtScenarioExplorer& DtScenarioExplorer::operator=

(

const DtScenarioExplorer &

orig

)

assignment operator

virtual bool DtScenarioExplorer::init ( )

virtual

Initialization. Must be called before any other functions are called.

This method will read in all simulation model sets and place the results into the mySimulationModelSets array. All methods that are affected by the results of this read are marked above. This method will be called from those methods that use it if the model sets have not already been read

virtual bool DtScenarioExplorer::init ( const DtSimulationModelSet &  sms )

virtual

Initializes from supplied sms file. Does not need to have a seed scenario to parse sms files.

virtual bool DtScenarioExplorer::readScenarioFile ( const DtFilename &  filename )

virtual

Read itself from file.

virtual DtFilename DtScenarioExplorer::terrainDatabaseFilename ( ) const

virtual

Get the terrain database filename.

This is terrain database used by the backend and Gui (unless a different Gui terrain database is specified).

virtual DtFilename DtScenarioExplorer::componentAttachmentTableFilename ( ) const

virtual

Get the component attachment table filename.

virtual DtFilename DtScenarioExplorer::orderOfBattleFilename ( ) const

virtual

Get the order of battle filename.

virtual DtFilename DtScenarioExplorer::scenarioScriptsFilename ( ) const

virtual

Get the scenario scripts filename.

virtual DtFilename DtScenarioExplorer::orbatFilename ( ) const

virtual

Get the orbat filename.

virtual DtFilename DtScenarioExplorer::planFilename ( ) const

virtual

Get the plan filename.

virtual DtFilename DtScenarioExplorer::globalPlanFilename ( ) const

virtual

Get the global plan filename.

virtual DtFilename DtScenarioExplorer::parameterDatabaseFilename ( ) const

virtual

Get the parameter database filename.

virtual DtFilename DtScenarioExplorer::forceHostilityFilename ( ) const

virtual

virtual DtFilename DtScenarioExplorer::scenarioExtrasFilename ( ) const

virtual

virtual const std::vector<DtFilename>& DtScenarioExplorer::physicalWorldFilenames ( ) const

virtual

Get the physical world settings files.

virtual const std::vector<DtFilename>& DtScenarioExplorer::detonationParametersFilenames ( ) const

virtual

Get the detonation parameters files.

virtual const std::vector<DtFilename>& DtScenarioExplorer::indirectArtilleryTypesFilenames ( ) const

virtual

Get the indirect artillery types files.

virtual const std::vector<DtFilename>& DtScenarioExplorer::commModelFilenames ( ) const

virtual

Get the comm model settings files.

virtual DtFilename DtScenarioExplorer::objectMapFilename ( ) const

virtual

Get the object map filename.

virtual DtReal DtScenarioExplorer::timeMultiplier ( ) const

virtual

Get the time multiplier.

virtual bool DtScenarioExplorer::autoReorganize ( ) const

virtual

Get the auto reorganize flag.

virtual long int DtScenarioExplorer::randomNumberSeed ( ) const

virtual

Get the random number seed.

virtual DtString DtScenarioExplorer::frameRateModeString ( ) const

virtual

Get frame rate mode.

virtual DtFrameMode DtScenarioExplorer::frameRateMode ( ) const

virtual

virtual DtReal DtScenarioExplorer::frameDeltaTime ( ) const

virtual

Get frame delta time.

virtual DtTime DtScenarioExplorer::runDurationTime ( )

virtual

Get the run duration time.

By default, the run duration time is set to -1 (run indefinitely).

virtual DtTime DtScenarioExplorer::simTime ( ) const

virtual

Get simulation time.

virtual DtTime DtScenarioExplorer::runDurationTime ( ) const

virtual

Get run duration time.

virtual DtTime DtScenarioExplorer::exerciseStartTime ( ) const

virtual

Get exercise start date and time.

virtual const std::vector<DtFilename>& DtScenarioExplorer::additionalOpdFilenames ( ) const

virtual

Additional OPD files that will be appended (in the order specified) to the main OPD file for this scenario.

virtual DtRwNLengthStringVector DtScenarioExplorer::simulationModelSetFilenames ( )

virtual

Simulation model set files that want to be loaded for this scenario.

Note that the first file will be considered the "master" file. All others will merge into the "master" (subsequent model set files that contain .opd files will be considered "additional .opds")

virtual DtFilename DtScenarioExplorer::filename ( ) const

virtual

virtual bool DtScenarioExplorer::isValid ( bool  allowEmptyFilenames = true ) const

virtual

Returns true if all information necessary to load the scenario is present.

If allowEmptyFilenames is false, do not allow empty filenames for order of battle or plan

virtual double DtScenarioExplorer::version ( ) const

virtual

The version of the scenario file.

virtual void DtScenarioExplorer::processModelSets ( )

virtual

Processes all the model sets found in the myScenario object.

virtual void DtScenarioExplorer::loadCoreModelSets ( )

virtual

Loads the "core" model sets, which are the ones automatically loaded before any others, if they exist in the directory structure.

virtual void DtScenarioExplorer::processSimulationModelSets ( const std::vector< DtString > &  smsFiles )

virtual

Processes all model sets, adding to existing sets.

Call clearModelSets() to clear out existing information first to start with a clean slate

std::vector< DtSimulationModelSet * > & DtScenarioExplorer::modelSets ( )

inline

The following methods are used for the front-end only.

return the array of DtSimulationModelSet pointers.

References myModelSets.

const std::vector< DtSimulationModelSet * > & DtScenarioExplorer::modelSets ( ) const

inline

References myModelSets.

virtual const std::vector<DtFilename>& DtScenarioExplorer::modelSetForceFilenames ( ) const

virtual

Returns

A list of all (unique) force definition file names that support this scenario. (Pulled from the SMS files)

virtual const std::vector<DtFilename>& DtScenarioExplorer::modelSetFilenames ( ) const

virtual

Returns a list of all (unique) model set palette names that should be loaded in support of this scenario.

DtScenario * DtScenarioExplorer::scenario ( ) const

inline

Returns scenario associated with explorer.

References myScenario.

virtual void DtScenarioExplorer::addFilename ( std::vector< DtFilename > &  , const DtFilename &  map  ) const

virtual

virtual void DtScenarioExplorer::setSimulationModelSetFilenames ( const std::vector< DtFilename > &  s )

virtual

virtual void DtScenarioExplorer::setSimulationModelSetFilenames ( const DtRwNLengthStringVector &  )

virtual

virtual void DtScenarioExplorer::clearModelSets ( )

protectedvirtual

virtual void DtScenarioExplorer::mergeAdditionalOpdFiles ( )

protectedvirtual

virtual void DtScenarioExplorer::processModelSet ( DtSimulationModelSet *  )

protectedvirtual

Reimplemented in DtSimulationObjectEditorScenarioExplorer.

virtual void DtScenarioExplorer::processIncludedSMSs ( std::vector< DtSimulationModelSet * > &  loadedSets, DtSimulationModelSet *  set, DtReaderWriter::SearchPaths &  searchPaths  )

protectedvirtual

virtual void DtScenarioExplorer::loadIncludedSets ( DtSimulationModelSet *  set, std::vector< DtSimulationModelSet * > &  loadedSetsStarted, std::vector< DtSimulationModelSet * > &  loadedSetsCompleted, DtReaderWriter::SearchPaths &  parentSearchPaths, DtReaderWriter::SearchPaths &  childSearchPaths, DtReaderWriter::SearchPaths &  allPaths  )

protectedvirtual

Loads SMSs included by "set", and recurses into those if necessary.

Adds relevant search paths to each set. Search paths will need to be reordered once all sets are loaded, according to the order in "allPaths".

Parameters

set	Model sets included by this set are loaded.
loadedSetsStarted	"set" is added to this list before recursing, to prevent a set from being loaded twice.
loadedSetsCompleted	"set" is added to this list after recursing. This represents SMS priority order.
parentSearchPaths	Used to set up search paths for included sets.
childSearchPaths	Used to add included SMS's search paths to the current set.
allPaths	This will contain all paths loaded by included sets, in their correct priority order (last == highest priority).

Member Data Documentation

DtScenario* DtScenarioExplorer::myScenario

protected

Referenced by scenario().

DtFilename DtScenarioExplorer::myParameterDatabaseFilename

protected

DtFilename DtScenarioExplorer::myForceHostilityFilename

protected

DtFilename DtScenarioExplorer::myScenarioExtrasFilename

protected

std::vector<DtSimulationModelSet*> DtScenarioExplorer::myModelSets

protected

Referenced by modelSets().

std::vector<DtFilename> DtScenarioExplorer::myPhysicalWorldFilenames

protected

std::vector<DtFilename> DtScenarioExplorer::myDetonationParametersFilenames

protected

std::vector<DtFilename> DtScenarioExplorer::myIndirectArtilleryTypesFilenames

protected

std::vector<DtFilename> DtScenarioExplorer::myAdditionalOpdFilenames

protected

std::vector<DtFilename> DtScenarioExplorer::myCommModelFilenames

protected

std::vector<DtFilename> DtScenarioExplorer::myModelSetForceFilenames

protected

The following member variables are used in the front-end only.

std::vector<DtFilename> DtScenarioExplorer::myModelSetFilenames

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfutil/scenarioExplorer.h