DtSimulationModelSet Class Reference

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, reference it as:

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

Inheritance diagram for DtSimulationModelSet:

Public Member Functions
	DtSimulationModelSet ()
	DtSimulationModelSet (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtSimulationModelSet ()
	DtSimulationModelSet (const DtSimulationModelSet &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtSimulationModelSet &	operator= (const DtSimulationModelSet &orig)
virtual bool	load (const DtFilename &)
virtual bool	save (const DtFilename &, bool rebind=true)
virtual bool	save (bool rebind=true)
const DtFilename &	path () const
const DtFilename &	filename () const
virtual void	setFilename (const DtFilename &)
DtSimulationModelSet *	clone () const
virtual DtFilename	modelSetDirectory () const
virtual bool	setModelSetDirectory (const DtFilename &)
virtual void	setReadOnly (bool)
virtual bool	readOnly () const
const DtRwVariableBindings *	originalVariableBindings () const
DtRwVariableBindings *	originalVariableBindings ()
virtual void	saveVariableBindingsToOpdFile ()
const DtFilename &	hostilityFile () const
void	setHostilityFile (const DtFilename &s)
const DtFilename &	opdFile () const
void	setOpdFile (const DtFilename &)
const DtFilename &	physicalWorldFile () const
void	setPhysicalWorldFile (const DtFilename &)
const DtFilename &	detonationParametersFile () const
void	setDetonationParametersFile (const DtFilename &)
const DtFilename &	enumerationsFile () const
void	setEnumerationsFile (const DtFilename &)
const DtFilename &	detonationTerrainDeformParametersFile () const
void	setdetonationTerrainDeformParametersFile (const DtFilename &)
const DtFilename &	ammunitionParametersFile () const
void	setAmmunitionParametersFile (const DtFilename &)
const DtFilename &	indirectArtilleryTypesFile () const
void	setIndirectArtilleryTypesFile (const DtFilename &)
const DtFilename &	commModelParameters () const
void	setCommModelParameters (const DtFilename &)
const DtString &	comment () const
void	setComment (const DtString &)
const DtString &	simulationObjectGroupConnection () const
void	setSimulationObjectGroupConnection (const DtString &)
virtual DtFilename	defaultComponentAttachmentFile () const
DtComponentAttachmentList &	componentAttachmentFileList ()
const DtComponentAttachmentList &	componentAttachmentFileList () const
bool	preloadParameters () const
void	setPreloadParameters (bool)
virtual void	setVisualDataInSharedData (bool)
virtual bool	visualDataInSharedData () const
DtFilename	getDataDirectory (bool warnOnFailure=true) const
DtFilename	getGuiDirectory (bool warnOnFailure=true) const
DtFilename	getExtrasDirectory () const
DtFilename	getVisualsDirectory (bool warnOnFailure=true) const
DtFilename	getRecycleBin (bool warnOnFailure=true) const
DtFilename	getRootDirectory (bool warnOnFailure=true) const
DtFilename	getScriptedMovementDirectory (bool warnOnFailure=true) const
DtFilename	getUIDirectory (bool warnOnFailure=true) const
DtFilename	getSystemDirectory (bool warnOnFailure=true) const
DtFilename	getParametersDirectory (bool warnOnFailure=true) const
DtFilename	getAmmoSelectDirectory (bool warnOnFailure=true) const
DtFilename	getNavDataDirectory (bool warnOnFailure=true) const
DtFilename	getHitDirectory (bool warnOnFailure=true) const
DtFilename	getDamageDirectory (bool warnOnFailure=true) const
DtFilename	getDetectionDirectory (bool warnOnFailure=true) const
DtFilename	getFormationDirectory (bool warnOnFailure=true) const
DtFilename	getObjectGroupsDirectory (bool warnOnFailure=false) const
virtual void	setValidatorString (const DtString &)
virtual const DtString &	validatorString () const
const DtFilename &	scenarioDataFile () const
void	setScenarioDataFile (const DtFilename &n)
virtual std::vector< DtString >	includedSMSs () const
virtual void	setIncludedSMSs (std::vector< DtString > smss)
virtual DtString	shortName () const
virtual void	setShortName (DtString &)
virtual DtReaderWriter::SearchPaths	searchPaths () const
virtual void	addSearchPaths (const DtReaderWriter::SearchPaths &searchPaths)
virtual void	clearSearchPaths ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Member Functions
virtual DtString	createSubstitutedPath (const DtFilename &, const DtString &modelSetDir)
virtual void	setupVariableSubstitutedPaths ()
virtual void	substituteVariablePaths ()
virtual void	resetVariables ()
virtual void	placeOpdVariablesIntoVariableBindings ()
virtual DtReaderWriter *	readOpdFile () const
virtual void	substituteInVariables (const DtString &variable)
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwString	myOpdFile
DtRwString	myPhysicalWorldFile
DtRwString	myEnumerationsFile
DtRwString	myDetonationParametersFile
DtRwString	myDetonationTerrainDeformParametersFile
DtRwString	myAmmunitionParametersFile
DtRwString	myIndirectArtilleryTypesFile
DtRwString	myCommModelParameters
DtRwString	myHostilityFile
DtRwString	myScenarioDataFile
DtRwString	myIncludedSMSs
DtRwString	myValidatorString
DtRwString	mySimulationObjectGroupConnection
DtRwBoolean	myPreloadParameters
DtFilename	myPath
DtFilename	myFilename
DtString	myComment
DtRwBoolean	myVisualDataInSharedData
DtRwBoolean	myReadOnly
DtRwString	myShortname
DtFilename	mySubOpdFile
DtFilename	mySubPhysicalWorldFile
DtFilename	mySubDetonationParametersFile
DtFilename	mySubEnumerationsFile
DtFilename	mySubDetonationTerrainDeformParametersFile
DtFilename	mySubAmmunitionParametersFile
DtFilename	mySubIndirectArtilleryTypesFile
DtFilename	mySubCommModelParameters
DtFilename	mySubHostilityFile
DtFilename	mySubScenarioDataFile
DtComponentAttachmentList	myComponentAttachmentFileList
DtRwVariableBindings *	myOriginalVariableBindings
DtReaderWriter::SearchPaths	mySearchPaths
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

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 substitute 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

virtual bool DtSimulationModelSet::save ( bool  rebind = true )

virtual

Saves file with last loaded filename. If that name is blank returns false.

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::detonationParametersFile ( ) const

inline

Get/set detonation parameters file.

References mySubDetonationParametersFile.

void DtSimulationModelSet::setDetonationParametersFile ( const DtFilename &  f )

inline

Get/set detonation parameters file.

References myDetonationParametersFile, mySubDetonationParametersFile, and DtRwString::setUnsubstitutedString().

const DtFilename & DtSimulationModelSet::enumerationsFile ( ) const

inline

Get/set enumerations file.

References mySubEnumerationsFile.

void DtSimulationModelSet::setEnumerationsFile ( const DtFilename &  f )

inline

Get/set enumerations file.

References myEnumerationsFile, mySubEnumerationsFile, and DtRwString::setUnsubstitutedString().

const DtFilename & DtSimulationModelSet::detonationTerrainDeformParametersFile ( ) const

inline

Get/set detonation terrain deformation parameters file.

References mySubDetonationTerrainDeformParametersFile.

void DtSimulationModelSet::setdetonationTerrainDeformParametersFile ( const DtFilename &  f )

inline

Get/set detonation terrain deformation parameters file.

References myDetonationTerrainDeformParametersFile, mySubDetonationTerrainDeformParametersFile, and DtRwString::setUnsubstitutedString().

const DtFilename & DtSimulationModelSet::ammunitionParametersFile ( ) const

inline

Get/set ammunition parameters file.

References mySubAmmunitionParametersFile.

void DtSimulationModelSet::setAmmunitionParametersFile ( const DtFilename &  f )

inline

Get/set ammunition parameters file.

References myAmmunitionParametersFile, mySubAmmunitionParametersFile, and DtRwString::setUnsubstitutedString().

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::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.

const DtString & DtSimulationModelSet::simulationObjectGroupConnection ( ) const

inline

Get/set simulation object group connection file to use in entity editor when launching connections.

References mySimulationObjectGroupConnection.

void DtSimulationModelSet::setSimulationObjectGroupConnection ( const DtString &  s )

inline

Get/set simulation object group connection file to use in entity editor when launching connections.

References mySimulationObjectGroupConnection.

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().

void DtSimulationModelSet::setFilename ( const DtFilename &  f )

inlinevirtual

References myFilename.

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.

bool DtSimulationModelSet::preloadParameters ( ) const

inline

Sets whether or not to preload parameters when loading the simulation model set. Default is false.

References myPreloadParameters.

void DtSimulationModelSet::setPreloadParameters ( bool  b )

inline

Sets whether or not to preload parameters when loading the simulation model set. Default is false.

References myPreloadParameters.

virtual void DtSimulationModelSet::setVisualDataInSharedData ( bool  )

virtual

Whether or not the visual data exists in the shared data structure. Default is false.

virtual bool DtSimulationModelSet::visualDataInSharedData ( ) const

virtual

Whether or not the visual data exists in the shared data structure. Default is false.

virtual void DtSimulationModelSet::setReadOnly ( bool  )

virtual

Whether or not this simulation model set is read-only. This is only for the Simulation Object Editor to indicate whether or not this simulation model set can be modified. Default is false.

virtual bool DtSimulationModelSet::readOnly ( ) const

virtual

DtFilename DtSimulationModelSet::getDataDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getGuiDirectory

(

bool

warnOnFailure = true

)

const

Returns the directory that the gui files are in.

DtFilename DtSimulationModelSet::getExtrasDirectory

(

)

const

Returns the extras directory.

DtFilename DtSimulationModelSet::getVisualsDirectory

(

bool

warnOnFailure = true

)

const

Returns the visuals directory.

DtFilename DtSimulationModelSet::getRecycleBin

(

bool

warnOnFailure = true

)

const

Returns the recycle bin.

DtFilename DtSimulationModelSet::getRootDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getScriptedMovementDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getUIDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getSystemDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getParametersDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getAmmoSelectDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getNavDataDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getHitDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getDamageDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getDetectionDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getFormationDirectory

(

bool

warnOnFailure = true

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

DtFilename DtSimulationModelSet::getObjectGroupsDirectory

(

bool

warnOnFailure = false

)

const

Routines that return directories that are referenced by the model set.

Returns the directory that the data files are in

const DtRwVariableBindings* DtSimulationModelSet::originalVariableBindings ( ) const

inline

Returns the original variable bindings before substitutions.

DtRwVariableBindings* DtSimulationModelSet::originalVariableBindings ( )

inline

void DtSimulationModelSet::setValidatorString ( const DtString &  s )

inlinevirtual

The string that will be parsed to find out which validator(s) are to be used to validate this sms (that it is valid to load as part of the current simulation setup).

The format is <validator>[=parameter1,[parameter2...]][;<validator>[=...]] ex.: protocol=hla1516;containsStateData

References myValidatorString.

const DtString & DtSimulationModelSet::validatorString ( ) const

inlinevirtual

The string that will be parsed to find out which validator(s) are to be used to validate this sms (that it is valid to load as part of the current simulation setup).

The format is <validator>[=parameter1,[parameter2...]][;<validator>[=...]] ex.: protocol=hla1516;containsStateData

References myValidatorString.

virtual void DtSimulationModelSet::saveVariableBindingsToOpdFile ( )

virtual

Saves the current variable bindings to the .opd file.

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 std::vector<DtString> DtSimulationModelSet::includedSMSs ( ) const

virtual

SMSs included by this SMS.

virtual void DtSimulationModelSet::setIncludedSMSs ( std::vector< DtString >  smss )

virtual

SMSs included by this SMS.

virtual DtString DtSimulationModelSet::shortName ( ) const

virtual

Short name for this SMS that is prepended to new entity files in the Simulation Object Editor.

virtual void DtSimulationModelSet::setShortName ( DtString &  )

virtual

Short name for this SMS that is prepended to new entity files in the Simulation Object Editor.

virtual DtReaderWriter::SearchPaths DtSimulationModelSet::searchPaths ( ) const

virtual

search paths used by this SMS. Additional search paths will be added by included SMSs.

virtual void DtSimulationModelSet::addSearchPaths ( const DtReaderWriter::SearchPaths &  searchPaths )

virtual

search paths used by this SMS. Additional search paths will be added by included SMSs.

virtual void DtSimulationModelSet::clearSearchPaths ( )

virtual

search paths used by this SMS. Additional search paths will be added by included SMSs.

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

protectedvirtual

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

virtual void DtSimulationModelSet::setupVariableSubstitutedPaths ( )

protectedvirtual

virtual void DtSimulationModelSet::substituteVariablePaths ( )

protectedvirtual

virtual void DtSimulationModelSet::resetVariables ( )

protectedvirtual

virtual void DtSimulationModelSet::placeOpdVariablesIntoVariableBindings ( )

protectedvirtual

Places the opd variables into the variable bindings for this class.

virtual DtReaderWriter* DtSimulationModelSet::readOpdFile ( ) const

protectedvirtual

Returns a reader/writer which represents the contents of the .opd file, which will just be variable parameters.

virtual void DtSimulationModelSet::substituteInVariables ( const DtString &  variable )

protectedvirtual

Substitutes variables in variables.

Member Data Documentation

DtRwString DtSimulationModelSet::myOpdFile

protected

DtRwString DtSimulationModelSet::myPhysicalWorldFile

protected

DtRwString DtSimulationModelSet::myEnumerationsFile

protected

Referenced by setEnumerationsFile().

DtRwString DtSimulationModelSet::myDetonationParametersFile

protected

Referenced by setDetonationParametersFile().

DtRwString DtSimulationModelSet::myDetonationTerrainDeformParametersFile

protected

Referenced by setdetonationTerrainDeformParametersFile().

DtRwString DtSimulationModelSet::myAmmunitionParametersFile

protected

Referenced by setAmmunitionParametersFile().

DtRwString DtSimulationModelSet::myIndirectArtilleryTypesFile

protected

DtRwString DtSimulationModelSet::myCommModelParameters

protected

DtRwString DtSimulationModelSet::myHostilityFile

protected

DtRwString DtSimulationModelSet::myScenarioDataFile

protected

DtRwString DtSimulationModelSet::myIncludedSMSs

protected

DtRwString DtSimulationModelSet::myValidatorString

protected

Referenced by setValidatorString(), and validatorString().

DtRwString DtSimulationModelSet::mySimulationObjectGroupConnection

protected

Referenced by setSimulationObjectGroupConnection(), and simulationObjectGroupConnection().

DtRwBoolean DtSimulationModelSet::myPreloadParameters

protected

Referenced by preloadParameters(), and setPreloadParameters().

DtFilename DtSimulationModelSet::myPath

protected

Referenced by path().

DtFilename DtSimulationModelSet::myFilename

protected

Referenced by filename(), and setFilename().

DtString DtSimulationModelSet::myComment

protected

Referenced by comment(), and setComment().

DtRwBoolean DtSimulationModelSet::myVisualDataInSharedData

protected

DtRwBoolean DtSimulationModelSet::myReadOnly

protected

DtRwString DtSimulationModelSet::myShortname

protected

DtFilename DtSimulationModelSet::mySubOpdFile

protected

Substituted copies of name.

Referenced by opdFile(), and setOpdFile().

DtFilename DtSimulationModelSet::mySubPhysicalWorldFile

protected

Referenced by physicalWorldFile(), and setPhysicalWorldFile().

DtFilename DtSimulationModelSet::mySubDetonationParametersFile

protected

Referenced by detonationParametersFile(), and setDetonationParametersFile().

DtFilename DtSimulationModelSet::mySubEnumerationsFile

protected

Referenced by enumerationsFile(), and setEnumerationsFile().

DtFilename DtSimulationModelSet::mySubDetonationTerrainDeformParametersFile

protected

Referenced by detonationTerrainDeformParametersFile(), and setdetonationTerrainDeformParametersFile().

DtFilename DtSimulationModelSet::mySubAmmunitionParametersFile

protected

Referenced by ammunitionParametersFile(), and setAmmunitionParametersFile().

DtFilename DtSimulationModelSet::mySubIndirectArtilleryTypesFile

protected

Referenced by indirectArtilleryTypesFile(), and setIndirectArtilleryTypesFile().

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().

DtComponentAttachmentList DtSimulationModelSet::myComponentAttachmentFileList

protected

Referenced by componentAttachmentFileList().

DtRwVariableBindings* DtSimulationModelSet::myOriginalVariableBindings

protected

DtReaderWriter::SearchPaths DtSimulationModelSet::mySearchPaths

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/simulationModelSet.h