DtSimulationModelSet Class Reference

A simulation model set contains all the information that can be used to support a scenario either for simulation or visualization. More...

Inheritance diagram for DtSimulationModelSet:

List of all members.

Public Member Functions
	DtSimulationModelSet ()
	default constructor
	DtSimulationModelSet (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtSimulationModelSet ()
	destructor
	DtSimulationModelSet (const DtSimulationModelSet &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtSimulationModelSet &	operator= (const DtSimulationModelSet &orig)
	assignment operator
virtual bool	load (const DtFilename &)
	Loads simulation model set from specified filename.
virtual bool	save (const DtFilename &, bool rebind=true)
	Saves simulation model set to specified filename.
const DtFilename &	path () const
	The path that is used as the relative (or absolute) path to load all internal files from.
const DtFilename &	filename () const
	Filename that this simulation model set was originally loaded from.
DtSimulationModelSet *	clone () const
virtual DtFilename	modelSetDirectory () const
	Returns the value of the model-set-directory variable, if it is defined for this model set, else returns an empty string.
virtual bool	setModelSetDirectory (const DtFilename &)
	Sets the model set directory if variable exists. If it does not, returns false.
const DtFilename &	hostilityFile () const
void	setHostilityFile (const DtFilename &s)
const DtFilename &	opdFile () const
	Get/set object parameter database file.
void	setOpdFile (const DtFilename &)
	Get/set object parameter database file.
const DtFilename &	physicalWorldFile () const
	Get/set physical world file.
void	setPhysicalWorldFile (const DtFilename &)
	Get/set physical world file.
const DtFilename &	indirectArtilleryTypesFile () const
	Get/set indirect artillery types file.
void	setIndirectArtilleryTypesFile (const DtFilename &)
	Get/set indirect artillery types file.
const DtFilename &	overlaySymbolMapFile () const
	Get/set overlay symbol map file.
void	setOverlaySymbolMapFile (const DtFilename &)
	Get/set overlay symbol map file.
const DtFilename &	threeDSymbolMapFile () const
	Get/set 3D map file.
void	setThreeDSymbolMapFile (const DtFilename &)
	Get/set 3D map file.
const DtFilename &	overlayMenuFile () const
	Get/set overlay menu file.
void	setOverlayMenuFile (const DtFilename &)
	Get/set overlay menu file.
const DtFilename &	modelSetFile () const
	Get/set model set file that is used to display items that are available to be created by the front-end.
void	setModelSetFile (const DtFilename &)
	Get/set model set file that is used to display items that are available to be created by the front-end.
const DtFilename &	menuFile () const
	Get/set menu file to display for create menu.
void	setMenuFile (const DtFilename &)
	Get/set menu file to display for create menu.
const DtSymbolMapperList &	symbolMapFiles () const
	Get/set list of symbol map files available for use.
void	setSymbolMapFiles (const DtSymbolMapperList &)
	Get/set list of symbol map files available for use.
const DtFilename &	commModelParameters () const
	Get/set communications model file.
void	setCommModelParameters (const DtFilename &)
	Get/set communications model file.
const DtString &	comment () const
	Get/set comment that will be written to top of file when saving out.
void	setComment (const DtString &)
	Get/set comment that will be written to top of file when saving out.
virtual DtFilename	defaultComponentAttachmentFile () const
	Returns the first component attachment filename in the list.
DtComponentAttachmentList &	componentAttachmentFileList ()
	Returns the list of component attachment lookup files.
const DtComponentAttachmentList &	componentAttachmentFileList () const
	Returns the list of component attachment lookup files.
const DtFilename &	scenarioDataFile () const
	Returns the scenario data file containing spawn templates, force hostility relationships,.
void	setScenarioDataFile (const DtFilename &n)
	Returns the scenario data file containing spawn templates, force hostility relationships,.
Protected Member Functions
virtual DtString	createSubstitutedPath (const DtFilename &, const DtString &modelSetDir)
	Creates a path (with filename) that will try and use the model-set-directory.
virtual void	setupVariableSubstitutedPaths ()
virtual void	substituteVariablePaths ()
virtual void	resetVariables ()
Protected Attributes
DtRwString	myOpdFile
DtRwString	myPhysicalWorldFile
DtRwString	myIndirectArtilleryTypesFile
DtRwString	myModelSetFile
DtRwString	myMenuFile
DtRwString	myOverlaySymbolMapFile
DtRwString	myOverlayMenuFile
DtRwString	my3DSymbolMapFile
DtRwString	myCommModelParameters
DtRwString	myHostilityFile
DtRwString	myScenarioDataFile
DtSymbolMapperList	mySymbolMapFiles
DtFilename	myPath
DtFilename	myFilename
DtString	myComment
DtFilename	mySubOpdFile
	Substituted copies of name.
DtFilename	mySubPhysicalWorldFile
DtFilename	mySubIndirectArtilleryTypesFile
DtFilename	mySubModelSetFile
DtFilename	mySubMenuFile
DtFilename	mySubOverlaySymbolMapFile
DtFilename	mySubOverlayMenuFile
DtFilename	mySub3DSymbolMapFile
DtFilename	mySubCommModelParameters
DtFilename	mySubHostilityFile
DtFilename	mySubScenarioDataFile
DtSymbolMapperList	mySubSymbolMapFiles
DtComponentAttachmentList	myComponentAttachmentFileList

---

Detailed Description

A simulation model set contains all the information that can be used to support a scenario either for simulation or visualization.

All files in this model set are defined to be relative to this file from where it was loaded. To get the complete path to a file, referece it as:

DtFilename::combine(simulationModelSet.path(), <file>) e.g: DtFilename::combine(simulationModelSet.path(), simulationModelSet.physicalWorldFile());

---

Constructor & Destructor Documentation

DtSimulationModelSet::DtSimulationModelSet

(

)

default constructor

DtSimulationModelSet::DtSimulationModelSet	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtSimulationModelSet::~DtSimulationModelSet

(

)

[virtual]

destructor

DtSimulationModelSet::DtSimulationModelSet	(	const DtSimulationModelSet &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

---

Member Function Documentation

DtSimulationModelSet& DtSimulationModelSet::operator=

(

const DtSimulationModelSet &

orig

)

assignment operator

virtual bool DtSimulationModelSet::load

(

const DtFilename &

)

[virtual]

Loads simulation model set from specified filename.

virtual bool DtSimulationModelSet::save	(	const DtFilename &	,
		bool	rebind = true
	)		[virtual]

Saves simulation model set to specified filename.

Part of the save process will be to try and make directories that might be part of simulation model set items relative to the file and subsitute the model-set-directory variable (if specified)

If rebind is false, takes originally read in names and saves them out, versus substituting variable name in for newly set files

const DtFilename & DtSimulationModelSet::path

(

)

const [inline]

The path that is used as the relative (or absolute) path to load all internal files from.

References myPath.

const DtFilename & DtSimulationModelSet::opdFile

(

)

const [inline]

Get/set object parameter database file.

References mySubOpdFile.

void DtSimulationModelSet::setOpdFile

(

const DtFilename &

f

)

[inline]

Get/set object parameter database file.

References mySubOpdFile.

const DtFilename & DtSimulationModelSet::physicalWorldFile

(

)

const [inline]

Get/set physical world file.

References mySubPhysicalWorldFile.

void DtSimulationModelSet::setPhysicalWorldFile

(

const DtFilename &

f

)

[inline]

Get/set physical world file.

References mySubPhysicalWorldFile.

const DtFilename & DtSimulationModelSet::indirectArtilleryTypesFile

(

)

const [inline]

Get/set indirect artillery types file.

References mySubIndirectArtilleryTypesFile.

void DtSimulationModelSet::setIndirectArtilleryTypesFile

(

const DtFilename &

f

)

[inline]

Get/set indirect artillery types file.

References mySubIndirectArtilleryTypesFile.

const DtFilename & DtSimulationModelSet::overlaySymbolMapFile

(

)

const [inline]

Get/set overlay symbol map file.

References mySubOverlaySymbolMapFile.

void DtSimulationModelSet::setOverlaySymbolMapFile

(

const DtFilename &

f

)

[inline]

Get/set overlay symbol map file.

References mySubOverlaySymbolMapFile.

const DtFilename & DtSimulationModelSet::threeDSymbolMapFile

(

)

const [inline]

Get/set 3D map file.

References mySub3DSymbolMapFile.

void DtSimulationModelSet::setThreeDSymbolMapFile

(

const DtFilename &

f

)

[inline]

Get/set 3D map file.

References mySub3DSymbolMapFile.

const DtFilename & DtSimulationModelSet::overlayMenuFile

(

)

const [inline]

Get/set overlay menu file.

References mySubOverlayMenuFile.

void DtSimulationModelSet::setOverlayMenuFile

(

const DtFilename &

f

)

[inline]

Get/set overlay menu file.

References mySubOverlayMenuFile.

const DtFilename & DtSimulationModelSet::modelSetFile

(

)

const [inline]

Get/set model set file that is used to display items that are available to be created by the front-end.

References mySubModelSetFile.

void DtSimulationModelSet::setModelSetFile

(

const DtFilename &

f

)

[inline]

Get/set model set file that is used to display items that are available to be created by the front-end.

References mySubModelSetFile.

const DtFilename & DtSimulationModelSet::menuFile

(

)

const [inline]

Get/set menu file to display for create menu.

If blank, will automatically generate create file based on items found in model set file

References mySubMenuFile.

void DtSimulationModelSet::setMenuFile

(

const DtFilename &

f

)

[inline]

Get/set menu file to display for create menu.

If blank, will automatically generate create file based on items found in model set file

References mySubMenuFile.

const DtSymbolMapperList & DtSimulationModelSet::symbolMapFiles

(

)

const [inline]

Get/set list of symbol map files available for use.

References mySubSymbolMapFiles.

void DtSimulationModelSet::setSymbolMapFiles

(

const DtSymbolMapperList &

s

)

[inline]

Get/set list of symbol map files available for use.

References mySubSymbolMapFiles.

const DtFilename & DtSimulationModelSet::commModelParameters

(

)

const [inline]

Get/set communications model file.

References mySubCommModelParameters.

void DtSimulationModelSet::setCommModelParameters

(

const DtFilename &

f

)

[inline]

Get/set communications model file.

References mySubCommModelParameters.

const DtString & DtSimulationModelSet::comment

(

)

const [inline]

Get/set comment that will be written to top of file when saving out.

References myComment.

void DtSimulationModelSet::setComment

(

const DtString &

c

)

[inline]

Get/set comment that will be written to top of file when saving out.

References myComment.

virtual DtFilename DtSimulationModelSet::defaultComponentAttachmentFile

(

)

const [virtual]

Returns the first component attachment filename in the list.

const DtFilename & DtSimulationModelSet::filename

(

)

const [inline]

Filename that this simulation model set was originally loaded from.

References myFilename.

Referenced by DtSimulationModelSetLoader::simulationModelSetFilename().

DtSimulationModelSet* DtSimulationModelSet::clone

(

)

const

virtual DtFilename DtSimulationModelSet::modelSetDirectory

(

)

const [virtual]

Returns the value of the model-set-directory variable, if it is defined for this model set, else returns an empty string.

virtual bool DtSimulationModelSet::setModelSetDirectory

(

const DtFilename &

)

[virtual]

Sets the model set directory if variable exists. If it does not, returns false.

DtComponentAttachmentList & DtSimulationModelSet::componentAttachmentFileList

(

)

[inline]

Returns the list of component attachment lookup files.

References myComponentAttachmentFileList.

const DtComponentAttachmentList & DtSimulationModelSet::componentAttachmentFileList

(

)

const [inline]

Returns the list of component attachment lookup files.

References myComponentAttachmentFileList.

const DtFilename & DtSimulationModelSet::hostilityFile

(

)

const [inline]

References mySubHostilityFile.

void DtSimulationModelSet::setHostilityFile

(

const DtFilename &

s

)

[inline]

References mySubHostilityFile.

const DtFilename & DtSimulationModelSet::scenarioDataFile

(

)

const [inline]

Returns the scenario data file containing spawn templates, force hostility relationships,.

References mySubScenarioDataFile.

void DtSimulationModelSet::setScenarioDataFile

(

const DtFilename &

n

)

[inline]

Returns the scenario data file containing spawn templates, force hostility relationships,.

References mySubScenarioDataFile.

virtual DtString DtSimulationModelSet::createSubstitutedPath	(	const DtFilename &	,
		const DtString &	modelSetDir
	)		[protected, virtual]

Creates a path (with filename) that will try and use the model-set-directory.

virtual void DtSimulationModelSet::setupVariableSubstitutedPaths

(

)

[protected, virtual]

virtual void DtSimulationModelSet::substituteVariablePaths

(

)

[protected, virtual]

virtual void DtSimulationModelSet::resetVariables

(

)

[protected, virtual]

---

Member Data Documentation

DtRwString DtSimulationModelSet::myOpdFile [protected]

DtRwString DtSimulationModelSet::myPhysicalWorldFile [protected]

DtRwString DtSimulationModelSet::myIndirectArtilleryTypesFile [protected]

DtRwString DtSimulationModelSet::myModelSetFile [protected]

DtRwString DtSimulationModelSet::myMenuFile [protected]

DtRwString DtSimulationModelSet::myOverlaySymbolMapFile [protected]

DtRwString DtSimulationModelSet::myOverlayMenuFile [protected]

DtRwString DtSimulationModelSet::my3DSymbolMapFile [protected]

DtRwString DtSimulationModelSet::myCommModelParameters [protected]

DtRwString DtSimulationModelSet::myHostilityFile [protected]

DtRwString DtSimulationModelSet::myScenarioDataFile [protected]

DtSymbolMapperList DtSimulationModelSet::mySymbolMapFiles [protected]

DtFilename DtSimulationModelSet::myPath [protected]

Referenced by path().

DtFilename DtSimulationModelSet::myFilename [protected]

Referenced by filename().

DtString DtSimulationModelSet::myComment [protected]

Referenced by comment(), and setComment().

DtFilename DtSimulationModelSet::mySubOpdFile [protected]

Substituted copies of name.

Referenced by opdFile(), and setOpdFile().

DtFilename DtSimulationModelSet::mySubPhysicalWorldFile [protected]

Referenced by physicalWorldFile(), and setPhysicalWorldFile().

DtFilename DtSimulationModelSet::mySubIndirectArtilleryTypesFile [protected]

Referenced by indirectArtilleryTypesFile(), and setIndirectArtilleryTypesFile().

DtFilename DtSimulationModelSet::mySubModelSetFile [protected]

Referenced by modelSetFile(), and setModelSetFile().

DtFilename DtSimulationModelSet::mySubMenuFile [protected]

Referenced by menuFile(), and setMenuFile().

DtFilename DtSimulationModelSet::mySubOverlaySymbolMapFile [protected]

Referenced by overlaySymbolMapFile(), and setOverlaySymbolMapFile().

DtFilename DtSimulationModelSet::mySubOverlayMenuFile [protected]

Referenced by overlayMenuFile(), and setOverlayMenuFile().

DtFilename DtSimulationModelSet::mySub3DSymbolMapFile [protected]

Referenced by setThreeDSymbolMapFile(), and threeDSymbolMapFile().

DtFilename DtSimulationModelSet::mySubCommModelParameters [protected]

Referenced by commModelParameters(), and setCommModelParameters().

DtFilename DtSimulationModelSet::mySubHostilityFile [protected]

Referenced by hostilityFile(), and setHostilityFile().

DtFilename DtSimulationModelSet::mySubScenarioDataFile [protected]

Referenced by scenarioDataFile(), and setScenarioDataFile().

DtSymbolMapperList DtSimulationModelSet::mySubSymbolMapFiles [protected]

Referenced by setSymbolMapFiles(), and symbolMapFiles().

DtComponentAttachmentList DtSimulationModelSet::myComponentAttachmentFileList [protected]

Referenced by componentAttachmentFileList().

---

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

• include/vrfutil/simulationModelSet.h