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.
|
| bool | saveAsZipFile () const |
| | Whether or not, when saving, to treat file as a zip file.
|
| virtual void | setSaveAsZipFile (bool) |
| virtual bool | save () |
| | Saves the scenario to a file with the current filename, if it exists.
|
| virtual DtString | toXml (const DtFilename &scenarioFilename) |
| | Save and return file contents to .xml string.
|
| virtual void | setupScenarioFilenames (const DtFilename &scenarioFilename, bool saveObjectMap=true) |
| | Simply sets up what the filenames to save would be without saving the scenario file.
|
| 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 | setOrbatFilename (const DtFilename &filename) |
| | Set/get the orbat filename.
|
| virtual DtFilename | orbatFilename () 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 | setUseDayNightIlluminationModel (bool) |
| | Whether or not to use the day/night illumination model on new scenario.
|
| virtual bool | useDayNightIlluminationModel () 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 (long int numberSeed) |
| | Set/get the random number seed.
|
| virtual long int | 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 | setExerciseStartDateAndTime (int year, int month, int day, int hour, int minute, int second) |
| | Set/get exercise start time.
|
| virtual void | setExerciseStartDateAndTime (DtTime time) |
| | Assumed time is UTC from 1/1/1970 00:00:00.
|
| virtual void | setExerciseStartTime (DtTime time) |
| | Set exercise time. Will take todays date as the start date.
|
| virtual DtTime | exerciseStartTime () const |
| | Returns exercise start date and time.
|
| virtual void | setSetScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation (bool, int i=10 *3600) |
| | If true, will set the exercise start time to 10AM at current system date upon the location of the first object created.
|
| virtual int | setScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation () const |
| virtual bool | shouldSetScenarioStartTimeAtSpecifiedLocalTimeOnFirstObjectCreation () const |
| virtual void | setScenarioDescription (const DtString &) |
| | Gets/sets the scenario description in the scenarioData() member under the key "ScenarioDescription".
|
| virtual DtString | scenarioDescription () 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 | 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) |
| | Writes itself to file.
|
| virtual void | putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath()) |
| | Puts self to file.
|
| virtual void | putSelf (DtEnvironmentSP env, DtEnvValueSP parent) const |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| | Gets self from file.
|
| virtual void | getSelf (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| virtual void | finalizeGetSelf () |
| | Finalize after getSelf calls.
|
| 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 bool | mapUUIDToScenarioDataFromOobInScenario (const DtFilename &scenarioFile, ScenarioDataMap &scenarioDataMap, bool mapUUIDOnly=true) |
| | Given the scenario filename, if it exists and there is an order of battle file, parse the order of battle file and fill in the map with UUID to marking text.
|
| virtual bool | mapUUIDToScenarioDataFromOobInScenario (DtlInputStream *, ScenarioDataMap &scenarioDataMap, bool mapUUIDOnly=true) |
| virtual bool | mapUUIDToScenarioDataFromOobInScenario (ScenarioDataMap &scenarioDataMap, bool mapUUIDOnly=true) |
| | Uses order of battle from the current scenario.
|
| virtual void | updateSimulationModelSetFilenames () |
| | This will iterate over the simulation model set filenames and replace the harcoded data directory path (../data) if it exists with for future data path resolution.
|
| virtual void | resolveSimulationModelSetPaths () |
| | Resovlve simulation model set paths.
|
| virtual void | resolveDataPaths () |
| | Resolves all data paths.
|
|
| virtual void | setGlobalPlanFilename (const DtFilename &filename) |
| | Set/get the global plan filename.
|
| virtual DtFilename | globalPlanFilename () const |
|
| virtual void | setScenarioExtrasFilename (const DtFilename &f) |
| | Set/get the scenario data, including the force/hostility matrix, the spawn templates, ...
|
| virtual DtFilename | scenarioExtrasFilename () const |
|
| virtual void | setCreateGlobalEnvironment (bool b) |
| | If true, a global environment object should be created by one of the back-ends.
|
| virtual bool | createGlobalEnvironment () const |
|
| virtual void | setCreateGlobalDynamicTerrain (bool b) |
| | 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 | createGlobalDynamicTerrain () const |
|
| 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 |
| virtual void | addAdditionalOpdFilename (const DtString &) |
| virtual void | removeAdditonalOpdFilename (int iIndex) |
| virtual void | setAdditionalOpdFilenames (const DtRwNLengthStringVector &) |
|
| virtual DtRwNLengthStringVector & | simulationModelSetFilenames () |
| | Simulation model set files that want to be loaded for this scenario.
|
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 () |
| | Access the scenario data key value list.
|
| virtual const DtRwKeyValueList & | scenarioData () const |
|
| virtual DtString | scenarioName () const |
| | A text name of the scenario.
|
| virtual void | setScenarioName (const DtString &name) |
| virtual bool | scenarioNameSpecified () const |
| | 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 | 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 | 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 | 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 | 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.
|
Static Public Member Functions |
| static bool | saveBufferToScenarioZipFile (const DtFilename &scenanarioZipFile, const DtFilename &zipContentsFile, const DtString &buffer) |
| | 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 | 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) |
| | 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 | fileExistsInZipFile (const DtFilename &scenanarioZipFile, const DtFilename &zipContentsFile, bool onlyNeedsExtensionMatch=true) |
| | Returns true if the specified file exists in the scenario zip file.
|
| static bool | extractScenarioFileFromZipFile (const DtFilename &scenarioZipFile, const DtFilename &zipContentsFile, bool onlyNeedsExtensionMatch=true) |
| | Extract the given file and saves it with the supplied filename.
|
| static bool | readScenarioFromZipFile (const DtFilename &f, DtScenario &scenario) |
| | If the given file is a zip file, fill the scenario given with the scenario information found within.
|
| static bool | saveFileToScenarioZipFile (const DtFilename &scenanarioZipFile, const DtFilename &zipContentsFile) |
| | Saves the contents of the file to the zip file. If zip file does not exist will create.
|
| static bool | isScenarioZipFile (const DtFilename &) |
| | Returns true if the given file is a scenario zip file.
|
| static DtFilename | validTerrainFile (const DtFilename &) |
| | Given a terrain filename, check to see if it exists.
|
| static double | currentScenarioVersion () |
| | Returns current scenario version.
|
| static DtFilename | reworkDataDirectory (const DtFilename &) |
| | Reworks the SMS file to replace ../data/ with the actual data directory.
|
| static DtFilename | replaceDirectoryWithAppropriateVariable (const DtFilename &) |
| | Replaces the data directory with
|
| static DtString | getFrameModeNameFromFrameModeType (DtFrameMode) |
| static DtFrameMode | getFrameModeTypeFromFrameModeName (const DtString &frameModeName) |
| 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.
|
Public Types inherited from DtReaderWriter