 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
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 | 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 | 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. | |
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) |
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 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 | 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. | |
Static Protected Attributes | |
| static DtString | thePhysicalWorldFilenameExtension |
| static DtString | theOrderOfBattleExtension |
| 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 |
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
| 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::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] |
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] |
Simulation model set files that want to be loaded for this scenario.
Note that the first file will be considered the "master" file. All others will merge into the "master" (subsequent model set files that contain .opd files will be considered "additional .opds")
| virtual const DtRwNLengthStringVector& DtScenario::simulationModelSetFilenames | ( | ) | const [virtual] |
Simulation model set files that want to be loaded for this scenario.
Note that the first file will be considered the "master" file. All others will merge into the "master" (subsequent model set files that contain .opd files will be considered "additional .opds")
| virtual void DtScenario::addSimulationModelSetFilename | ( | const DtString & | ) | [virtual] |
Simulation model set files that want to be loaded for this scenario.
Note that the first file will be considered the "master" file. All others will merge into the "master" (subsequent model set files that contain .opd files will be considered "additional .opds")
| virtual void DtScenario::removeSimulationModelSetFilename | ( | int | iIndex | ) | [virtual] |
Simulation model set files that want to be loaded for this scenario.
Note that the first file will be considered the "master" file. All others will merge into the "master" (subsequent model set files that contain .opd files will be considered "additional .opds")
| virtual void DtScenario::setSimulationModelSetFilenames | ( | const DtRwNLengthStringVector & | ) | [virtual] |
Simulation model set files that want to be loaded for this scenario.
Note that the first file will be considered the "master" file. All others will merge into the "master" (subsequent model set files that contain .opd files will be considered "additional .opds")
| virtual DtRwKeyValueList& DtScenario::scenarioData | ( | ) | [virtual] |
| virtual const DtRwKeyValueList& DtScenario::scenarioData | ( | ) | const [virtual] |
| virtual DtString DtScenario::scenarioName | ( | ) | const [virtual] |
A text name of the scenario.
This is descriptive name, and does not directly relate to any files that are stored for the scenario.
| virtual void DtScenario::setScenarioName | ( | const DtString & | name | ) | [virtual] |
A text name of the scenario.
This is descriptive name, and does not directly relate to any files that are stored for the scenario.
| virtual bool DtScenario::scenarioNameSpecified | ( | ) | const [virtual] |
A text name of the scenario.
This is descriptive name, and does not directly relate to any files that are stored for the scenario.
| static DtFilename DtScenario::validTerrainFile | ( | const DtFilename & | ) | [static] |
Given a terrain filename, check to see if it exists.
If it does not exist and the extension is .map. modify the .map to be .mtd and see if that exists. If that does not exist, return original filename (the same holds true if the extension is not .map). This will help with old (pre 3.10) scenarios that reference supplied VRF .map files that have been converted to .mtd files
| virtual bool DtScenario::isParameterDatabaseRwStringSpecified | ( | ) | [virtual] |
Functions to determine if value is specifed for these member variables.
| virtual bool DtScenario::isPhysicalWorldRwStringSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isOrderOfBattleRwStringSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isOverlayRwStringSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isSelectionGroupsRwStringSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isSymbolMapRwStringSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isCreateMenuRwStringSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isPlanRwStringSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isObjectMapRwStringSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isTimeMultiplierSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isAutoReorganizeRwStringSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isRandomNumberSeedSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isFrameRateModeSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isFrameDeltaTimeSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isSimTimeSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isExerciseStartTimeSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isForceHostilityRWStringSpecified | ( | ) | [virtual] |
| virtual bool DtScenario::isScenarioExtrasRWStringSpecified | ( | ) | [virtual] |
| virtual void DtScenario::setFilename | ( | const DtFilename & | ) | [virtual] |
| virtual const DtFilename& DtScenario::filename | ( | ) | const [virtual] |
| virtual bool DtScenario::writeScenarioFile | ( | const DtFilename & | filename | ) | [virtual] |
Writes itself to file.
| virtual void DtScenario::putSelf | ( | FILE * | fp, |
| int | indentLevel = 0, |
||
| bool | writeUnspecified = false, |
||
| const DtFilename & | path = DtReaderWriter::appPath() |
||
| ) | [virtual] |
Puts self to file.
Override to copy terrain filename to DtRwString form before writing to file.
Reimplemented from DtReaderWriter.
| virtual void DtScenario::getSelf | ( | DtlObjPtr | args, |
| const DtFilename & | searchPath, | ||
| const DtVariableBindingsList & | variableBindings | ||
| ) | [virtual] |
Gets self from file.
Override to copy terrain filename from DtRwString form after reading in from file.
| virtual bool DtScenario::isValid | ( | bool | allowEmptyFilenames = true, |
| DtString * | retMessage = 0 |
||
| ) | const [virtual] |
Returns true if all information necessary to load the scenario is present.
If allowEmptyFilenames is false, do not allow empty filenames for order of battle or plan
| virtual double DtScenario::version | ( | ) | const [virtual] |
The version of the scenario file.
| virtual bool DtScenario::relativeToScenarioFile | ( | ) | const [virtual] |
Returns true if the files are saved relative to the scenario file.
| virtual void DtScenario::setToCurrentVersion | ( | ) | [virtual] |
Sets version number to current version.
| static double DtScenario::currentScenarioVersion | ( | ) | [static] |
Returns current scenario version.
| static DtString DtScenario::getFrameModeNameFromFrameModeType | ( | DtFrameMode | ) | [static] |
| static DtFrameMode DtScenario::getFrameModeTypeFromFrameModeName | ( | const DtString & | frameModeName | ) | [static] |
| virtual DtFilename DtScenario::absoluteFilename | ( | const DtFilename & | ) | const [protected, virtual] |
If the relativeToScenarioFile flag is true, prepend the current scenario path to the file, else leave alone.
This method is only applied to: the plan file the global plan file the object map file the order of battle file the overlay file the selection group file the force hostility file the scenario data file
DtRwInt DtScenario::myComponentAttachmentRule [protected] |
DtFilename DtScenario::myComponentAttachmentTableFilename [protected] |
DtFilename DtScenario::myFilename [protected] |
DtFilename DtScenario::myTerrainDatabaseFilename [protected] |
DtRwString DtScenario::myTerrainDatabaseRwString [protected] |
DtFilename DtScenario::myPhysicalWorldFilename [protected] |
DtRwString DtScenario::myPhysicalWorldRwString [protected] |
DtFilename DtScenario::myGuiTerrainDatabaseFilename [protected] |
DtRwString DtScenario::myGuiTerrainDatabaseRwString [protected] |
DtFilename DtScenario::myOrderOfBattleFilename [protected] |
DtRwString DtScenario::myOrderOfBattleRwString [protected] |
DtFilename DtScenario::myPlanFilename [protected] |
DtRwString DtScenario::myPlanRwString [protected] |
DtFilename DtScenario::myGlobalPlanFilename [protected] |
DtRwString DtScenario::myGlobalPlanRwString [protected] |
DtFilename DtScenario::myParameterDatabaseFilename [protected] |
DtRwString DtScenario::myParameterDatabaseRwString [protected] |
DtFilename DtScenario::myOverlayFilename [protected] |
DtRwString DtScenario::myOverlayRwString [protected] |
DtFilename DtScenario::mySelectionGroupsFilename [protected] |
DtRwString DtScenario::mySelectionGroupsRwString [protected] |
DtFilename DtScenario::mySymbolMapFilename [protected] |
DtRwString DtScenario::mySymbolMapRwString [protected] |
DtFilename DtScenario::myCreateMenuFilename [protected] |
DtRwString DtScenario::myCreateMenuRwString [protected] |
DtFilename DtScenario::myObjectMapFilename [protected] |
DtRwString DtScenario::myObjectMapRwString [protected] |
DtFilename DtScenario::myForceHostilityFilename [protected] |
DtRwString DtScenario::myForceHostilityRwString [protected] |
DtFilename DtScenario::myScenarioExtrasFilename [protected] |
DtRwString DtScenario::myScenarioExtrasRWString [protected] |
DtRwReal DtScenario::myTimeMultiplier [protected] |
bool DtScenario::myAutoReorganize [protected] |
DtRwBoolean DtScenario::myAutoReorganizeRW [protected] |
DtRwUnsigned DtScenario::myRandomNumberSeed [protected] |
DtRwString DtScenario::myFrameRateModeString [protected] |
DtFrameMode DtScenario::myFrameRateMode [protected] |
DtRwReal DtScenario::myFrameDeltaTime [protected] |
DtTime DtScenario::myRunDurationTime [protected] |
DtRwReal DtScenario::mySimTime [protected] |
DtRwReal DtScenario::myExerciseStartTime [protected] |
DtRwString DtScenario::myScenarioName [protected] |
DtRwKeyValueList DtScenario::myScenarioData [protected] |
DtRwReal DtScenario::myVersion [protected] |
The version of the scenario file.
DtString DtScenario::thePhysicalWorldFilenameExtension [static, protected] |
DtString DtScenario::theOrderOfBattleExtension [static, protected] |
DtString DtScenario::theOverlayExtension [static, protected] |
DtString DtScenario::theSelectionGroupsExtension [static, protected] |
DtString DtScenario::theSymbolMapExtension [static, protected] |
DtString DtScenario::theCreateMenuExtension [static, protected] |
DtString DtScenario::thePlanExtension [static, protected] |
DtString DtScenario::theGlobalPlanExtension [static, protected] |
DtString DtScenario::theObjectMapExtension [static, protected] |
DtString DtScenario::theParameterDatabaseExtension [static, protected] |
DtString DtScenario::theFileExtension [static, protected] |
DtString DtScenario::theForceHostilityExtension [static, protected] |
DtString DtScenario::theScenarioDataExtension [static, protected] |
double DtScenario::theScenarioVersion [static, protected] |