Inheritance diagram for DtScenario:

Public Member Functions
	DtScenario ()
	default constructor
	DtScenario (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0)
	real constructor
virtual	~DtScenario ()
	destructor
	DtScenario (const DtScenario &orig)
	copy constructor
DtScenario &	operator= (const DtScenario &orig)
	assignment operator
virtual bool	init ()
	Initialization. Must be called before any other functions are called.
virtual bool	readScenarioFile (const DtFilename &filename)
	Read itself from file.
virtual bool	save ()
	Saves the scenario to a file with the current filename, if it exists.
virtual bool	save (const DtFilename &filename, bool saveObjectMap=true)
	Saves the scenario to a file with the given filename.
virtual DtScenario *	clone () const
	Clone function.
virtual void	setComponentAttachmentRule (int rule)
	Set/get the component attachment rule.
virtual int	componentAttachmentRule () const
virtual void	setComponentAttachmentTableFilename (const DtFilename &filename)
	Set/get the remote component attachment filename.
virtual const DtFilename &	componentAttachmentTableFilename () const
virtual void	setTerrainDatabaseFilename (const DtFilename &filename)
	Set/get the terrain database filename.
virtual const DtFilename &	terrainDatabaseFilename () const
virtual void	setGuiTerrainDatabaseFilename (const DtFilename &filename)
	Set/get the GUI terrain database filename (if one exists).
virtual const DtFilename &	guiTerrainDatabaseFilename () const
virtual void	setOrderOfBattleFilename (const DtFilename &filename)
	Set/get the order of battle filename.
virtual DtFilename	orderOfBattleFilename () const
virtual void	setScenarioScriptsFilename (const DtFilename &filename)
	Set/get the scenario scripts filename.
virtual DtFilename	scenarioScriptsFilename () const
virtual void	setPlanFilename (const DtFilename &filename)
	Set/get the plan filename.
virtual DtFilename	planFilename () const
virtual void	setParameterDatabaseFilename (const DtFilename &filename)
	Set/get the parameter database filename.
virtual const DtFilename &	parameterDatabaseFilename () const
virtual void	setPhysicalWorldFilename (const DtFilename &filename)
	Set/get the physical world settings file.
virtual const DtFilename &	physicalWorldFilename () const
virtual void	setObjectMapFilename (const DtFilename &filename)
	Set/get the object map filename.
virtual DtFilename	objectMapFilename () const
virtual void	setOverlayFilename (const DtFilename &filename)
	Set/get the overlay filename.
virtual DtFilename	overlayFilename () const
virtual void	setSelectionGroupsFilename (const DtFilename &filename)
	Set/get the selection groups filename.
virtual DtFilename	selectionGroupsFilename () const
virtual void	setSymbolMapFilename (const DtFilename &filename)
	Set/get the symbol map file to use to display symbols on the front end.
virtual const DtFilename &	symbolMapFilename () const
virtual void	setCreateMenuFilename (const DtFilename &filename)
	Set/get the create menu to use with this scenario.
virtual const DtFilename &	createMenuFilename () const
virtual void	setForceHostilityFilename (const DtFilename &filename)
	Set/get the Forces and hostility matrix to use with this scenario.
virtual DtFilename	forceHostilityFilename () const
virtual void	setTimeMultiplier (DtReal multiplier)
	Set/get the time multiplier.
virtual DtReal	timeMultiplier () const
virtual void	setAutoReorganize (const bool &flag)
	Set/get the auto reorganize flag.
virtual const bool &	autoReorganize () const
virtual void	setRandomNumberSeed (unsigned numberSeed)
	Set/get the random number seed.
virtual unsigned	randomNumberSeed () const
virtual DtString	frameRateModeString () const
	Get/Set frame rate mode.
virtual DtFrameMode	frameRateMode () const
virtual void	setFrameRateModeString (DtString value)
virtual void	setFrameRateMode (DtFrameMode value)
virtual DtReal	frameDeltaTime () const
	Get/Set frame delta time.
virtual void	setFrameDeltaTime (DtReal value)
virtual DtTime	runDurationTime () const
	Set/get the run duration time.
virtual void	setRunDurationTime (DtTime time)
virtual void	setSimTime (DtTime time)
	Set/get simulation time.
virtual DtTime	simTime () const
virtual void	setExerciseStartTime (DtTime time)
	Set/get exercise start time.
virtual DtTime	exerciseStartTime () const
virtual void	setScenarioDescription (const DtString &)
	Gets/sets the scenario description in the scenarioData() member under the key "ScenarioDescription".
virtual DtString	scenarioDescription () const
virtual DtRwKeyValueList &	scenarioData ()
virtual const DtRwKeyValueList &	scenarioData () const
virtual bool	isParameterDatabaseRwStringSpecified ()
	Functions to determine if value is specifed for these member variables.
virtual bool	isPhysicalWorldRwStringSpecified ()
virtual bool	isOrderOfBattleRwStringSpecified ()
virtual bool	isScenarioScriptsRwStringSpecified ()
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	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)
	Writes itself to file.
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Puts self to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Gets self from file.
virtual bool	isValid (bool allowEmptyFilenames=true, DtString *retMessage=0) const
	Returns true if all information necessary to load the scenario is present.
virtual double	version () const
	The version of the scenario file.
virtual bool	relativeToScenarioFile () const
	Returns true if the files are saved relative to the scenario file.
virtual void	setToCurrentVersion ()
	Sets version number to current version.

virtual void	setGlobalPlanFilename (const DtFilename &filename)
	Set/get the global plan filename.
virtual DtFilename	globalPlanFilename () const
	Set/get the global plan filename.

virtual void	setScenarioExtrasFilename (const DtFilename &f)
	Set/get the scenario data, including the force/hostility matrix, the spawn templates, ...
virtual DtFilename	scenarioExtrasFilename () const
	Set/get the scenario data, including the force/hostility matrix, the spawn templates, ...

virtual DtRwNLengthStringVector &	additionalOpdFilenames ()
	Additional OPD files that will be appended (in the order specified) to the main OPD file for this scenario.
virtual const DtRwNLengthStringVector &	additionalOpdFilenames () const
	Additional OPD files that will be appended (in the order specified) to the main OPD file for this scenario.
virtual void	addAdditionalOpdFilename (const DtString &)
	Additional OPD files that will be appended (in the order specified) to the main OPD file for this scenario.
virtual void	removeAdditonalOpdFilename (int iIndex)
	Additional OPD files that will be appended (in the order specified) to the main OPD file for this scenario.
virtual void	setAdditionalOpdFilenames (const DtRwNLengthStringVector &)
	Additional OPD files that will be appended (in the order specified) to the main OPD file for this scenario.

virtual DtRwNLengthStringVector &	simulationModelSetFilenames ()
	Simulation model set files that want to be loaded for this scenario.
virtual const DtRwNLengthStringVector &	simulationModelSetFilenames () const
	Simulation model set files that want to be loaded for this scenario.
virtual void	addSimulationModelSetFilename (const DtString &)
	Simulation model set files that want to be loaded for this scenario.
virtual void	removeSimulationModelSetFilename (int iIndex)
	Simulation model set files that want to be loaded for this scenario.
virtual void	setSimulationModelSetFilenames (const DtRwNLengthStringVector &)
	Simulation model set files that want to be loaded for this scenario.

virtual DtString	scenarioName () const
	A text name of the scenario.
virtual void	setScenarioName (const DtString &name)
	A text name of the scenario.
virtual bool	scenarioNameSpecified () const
	A text name of the scenario.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	writeSelf (FILE *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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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 DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtFilename	validTerrainFile (const DtFilename &)
	Given a terrain filename, check to see if it exists.
static double	currentScenarioVersion ()
	Returns current scenario version.
static DtString	getFrameModeNameFromFrameModeType (DtFrameMode)
static DtFrameMode	getFrameModeTypeFromFrameModeName (const DtString &frameModeName)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()

Protected Member Functions
virtual DtFilename	absoluteFilename (const DtFilename &) const
	If the relativeToScenarioFile flag is true, prepend the current scenario path to the file, else leave alone.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtRwInt	myComponentAttachmentRule
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	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
DtRwUnsigned	myRandomNumberSeed
DtRwString	myFrameRateModeString
DtFrameMode	myFrameRateMode
DtRwReal	myFrameDeltaTime
DtTime	myRunDurationTime
DtRwReal	mySimTime
DtRwReal	myExerciseStartTime
DtRwNLengthStringVector	myAdditionalOpdFilenames
DtRwNLengthStringVector	mySimulationModelSetFilenames
DtRwString	myScenarioName
DtRwKeyValueList	myScenarioData
DtRwReal	myVersion
	The version of the scenario file.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

Static Protected Attributes
static DtString	thePhysicalWorldFilenameExtension
static DtString	theOrderOfBattleExtension
static DtString	theScenarioScriptsExtension
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 DtReaderWriterFactory	theFactory

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::pair < DtSymbolString, DtString >	DtVariableNameType

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.

virtual bool DtScenario::save ( )

virtual

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

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::setComponentAttachmentRule ( int rule )

virtual

Set/get the component attachment rule.

0 == No attachment 1 == First back end 2 == All back ends

virtual int DtScenario::componentAttachmentRule ( ) const

virtual

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::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::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 ( unsigned numberSeed )

virtual

Set/get the random number seed.

virtual unsigned 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::setExerciseStartTime ( DtTime time )

virtual

Set/get exercise start time.

virtual DtTime DtScenario::exerciseStartTime ( ) const

virtual

virtual DtRwNLengthStringVector& DtScenario::additionalOpdFilenames ( )

virtual