Inheritance diagram for DtScenario:

Public Member Functions
	DtScenario ()

	DtScenario (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)

virtual	~DtScenario ()

	DtScenario (const DtScenario &orig)

DtScenario &	operator= (const DtScenario &orig)

virtual bool	init ()

virtual bool	readScenarioFile (const DtFilename &filename)

bool	saveAsZipFile () const

virtual void	setSaveAsZipFile (bool)

virtual bool	save ()

virtual DtString	toXml (const DtFilename &scenarioFilename)

virtual void	setupScenarioFilenames (const DtFilename &scenarioFilename, bool saveObjectMap=true)

virtual bool	save (const DtFilename &filename, bool saveObjectMap=true)

virtual DtScenario *	clone () const

virtual void	setComponentAttachmentTableFilename (const DtFilename &filename)

virtual const DtFilename &	componentAttachmentTableFilename () const

virtual void	setTerrainDatabaseFilename (const DtFilename &filename)

virtual const DtFilename &	terrainDatabaseFilename () const

virtual void	setGuiTerrainDatabaseFilename (const DtFilename &filename)

virtual const DtFilename &	guiTerrainDatabaseFilename () const

virtual void	setOrderOfBattleFilename (const DtFilename &filename)

virtual DtFilename	orderOfBattleFilename () const

virtual void	setScenarioScriptsFilename (const DtFilename &filename)

virtual DtFilename	scenarioScriptsFilename () const

virtual void	setOrbatFilename (const DtFilename &filename)

virtual DtFilename	orbatFilename () const

virtual void	setPlanFilename (const DtFilename &filename)

virtual DtFilename	planFilename () const

virtual void	setParameterDatabaseFilename (const DtFilename &filename)

virtual const DtFilename &	parameterDatabaseFilename () const

virtual void	setPhysicalWorldFilename (const DtFilename &filename)

virtual const DtFilename &	physicalWorldFilename () const

virtual void	setObjectMapFilename (const DtFilename &filename)

virtual DtFilename	objectMapFilename () const

virtual void	setOverlayFilename (const DtFilename &filename)

virtual DtFilename	overlayFilename () const

virtual void	setSelectionGroupsFilename (const DtFilename &filename)

virtual DtFilename	selectionGroupsFilename () const

virtual void	setSymbolMapFilename (const DtFilename &filename)

virtual const DtFilename &	symbolMapFilename () const

virtual void	setCreateMenuFilename (const DtFilename &filename)

virtual const DtFilename &	createMenuFilename () const

virtual void	setForceHostilityFilename (const DtFilename &filename)

virtual DtFilename	forceHostilityFilename () const

virtual void	setUseDayNightIlluminationModel (bool)

virtual bool	useDayNightIlluminationModel () const

virtual void	setTimeMultiplier (DtReal multiplier)

virtual DtReal	timeMultiplier () const

virtual void	setAutoReorganize (const bool &flag)

virtual const bool &	autoReorganize () const

virtual void	setRandomNumberSeed (long int numberSeed)

virtual long int	randomNumberSeed () const

virtual DtString	frameRateModeString () const

virtual DtFrameMode	frameRateMode () const

virtual void	setFrameRateModeString (DtString value)

virtual void	setFrameRateMode (DtFrameMode value)

virtual DtReal	frameDeltaTime () const

virtual void	setFrameDeltaTime (DtReal value)

virtual DtTime	runDurationTime () const

virtual void	setRunDurationTime (DtTime time)

virtual void	setSimTime (DtTime time)

virtual DtTime	simTime () const

virtual void	setExerciseStartDateAndTime (int year, int month, int day, int hour, int minute, int second)

virtual void	setExerciseStartDateAndTime (DtTime time)

virtual void	setExerciseStartTime (DtTime time)

virtual DtTime	exerciseStartTime () const

virtual void	setSetScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation (bool, int i=10 *3600)

virtual int	setScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation () const

virtual bool	shouldSetScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation () const

virtual void	setScenarioDescription (const DtString &)

virtual DtString	scenarioDescription () const

virtual bool	isParameterDatabaseRwStringSpecified ()

virtual bool	isPhysicalWorldRwStringSpecified ()

virtual bool	isOrderOfBattleRwStringSpecified ()

virtual bool	isScenarioScriptsRwStringSpecified ()

virtual bool	isOrbatRwStringSpecified ()

virtual bool	isOverlayRwStringSpecified ()

virtual bool	isSelectionGroupsRwStringSpecified ()

virtual bool	isSymbolMapRwStringSpecified ()

virtual bool	isCreateMenuRwStringSpecified ()

virtual bool	isPlanRwStringSpecified ()

virtual bool	isObjectMapRwStringSpecified ()

virtual bool	isTimeMultiplierSpecified ()

virtual bool	isAutoReorganizeRwStringSpecified ()

virtual bool	isRandomNumberSeedSpecified ()

virtual bool	isFrameRateModeSpecified ()

virtual bool	isRunDurationTimeSpecified ()

virtual bool	isFrameDeltaTimeSpecified ()

virtual bool	isSimTimeSpecified ()

virtual bool	isExerciseStartTimeSpecified ()

virtual bool	isForceHostilityRWStringSpecified ()

virtual bool	isScenarioExtrasRWStringSpecified ()

virtual void	setFilename (const DtFilename &)

virtual const DtFilename &	filename () const

virtual bool	writeScenarioFile (const DtFilename &filename)

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())

virtual void	putSelf (DtEnvironmentSP env, DtEnvValueSP parent) const

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	getSelf (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	finalizeGetSelf ()

virtual bool	isValid (bool allowEmptyFilenames=true, DtString *retMessage=0) const

virtual double	version () const

virtual bool	relativeToScenarioFile () const

virtual void	setToCurrentVersion ()

virtual void	updateSimulationModelSetFilenames ()

virtual void	resolveSimulationModelSetPaths ()

virtual void	resolveDataPaths ()


virtual void	setGlobalPlanFilename (const DtFilename &filename)

virtual DtFilename	globalPlanFilename () const


virtual void	setScenarioExtrasFilename (const DtFilename &f)

virtual DtFilename	scenarioExtrasFilename () const


virtual void	setCreateGlobalEnvironment (bool b)

virtual bool	createGlobalEnvironment () const


virtual void	setCreateGlobalDynamicTerrain (bool b)

virtual bool	createGlobalDynamicTerrain () const


virtual DtRwNLengthStringVector &	additionalOpdFilenames ()

virtual const DtRwNLengthStringVector &	additionalOpdFilenames () const

virtual void	addAdditionalOpdFilename (const DtString &)

virtual void	removeAdditonalOpdFilename (int iIndex)

virtual void	setAdditionalOpdFilenames (const DtRwNLengthStringVector &)


virtual DtRwNLengthStringVector &	simulationModelSetFilenames ()

virtual const DtRwNLengthStringVector &	simulationModelSetFilenames () const

virtual DtRwNLengthStringVector &	unresolvedSimulationModelSetFilenames ()

virtual const DtRwNLengthStringVector &	unresolvedSimulationModelSetFilenames () const

virtual void	addSimulationModelSetFilename (const DtString &)

virtual void	removeSimulationModelSetFilename (int iIndex)

virtual void	setSimulationModelSetFilenames (const DtRwNLengthStringVector &)

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

virtual void	setSimulationModelSetFilenames (const std::vector< std::string > &)


virtual DtRwKeyValueList &	scenarioData ()

virtual const DtRwKeyValueList &	scenarioData () const


virtual DtString	scenarioName () const

virtual void	setScenarioName (const DtString &name)

virtual bool	scenarioNameSpecified () const


virtual void	setGuiRuntimeLoadBalancingScheme (const DtString &scheme, const DtString &userData)

virtual void	getGuiRuntimeLoadBalancingScheme (DtString &scheme, DtString &userData) const


virtual void	setSimRemoteAttachmentBalancingScheme (const DtString &scheme, const DtString &userData)

virtual void	getSimRemoteAttachmentBalancingScheme (DtString &scheme, DtString &userData) const

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) const

virtual	~DtReaderWriter ()

virtual void	postPutSelf ()

virtual void	prePutSelf ()

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	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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)

Static Public Member Functions
static bool	saveBufferToScenarioZipFile (const DtFilename &scenanarioZipFile, const DtFilename &zipContentsFile, const DtString &buffer)

static bool	saveBufferToScenarioZipFile (const DtFilename &scenanarioZipFile, const DtFilename &zipContentsFile, const char *buffer, int length)

static bool	readBufferFromScenarioZipFile (const DtFilename &scenanarioZipFile, const DtFilename &zipContentsFile, DtString &buffer, bool onlyNeedsExtensionMatch=true)

static bool	fileExistsInZipFile (const DtFilename &scenanarioZipFile, const DtFilename &zipContentsFile, bool onlyNeedsExtensionMatch=true)

static bool	extractScenarioFileFromZipFile (const DtFilename &scenarioZipFile, const DtFilename &zipContentsFile, bool onlyNeedsExtensionMatch=true)

static bool	readScenarioFromZipFile (const DtFilename &f, DtScenario &scenario)

static bool	saveFileToScenarioZipFile (const DtFilename &scenanarioZipFile, const DtFilename &zipContentsFile)

static bool	isScenarioZipFile (const DtFilename &)

static DtFilename	validTerrainFile (const DtFilename &)

static double	currentScenarioVersion ()

static DtFilename	reworkDataDirectory (const DtFilename &, DtFilename *unresolvedFilename=nullptr)

static DtFilename	replaceDirectoryWithAppropriateVariable (const DtFilename &)

static DtString	replaceDirectoryWithAppropriateVariable (const DtString &)

static DtString	getFrameModeNameFromFrameModeType (DtFrameMode)

static DtFrameMode	getFrameModeTypeFromFrameModeName (const DtString &frameModeName)

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)

Protected Member Functions
virtual DtFilename	absoluteFilename (const DtFilename &) const

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtFilename	myComponentAttachmentTableFilename

DtRwString	myComponentAttachmentTableRwString

DtFilename	myFilename

DtFilename	myTerrainDatabaseFilename

DtRwString	myTerrainDatabaseRwString

DtFilename	myPhysicalWorldFilename

DtRwString	myPhysicalWorldRwString

DtFilename	myGuiTerrainDatabaseFilename

DtRwString	myGuiTerrainDatabaseRwString

DtFilename	myOrderOfBattleFilename

DtRwString	myOrderOfBattleRwString

DtFilename	myScenarioScriptsFilename

DtRwString	myScenarioScriptsRwString

DtFilename	myOrbatFilename

DtRwString	myOrbatRwString

DtFilename	myPlanFilename

DtRwString	myPlanRwString

DtFilename	myGlobalPlanFilename

DtRwString	myGlobalPlanRwString

DtFilename	myParameterDatabaseFilename

DtRwString	myParameterDatabaseRwString

DtFilename	myOverlayFilename

DtRwString	myOverlayRwString

DtFilename	mySelectionGroupsFilename

DtRwString	mySelectionGroupsRwString

DtFilename	mySymbolMapFilename

DtRwString	mySymbolMapRwString

DtFilename	myCreateMenuFilename

DtRwString	myCreateMenuRwString

DtFilename	myObjectMapFilename

DtRwString	myObjectMapRwString

DtFilename	myForceHostilityFilename

DtRwString	myForceHostilityRwString

DtFilename	myScenarioExtrasFilename

DtRwString	myScenarioExtrasRWString

DtRwReal	myTimeMultiplier

bool	myAutoReorganize

DtRwBoolean	myAutoReorganizeRW

DtRwInt	myRandomNumberSeed

DtRwString	myFrameRateModeString

DtFrameMode	myFrameRateMode

DtRwReal	myFrameDeltaTime

DtRwReal	myRunDurationTime

DtRwReal	mySimTime

DtRwReal	myExerciseStartTime

DtRwNLengthStringVector	myAdditionalOpdFilenames

DtRwNLengthStringVector	mySimulationModelSetFilenames

DtRwNLengthStringVector	myResolvedSimulationModelSetFilenames

DtRwString	myGuiRuntimeLoadBalancingScheme

DtRwString	myGuiRuntimeLoadBalancingSchemeData

DtRwString	mySimRemoteAttachmentBalancingScheme

DtRwString	mySimRemoteAttachmentBalancingSchemeData

DtRwString	myScenarioName

DtRwKeyValueList	myScenarioData

DtRwReal	myVersion

bool	mySaveAsZipFile

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

Static Protected Attributes
static DtString	thePhysicalWorldFilenameExtension

static DtString	theOrderOfBattleExtension

static DtString	theScenarioScriptsExtension

static DtString	theOrbatExtension

static DtString	theOverlayExtension

static DtString	theSelectionGroupsExtension

static DtString	theSymbolMapExtension

static DtString	theCreateMenuExtension

static DtString	thePlanExtension

static DtString	theGlobalPlanExtension

static DtString	theObjectMapExtension

static DtString	theParameterDatabaseExtension

static DtString	theFileExtension

static DtString	theForceHostilityExtension

static DtString	theScenarioDataExtension

static double	theScenarioVersion

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

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

Constructor & Destructor Documentation

DtScenario::DtScenario ( )

default constructor

DtScenario::DtScenario	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `0`
	)

real constructor

virtual DtScenario::~DtScenario ( )

virtual

destructor

DtScenario::DtScenario ( const DtScenario & orig )

copy constructor

Member Function Documentation

DtScenario& DtScenario::operator= ( const DtScenario & orig )

assignment operator

virtual bool DtScenario::init ( )

virtual

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

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

virtual

Read itself from file.

bool DtScenario::saveAsZipFile ( ) const

Whether or not, when saving, to treat file as a zip file. This will be true if the flag to save as a zip file is true or the extension is the compressed extension.

virtual void DtScenario::setSaveAsZipFile ( bool )

virtual

virtual bool DtScenario::save ( )

virtual

Saves the scenario to a file with the current filename, if it exists.

static bool DtScenario::saveBufferToScenarioZipFile	(	const DtFilename &	scenanarioZipFile,
		const DtFilename &	zipContentsFile,
		const DtString &	buffer
	)

static

Writes the contents of the buffer to a filename of the given name within the zip archive given by the supplied scenario file If the file does not exist it will be created.

static bool DtScenario::saveBufferToScenarioZipFile	(	const DtFilename &	scenanarioZipFile,
		const DtFilename &	zipContentsFile,
		const char *	buffer,
		int	length
	)

static

static bool DtScenario::readBufferFromScenarioZipFile	(	const DtFilename &	scenanarioZipFile,
		const DtFilename &	zipContentsFile,
		DtString &	buffer,
		bool	onlyNeedsExtensionMatch = `true`
	)

static

If the onlyNeedsMatchExtension flag is true will extract the first file found with the given extension, else will do a full filename match Reads the buffer from the zip file given the file name in the zip file to look for.

static bool DtScenario::fileExistsInZipFile	(	const DtFilename &	scenanarioZipFile,
		const DtFilename &	zipContentsFile,
		bool	onlyNeedsExtensionMatch = `true`
	)

static

Returns true if the specified file exists in the scenario zip file.

static bool DtScenario::extractScenarioFileFromZipFile	(	const DtFilename &	scenarioZipFile,
		const DtFilename &	zipContentsFile,
		bool	onlyNeedsExtensionMatch = `true`
	)

static

Extract the given file and saves it with the supplied filename. Since only the filename is checked the file to save to can be a complete path plus filename.

static bool DtScenario::readScenarioFromZipFile	(	const DtFilename &	f,
		DtScenario &	scenario
	)

static

If the given file is a zip file, fill the scenario given with the scenario information found within.

static bool DtScenario::saveFileToScenarioZipFile	(	const DtFilename &	scenanarioZipFile,
		const DtFilename &	zipContentsFile
	)

static

Saves the contents of the file to the zip file. If zip file does not exist will create.

static bool DtScenario::isScenarioZipFile ( const DtFilename & )

static

Returns true if the given file is a scenario zip file.

virtual DtString DtScenario::toXml ( const DtFilename & scenarioFilename )

virtual

Save and return file contents to .xml string. The reason why the name needs to be supplied is to make sure the internal filenames match the scenario (order of battl, object map, etc)

virtual void DtScenario::setupScenarioFilenames	(	const DtFilename &	scenarioFilename,
		bool	saveObjectMap = `true`
	)

virtual

Simply sets up what the filenames to save would be without saving the scenario file.

virtual bool DtScenario::save	(	const DtFilename &	filename,
		bool	saveObjectMap = `true`
	)

virtual

Saves the scenario to a file with the given filename. The saveObjectMap parameter allows the object map name to be written out as a null string.

virtual DtScenario* DtScenario::clone ( ) const

virtual

Clone function. Returns newly created instance of a DtScenario, cloned from ourself.

virtual void DtScenario::setComponentAttachmentTableFilename ( const DtFilename & filename )

virtual

Set/get the remote component attachment filename.

virtual const DtFilename& DtScenario::componentAttachmentTableFilename ( ) const

virtual

virtual void DtScenario::setTerrainDatabaseFilename ( const DtFilename & filename )

virtual

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

virtual const DtFilename& DtScenario::terrainDatabaseFilename ( ) const

virtual

virtual void DtScenario::setGuiTerrainDatabaseFilename ( const DtFilename & filename )

virtual

Set/get the GUI terrain database filename (if one exists).

virtual const DtFilename& DtScenario::guiTerrainDatabaseFilename ( ) const

virtual

virtual void DtScenario::setOrderOfBattleFilename ( const DtFilename & filename )

virtual

Set/get the order of battle filename.

virtual DtFilename DtScenario::orderOfBattleFilename ( ) const

virtual

virtual void DtScenario::setScenarioScriptsFilename ( const DtFilename & filename )

virtual

Set/get the scenario scripts filename.

virtual DtFilename DtScenario::scenarioScriptsFilename ( ) const

virtual

virtual void DtScenario::setOrbatFilename ( const DtFilename & filename )

virtual

Set/get the orbat filename.

virtual DtFilename DtScenario::orbatFilename ( ) const

virtual

virtual void DtScenario::setPlanFilename ( const DtFilename & filename )

virtual

Set/get the plan filename.

virtual DtFilename DtScenario::planFilename ( ) const

virtual

virtual void DtScenario::setGlobalPlanFilename ( const DtFilename & filename )

virtual

Set/get the global plan filename.

virtual DtFilename DtScenario::globalPlanFilename ( ) const

virtual

Set/get the global plan filename.

virtual void DtScenario::setParameterDatabaseFilename ( const DtFilename & filename )

virtual

Set/get the parameter database filename.

virtual const DtFilename& DtScenario::parameterDatabaseFilename ( ) const

virtual

virtual void DtScenario::setPhysicalWorldFilename ( const DtFilename & filename )

virtual

Set/get the physical world settings file.

virtual const DtFilename& DtScenario::physicalWorldFilename ( ) const

virtual

virtual void DtScenario::setObjectMapFilename ( const DtFilename & filename )

virtual

Set/get the object map filename.

virtual DtFilename DtScenario::objectMapFilename ( ) const

virtual

virtual void DtScenario::setOverlayFilename ( const DtFilename & filename )

virtual

Set/get the overlay filename. These are overlays that are not published on the network.

virtual DtFilename DtScenario::overlayFilename ( ) const

virtual

virtual void DtScenario::setSelectionGroupsFilename ( const DtFilename & filename )

virtual

Set/get the selection groups filename.

virtual DtFilename DtScenario::selectionGroupsFilename ( ) const

virtual

virtual void DtScenario::setSymbolMapFilename ( const DtFilename & filename )

virtual

Set/get the symbol map file to use to display symbols on the front end. Blank entry means use current.

virtual const DtFilename& DtScenario::symbolMapFilename ( ) const

virtual

virtual void DtScenario::setCreateMenuFilename ( const DtFilename & filename )

virtual

Set/get the create menu to use with this scenario. Blank entry means use current.

virtual const DtFilename& DtScenario::createMenuFilename ( ) const

virtual

virtual void DtScenario::setForceHostilityFilename ( const DtFilename & filename )

virtual

Set/get the Forces and hostility matrix to use with this scenario. Blank entry means to use the default from the SMS. (Obsolete; not used after version 4.03)

virtual DtFilename DtScenario::forceHostilityFilename ( ) const

virtual

virtual void DtScenario::setScenarioExtrasFilename ( const DtFilename & f )

virtual

Set/get the scenario data, including the force/hostility matrix, the spawn templates, ...

virtual DtFilename DtScenario::scenarioExtrasFilename ( ) const

virtual

Set/get the scenario data, including the force/hostility matrix, the spawn templates, ...

virtual void DtScenario::setUseDayNightIlluminationModel ( bool )

virtual

Whether or not to use the day/night illumination model on new scenario. This value will only be valid for when theis scenario is used when creating a new scenario. This value is added as part of the scenario's extra data, and, will be removed from the scenario object in the cgf when the new scenario is created. When this scenario is saved this value will not be present in the scenario extras data.

virtual bool DtScenario::useDayNightIlluminationModel ( ) const

virtual

virtual void DtScenario::setTimeMultiplier ( DtReal multiplier )

virtual

Set/get the time multiplier.

virtual DtReal DtScenario::timeMultiplier ( ) const

virtual

virtual void DtScenario::setAutoReorganize ( const bool & flag )

virtual

Set/get the auto reorganize flag.

virtual const bool& DtScenario::autoReorganize ( ) const

virtual

virtual void DtScenario::setRandomNumberSeed ( long int numberSeed )

virtual

Set/get the random number seed.

virtual long int DtScenario::randomNumberSeed ( ) const

virtual

virtual DtString DtScenario::frameRateModeString ( ) const

virtual

Get/Set frame rate mode.

virtual DtFrameMode DtScenario::frameRateMode ( ) const

virtual

virtual void DtScenario::setFrameRateModeString ( DtString value )

virtual

virtual void DtScenario::setFrameRateMode ( DtFrameMode value )

virtual

virtual DtReal DtScenario::frameDeltaTime ( ) const

virtual

Get/Set frame delta time.

virtual void DtScenario::setFrameDeltaTime ( DtReal value )

virtual

virtual DtTime DtScenario::runDurationTime ( ) const

virtual

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

virtual void DtScenario::setRunDurationTime ( DtTime time )

virtual

virtual void DtScenario::setSimTime ( DtTime time )

virtual

Set/get simulation time.

virtual DtTime DtScenario::simTime ( ) const

virtual

virtual void DtScenario::setExerciseStartDateAndTime	(	int	year,
		int	month,
		int	day,
		int	hour,
		int	minute,
		int	second
	)

virtual

Set/get exercise start time.

virtual void DtScenario::setExerciseStartDateAndTime ( DtTime time )

virtual

Assumed time is UTC from 1/1/1970 00:00:00.

virtual void DtScenario::setExerciseStartTime ( DtTime time )

virtual

Set exercise time. Will take todays date as the start date.

virtual DtTime DtScenario::exerciseStartTime ( ) const

virtual

Returns exercise start date and time.

virtual void DtScenario::setSetScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation	(	bool	,
		int	i = `10 *3600`
	)

virtual

If true, will set the exercise start time to 10AM at current system date upon the location of the first object created. The default is false (keep current scenario exercise start time). This will not include the loading of the scenario. When the scenario is saved, and there has been an entity created, the scenario start time will not be changed from that point on. This will save an item in the scenarios extended data "Set_Scenario_Start_Time_At_Local_On_First_Object_Creation".

virtual int DtScenario::setScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation ( ) const

virtual

virtual bool DtScenario::shouldSetScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation ( ) const

virtual

virtual void DtScenario::setCreateGlobalEnvironment ( bool b )

virtual

If true, a global environment object should be created by one of the back-ends.

virtual bool DtScenario::createGlobalEnvironment ( ) const

virtual

If true, a global environment object should be created by one of the back-ends.

virtual void DtScenario::setCreateGlobalDynamicTerrain ( bool b )

virtual

If true, a global dynamic terrain object should be created by one of the back-ends to process events that produce dynamic changes to the terrain.

virtual bool DtScenario::createGlobalDynamicTerrain ( ) const

virtual

If true, a global dynamic terrain object should be created by one of the back-ends to process events that produce dynamic changes to the terrain.

virtual DtRwNLengthStringVector& DtScenario::additionalOpdFilenames ( )

virtual

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

virtual const DtRwNLengthStringVector& DtScenario::additionalOpdFilenames ( ) const

virtual

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

virtual void DtScenario::addAdditionalOpdFilename ( const DtString & )

virtual

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

virtual void DtScenario::removeAdditonalOpdFilename ( int iIndex )

virtual

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

virtual void DtScenario::setAdditionalOpdFilenames ( const DtRwNLengthStringVector & )

virtual

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

virtual void DtScenario::setScenarioDescription ( const DtString & )

virtual

Gets/sets the scenario description in the scenarioData() member under the key "ScenarioDescription".

virtual DtString DtScenario::scenarioDescription ( ) const

virtual

virtual DtRwNLengthStringVector& DtScenario::simulationModelSetFilenames ( )

virtual