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:

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.
virtual bool	save (bool rebind=true)
	Saves file with last loaded filename. If that name is blank returns false.
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.
virtual void	setFilename (const DtFilename &)
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.
virtual void	setReadOnly (bool)
	Whether or not this simulation model set is read-only.
virtual bool	readOnly () const
const DtRwVariableBindings *	originalVariableBindings () const
	Returns the original variable bindings before substitutions.
DtRwVariableBindings *	originalVariableBindings ()
virtual void	saveVariableBindingsToOpdFile ()
	Saves the current variable bindings to the .opd file.
const DtFilename &	hostilityFile () const
void	setHostilityFile (const DtFilename &s)
const DtFilename &	opdFile () const
	Get/set object parameter database file.
void	setOpdFile (const DtFilename &)
const DtFilename &	physicalWorldFile () const
	Get/set physical world file.
void	setPhysicalWorldFile (const DtFilename &)
const DtFilename &	detonationParametersFile () const
	Get/set detonation parameters file.
void	setDetonationParametersFile (const DtFilename &)
const DtFilename &	ammunitionParametersFile () const
	Get/set ammunition parameters file.
void	setAmmunitionParametersFile (const DtFilename &)
const DtFilename &	indirectArtilleryTypesFile () const
	Get/set indirect artillery types file.
void	setIndirectArtilleryTypesFile (const DtFilename &)
const DtFilename &	commModelParameters () const
	Get/set communications model file.
void	setCommModelParameters (const DtFilename &)
const DtString &	comment () const
	Get/set comment that will be written to top of file when saving out.
void	setComment (const DtString &)
const DtString &	simulationObjectGroupConnection () const
	Get/set simulation object group connection file to use in entity editor when launching connections.
void	setSimulationObjectGroupConnection (const DtString &)
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
bool	preloadParameters () const
	Sets whether or not to preload parameters when loading the simulation model set. Default is false.
void	setPreloadParameters (bool)
virtual void	setVisualDataInAppData (bool)
	Whether or not the visual data exists in the app data structure.
virtual bool	visualDataInAppData () const
DtFilename	getDataDirectory (bool warnOnFailure=true) const
	Returns the directory that the data files are in.
DtFilename	getGuiDirectory (bool warnOnFailure=true) const
	Returns the directory that the gui files are in.
DtFilename	getVisualsDirectory (bool warnOnFailure=true) const
	Returns the visuals directory.
DtFilename	getRecycleBin (bool warnOnFailure=true) const
	Returns the recycle bin.
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 &)
	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).
virtual const DtString &	validatorString () const
const DtFilename &	scenarioDataFile () const
	Returns the scenario data file containing spawn templates, force hostility relationships,.
void	setScenarioDataFile (const DtFilename &n)
virtual std::vector< DtString >	includedSMSs () const
	SMSs included by this SMS.
virtual void	setIncludedSMSs (std::vector< DtString > smss)
virtual DtReaderWriter::SearchPaths	searchPaths () const
	search paths used by this SMS.
virtual void	addSearchPaths (const DtReaderWriter::SearchPaths &searchPaths)
virtual void	clearSearchPaths ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

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 ()
virtual void	placeOpdVariablesIntoVariableBindings ()
	Places the opd variables into the variable bindings for this class.
virtual DtReaderWriter *	readOpdFile () const
	Returns a reader/writer which represents the contents of the .opd file, which will just be variable parameters.
virtual void	substituteInVariables (const DtString &variable)
	Substitutes variables in variables.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.

Protected Attributes
DtRwString	myOpdFile
DtRwString	myPhysicalWorldFile
DtRwString	myDetonationParametersFile
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	myVisualDataInAppData
DtRwBoolean	myReadOnly
DtFilename	mySubOpdFile
	Substituted copies of name.
DtFilename	mySubPhysicalWorldFile
DtFilename	mySubDetonationParametersFile
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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 ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
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)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
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

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, reference 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 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

References mySubOpdFile.

const DtFilename & DtSimulationModelSet::physicalWorldFile ( ) const

inline

Get/set physical world file.

References mySubPhysicalWorldFile.

void DtSimulationModelSet::setPhysicalWorldFile ( const DtFilename &  f )

inline

References mySubPhysicalWorldFile.

const DtFilename & DtSimulationModelSet::detonationParametersFile ( ) const

inline

Get/set detonation parameters file.

References mySubDetonationParametersFile.

void DtSimulationModelSet::setDetonationParametersFile ( const DtFilename &  f )

inline

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

const DtFilename & DtSimulationModelSet::ammunitionParametersFile ( ) const

inline

Get/set ammunition parameters file.

References mySubAmmunitionParametersFile.

void DtSimulationModelSet::setAmmunitionParametersFile ( const DtFilename &  f )

inline

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

References mySubIndirectArtilleryTypesFile.

const DtFilename & DtSimulationModelSet::commModelParameters ( ) const

inline

Get/set communications model file.

References mySubCommModelParameters.

void DtSimulationModelSet::setCommModelParameters ( const DtFilename &  f )

inline

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

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

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

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

References myPreloadParameters.

virtual void DtSimulationModelSet::setVisualDataInAppData ( bool  )

virtual

Whether or not the visual data exists in the app data structure.

Default is false

virtual bool DtSimulationModelSet::visualDataInAppData ( ) const

virtual

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

Returns the directory that the data files are in.

Routines that return directories that are referenced by the model set

DtFilename DtSimulationModelSet::getGuiDirectory

(

bool

warnOnFailure = true

)

const

Returns the directory that the gui files are in.

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

DtFilename DtSimulationModelSet::getScriptedMovementDirectory

(

bool

warnOnFailure = true

)

const

DtFilename DtSimulationModelSet::getUIDirectory

(

bool

warnOnFailure = true

)

const

DtFilename DtSimulationModelSet::getSystemDirectory

(

bool

warnOnFailure = true

)

const

DtFilename DtSimulationModelSet::getParametersDirectory

(

bool

warnOnFailure = true

)

const

DtFilename DtSimulationModelSet::getAmmoSelectDirectory

(

bool

warnOnFailure = true

)

const

DtFilename DtSimulationModelSet::getNavDataDirectory

(

bool

warnOnFailure = true

)

const

DtFilename DtSimulationModelSet::getHitDirectory

(

bool

warnOnFailure = true

)

const

DtFilename DtSimulationModelSet::getDamageDirectory

(

bool

warnOnFailure = true

)

const

DtFilename DtSimulationModelSet::getDetectionDirectory

(

bool

warnOnFailure = true

)

const

DtFilename DtSimulationModelSet::getFormationDirectory

(

bool

warnOnFailure = true

)

const

DtFilename DtSimulationModelSet::getObjectGroupsDirectory

(

bool

warnOnFailure = false

)

const

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

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

References mySubScenarioDataFile.

virtual std::vector<DtString> DtSimulationModelSet::includedSMSs ( ) const

virtual

SMSs included by this SMS.

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

virtual

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

virtual void DtSimulationModelSet::clearSearchPaths ( )

virtual

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

protected

Referenced by setDetonationParametersFile().

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

protected

DtRwBoolean DtSimulationModelSet::myReadOnly

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/simulationModelSet.h