scenario.h File Reference

Go to the source code of this file.

Classes
class	DtScenario
class	DtLoadBalancingFcnInfo
class	DtScenarioLoadInformation
struct	DtSimulationObjectGroupSaveInformation

Typedefs
typedef bool(*	DtPreserveMappingsFcn )(void *usr)
typedef bool(*	DtLoadBalancingFcn )(DtAddressMap *map, const DtVrfFileParser *parser, const DtList *backends, bool &remapped, void *usr, const DtString &userOptions)
typedef bool(*	DtLoadBalancingCheckFcn )(const DtList *backends, void *usr, const DtString &userOptions, DtString &error)
typedef bool(*	DtRemappingFcn )(DtBackendMap *map, const std::set< DtSimulationAddress > &expectedBackends, void *usr)

Variables
const int	DtImportScenarioCreateUniqueNamesOnImport = 0x00000001
const int	DtImportScenarioImportScenarioEvents = 0x00000002
const int	DtImportScenarioCreateSelectionGroup = 0x00000004
const int	DtSimulationObjectGroupPreserveForceInformation = 0x00000008
const int	DtSimulationObjectGroupUseGroupNameToDisambiguate = 0x00000010
const int	DtSimulationObjectGroupAltitudesAreAboveTerrain = 0x00000020
const int	DtSimulationObjectGroupCreationMode = 0x00000040
const int	DtSimulationObjectGroupAllowAltitudePlacement = 0x00000080
const int	DtImportDuplicateScenarioObjects = 0x00000100
const int	DtDefaultScenarioImportFlags = DtImportScenarioCreateUniqueNamesOnImport | DtImportScenarioImportScenarioEvents
const int	DtImportScenarioDefaultFlags
const int	DtSimulationObjectGroupDefaultFlags

Typedef Documentation

typedef bool(* DtPreserveMappingsFcn)(void *usr)

class DtScenario:

Instances of DtScenario is the data declared in a .scn file It provides the capablility to read in a scenario file and access the data. Current scenario version is 3.2. For versions pre 3.2, the scenario exercise time will contain todays date/time as part of the exercise start time. For 3.2 and beyond this is assumed to be set as part of the exercise start time Used by saveScenario to determine if original (true) or new mappings should be saved.

typedef bool(* DtLoadBalancingFcn)(DtAddressMap *map, const DtVrfFileParser *parser, const DtList *backends, bool &remapped, void *usr, const DtString &userOptions)

Return true from this function to signal success of load balancing, however, set remapped to true if the backend mapping has changed. Setting to false will not warn the user to preserve mappings.

typedef bool(* DtLoadBalancingCheckFcn)(const DtList *backends, void *usr, const DtString &userOptions, DtString &error)

typedef bool(* DtRemappingFcn)(DtBackendMap *map, const std::set< DtSimulationAddress > &expectedBackends, void *usr)

Variable Documentation

const int DtImportScenarioCreateUniqueNamesOnImport = 0x00000001

const int DtImportScenarioImportScenarioEvents = 0x00000002

const int DtImportScenarioCreateSelectionGroup = 0x00000004

const int DtSimulationObjectGroupPreserveForceInformation = 0x00000008

const int DtSimulationObjectGroupUseGroupNameToDisambiguate = 0x00000010

const int DtSimulationObjectGroupAltitudesAreAboveTerrain = 0x00000020

const int DtSimulationObjectGroupCreationMode = 0x00000040

const int DtSimulationObjectGroupAllowAltitudePlacement = 0x00000080

const int DtImportDuplicateScenarioObjects = 0x00000100

const int DtDefaultScenarioImportFlags = DtImportScenarioCreateUniqueNamesOnImport | DtImportScenarioImportScenarioEvents

Default is not not import duplicate UUIDs. This will allow multiple scenarios that have the same base environmentals to be imported without duplicating those envvironmentals.

const int DtImportScenarioDefaultFlags

Initial value:

= DtImportScenarioCreateUniqueNamesOnImport | DtImportScenarioImportScenarioEvents |
   DtImportScenarioCreateSelectionGroup

If this is on will generate new UUIDs for scenario objects on import and keep all duplicate objects If this is off will not change UUIDs, and, if any UUIDs are currently in the scenario, those objects will be discarded.

const int DtSimulationObjectGroupDefaultFlags

Initial value:

= DtImportScenarioCreateUniqueNamesOnImport | DtImportScenarioImportScenarioEvents |
   DtImportScenarioCreateSelectionGroup | DtSimulationObjectGroupPreserveForceInformation | DtSimulationObjectGroupAltitudesAreAboveTerrain