![]() |
VR-Forces Developer's Guide
|
DtEnvironmentStatusManager manages all of the environment-related data (including date and time) that has been received and translated from the METOC FOM (or its DIS equivalent). Many methods specify a weather area id, which is a DtUniqueID generated by the DtEnvironmentProcessor. However, there are some that do not, since they only support global conditions (so no weather area id is needed. Several environmental conditions may be specified as beloing to layers within a weather area; the methods will also take a layer id (which is also a DtUniqueID generated by the DtEnvironmentProcessor. The DtEnvironmentStatusManager creates a container object for global conditions (using a DtGlobalLayeredEnvironmentDataCreator and an agent for transmitting that global data to the render thread (a DtSceneEnvironmentalsControllerObjectAgent) which is provided for use by the global container (but ownership is maintained by DtEnvironmentStatusManager). In an analogous fashion, a local environment data container is created for each local weather area discovered (using DtLocalLayeredEnvironmentDataCreator) and a transmittal agent (DtLocalEnvironmentalsControllerObjectAgent). Accessor and Mutator methods are provided for all environment data supported by VR-Vantage.

Classes | |
| class | DtSubsurfaceRecord |
Public Member Functions | |
| DtEnvironmentStatusManager (DtBaseConnection &conn) | |
| DtEnvironmentStatusManager ()=delete | |
| virtual | ~DtEnvironmentStatusManager () |
| DtEnvironmentStatusManager (const DtEnvironmentStatusManager &)=delete | |
| DtEnvironmentStatusManager & | operator= (const DtEnvironmentStatusManager &)=delete |
| virtual void | addWeatherArea (DtUniqueID areaId) |
| virtual void | removeWeatherArea (DtUniqueID areaId) |
| virtual void | addElevationalConfiguration (DtUniqueID areaId, DtUniqueID layerId) |
| virtual void | removeElevationalConfiguration (DtUniqueID areaId, DtUniqueID uniqueId) |
| virtual void | setLocalZoneOrigin (DtUniqueID areaId, const DtVector &origin) |
| virtual void | setLocalZoneShape (DtUniqueID areaId, float width, float length, float height, float cornerRadius) |
| virtual DtLocalLayeredEnvironmentData * | findLocalWeatherArea (DtUniqueID areaId) |
| virtual const DtLocalLayeredEnvironmentData * | findLocalWeatherArea (DtUniqueID areaId) const |
| virtual DtGlobalLayeredEnvironmentData * | globalWeatherArea () |
| virtual const DtGlobalLayeredEnvironmentData * | globalWeatherArea () const |
| virtual void | setAirTemperatureAltitude (DtUniqueID areaId, float altitude) |
| virtual float | airTemperatureAltitude (DtUniqueID areaId) const |
| virtual void | setBaseMSLAltitude (DtUniqueID areaId, DtUniqueID layerId, float mslAltitudeInMeters) |
| virtual float | baseMSLAltitude (DtUniqueID areaId, DtUniqueID layerId) const |
| virtual void | setWindSpeed (DtUniqueID areaId, DtUniqueID layerId, float speedInMetersPerSecond) |
| virtual float | windSpeed (DtUniqueID areaId, DtUniqueID layerId) const |
| virtual void | setWindDirection (DtUniqueID areaId, DtUniqueID layerId, float offsetInRadiansFromTrueNorth) |
| virtual float | windDirection (DtUniqueID areaId, DtUniqueID layerId) const |
| virtual void | setVisibilityDistance (DtUniqueID areaId, DtUniqueID layerId, float visibilityInMeters) |
| virtual float | visibilityDistance (DtUniqueID areaId, DtUniqueID layerId) const |
| virtual void | setObscurant (DtUniqueID areaId, DtUniqueID layerId, makArchives::VisibilityObscurant obscurantEnumerationValue) |
| virtual makArchives::VisibilityObscurant | obscurant (DtUniqueID areaId, DtUniqueID layerId) const |
| virtual void | setCloudType (DtUniqueID areaId, DtUniqueID layerId, const std::string &cloudTypeEnumerationValue) |
| virtual std::string | cloudType (DtUniqueID areaId, DtUniqueID layerId) const |
| virtual void | setCloudDensity (DtUniqueID areaId, DtUniqueID layerId, float cloudDensity) |
| virtual float | cloudDensity (DtUniqueID areaId, DtUniqueID layerId) const |
| virtual void | setSkyCoverage (DtUniqueID areaId, DtUniqueID layerId, float skyCoverage) |
| virtual float | skyCoverage (DtUniqueID areaId, DtUniqueID layerId) const |
| virtual void | setPrecipitationType (DtUniqueID areaId, DtEnvironment::PrecipitationType type) |
| virtual DtEnvironment::PrecipitationType | precipitationType (DtUniqueID areaId) const |
| virtual void | setPrecipitationIntensity (DtUniqueID areaId, float intensity) |
| virtual float | precipitationIntensity (DtUniqueID areaId) const |
| virtual void | setAirTemperature (DtUniqueID areaId, float temperature) |
| virtual float | airTemperature (DtUniqueID areaId) const |
| virtual void | setAirPressure (DtUniqueID areaId, float pressure) |
| virtual float | airPressure (DtUniqueID areaId) |
| virtual void | setSeaLevelWaterConcentration (DtUniqueID areaId, float ppmv) |
| virtual float | seaLevelWaterConcentration (DtUniqueID areaId) const |
| virtual void | setLightningPresent (DtUniqueID areaId, bool present) |
| virtual bool | lightningPresent (DtUniqueID areaId) const |
| virtual void | setSnowMinimumElevation (DtUniqueID areaId, float elevation) |
| virtual float | snowMinimumElevation (DtUniqueID areaId) const |
| virtual void | setRoadSnowAccumulation (DtUniqueID areaId, float accumulation) |
| virtual float | roadSnowAccumulation (DtUniqueID areaId) const |
| virtual void | setGroundRainAccumulation (DtUniqueID areaId, float accumulation) |
| virtual float | groundRainAccumulation (DtUniqueID areaId) const |
| virtual void | setGroundSnowAccumulation (DtUniqueID areaId, float accumulation) |
| virtual float | groundSnowAccumulation (DtUniqueID areaId) const |
| virtual void | setFogColor (DtUniqueID areaId, float red, float green, float blue) |
| virtual void | getFogColor (DtUniqueID areaId, float &red, float &green, float &blue) const |
| virtual void | setFogHeight (DtUniqueID areaId, float height) |
| virtual float | fogHeight (DtUniqueID areaId) const |
| virtual void | setAirPressureAltitude (DtUniqueID areaId, float altitude) |
| virtual float | airPressureAltitude (DtUniqueID areaId) const |
| virtual void | setSwellState (DtDouglasSwellState::Scale state) |
| virtual DtDouglasSwellState::Scale | swellState () const |
| virtual void | setSwellStateDirection (float value) |
| virtual float | swellStateDirection () const |
| virtual void | setSeaState (DtDouglasSeaState::Scale state) |
| virtual DtDouglasSeaState::Scale | seaState () const |
| virtual void | setSeaStateDirection (float value) |
| virtual float | seaStateDirection () const |
| virtual void | setWindDrivenSeaStateEnabled (bool value, bool force=false) |
| virtual bool | windDrivenSeaStateEnabled () const |
| virtual void | setWindFetch (float value) |
| virtual float | windFetch () const |
| virtual void | setSeaChoppiness (float value) |
| virtual float | seaChoppiness () const |
| virtual void | setUnderwaterVisibility (float depth, float distance) |
| virtual float | underwaterVisibility () const |
| virtual void | setSurfaceTransparency (float value) |
| virtual float | surfaceTransparency () const |
| virtual void | setSurgeDepth (float value) |
| virtual float | surgeDepth () const |
| virtual void | setAmbientWaterTemperature (float temperature) |
| virtual float | ambientWaterTemperature () const |
| virtual void | setWaterCurrentSpeed (float speed) |
| virtual float | waterCurrentSpeed () const |
| virtual void | setWaterCurrentDirection (float direction) |
| virtual float | waterCurrentDirection () const |
| virtual void | setTidalOffset (float meters) |
| virtual float | tidalOffset () const |
| virtual void | setDateAndTimeOfDay (int year, int month, int day, int hour, int minutes, double seconds) |
| virtual void | getDateAndTimeOfDay (int &year, int &month, int &day, int &hour, int &minutes, double &seconds) |
| virtual void | setUseGlobalTimeZone (bool, bool force=false) |
| virtual bool | useGlobalTimeZone () const |
| virtual void | setTimeOfDayAdvancementSpeed (float speed) |
| virtual float | timeOfDayAdvancementSpeed () const |
| virtual void | setThermoclinePermeability (float depth, float permeability) |
| virtual float | thermoclinePermeability (float depth) const |
Public Member Functions inherited from makVrv::DtVirtualBaseClass | |
| DtVirtualBaseClass () | |
| virtual | ~DtVirtualBaseClass () |
Static Public Member Functions | |
| static DtEnvironmentStatusManager & | instance (DtBaseConnection &conn) |
Static Public Attributes | |
| static const DtUniqueID | GlobalWeatherAreaId = (DtUniqueID)-1 |
Protected Member Functions | |
| virtual DtLayeredEnvironmentDataBase * | findWeatherAreaBase (DtUniqueID areaId) |
| virtual const DtLayeredEnvironmentDataBase * | findWeatherAreaBase (DtUniqueID areaId) const |
Protected Attributes | |
| DtBaseConnection & | myConnection |
| std::unordered_map< DtUniqueID, DtLocalLayeredEnvironmentData * > | myLocalWeatherAreasMap |
| std::unordered_map< DtUniqueID, DtLocalEnvironmentalsControllerObjectAgent * > | myLocalWeatherAgentsMap |
| DtSceneEnvironmentalsControllerObjectAgent * | myGlobalWeatherAgent |
| DtGlobalLayeredEnvironmentData * | myGlobalWeatherArea |
| std::map< float, DtSubsurfaceRecord > | myGlobalThermoclineMap |
| makVrv::DtEnvironmentStatusManager::DtEnvironmentStatusManager | ( | DtBaseConnection & | conn | ) |
CTOR.
|
delete |
Default CTOR - not allowed.
|
virtual |
Virtual DTOR.
|
delete |
Copy constructor - not allowed.
|
delete |
Assignment operator - not allowed.
|
virtual |
Add a new weather area. If the areaId is DtEnvironmentStatusManager::GlobalWeatherAreaId the call is ignored; the Global weather area always exists.
|
virtual |
Remove a weather area. If the areaId is DtEnvironmentStatusManager::GlobalWeatherAreaId the call is ignored; the Global weather area always exists.
|
virtual |
Add a weather config layer to a weather area.
|
virtual |
Remove a weather config layer from a weather area.
|
virtual |
Set the origin of a local weather area. If the areaId is DtEnvironmentStatusManager::GlobalWeatherAreaId the call is ignored.
|
virtual |
Set the dimensions of a local weather area. If the areaId is DtEnvironmentStatusManager::GlobalWeatherAreaId the call is ignored.
|
virtual |
Find a local weather area by it's area id. If not found, the method returns nullptr.
|
virtual |
Find a local weather area (const) by it's area id. If not found, the method returns nullptr.
|
virtual |
Get a pointer to the global weather area.
|
virtual |
Get a const pointer to the global weather area.
|
virtual |
Set / get the base MSL Altitude, in meters, for this elevational configuration.
|
virtual |
Set / get the base MSL Altitude, in meters, for this elevational configuration.
|
virtual |
Set / get the speed, in meters per second, for this elevational configuration.
|
virtual |
Set / get the speed, in meters per second, for this elevational configuration.
|
virtual |
Set / get the angular offset (clockwise) from True North, in radians, for this elevational configuration.
|
virtual |
Set / get the angular offset (clockwise) from True North, in radians, for this elevational configuration.
|
virtual |
Set / get the visibility distance, in meters, for this elevational configuration.
|
virtual |
Set / get the visibility distance, in meters, for this elevational configuration.
|
virtual |
Set / get the visibility obscurant for this elevational configuration.
|
virtual |
Set / get the visibility obscurant for this elevational configuration.
|
virtual |
Set / get the cloud type, by name, for this elevational configuration.
|
virtual |
Set / get the cloud type, by name, for this elevational configuration.
|
virtual |
Set / get the cloud density, in kg/m^3, for this elevational configuration As of VRV2.8, this property is not used. It is only used by VR-Forces.
|
virtual |
Set / get the cloud density, in kg/m^3, for this elevational configuration As of VRV2.8, this property is not used. It is only used by VR-Forces.
|
virtual |
Set / get the sky coverage, in normalized Oktas [0-1] (which is what SilverLining expects), for this elevational configuration.
|
virtual |
Set / get the sky coverage, in normalized Oktas [0-1] (which is what SilverLining expects), for this elevational configuration.
|
virtual |
Set / get the precipitation type.
|
virtual |
Set / get the precipitation type.
|
virtual |
Set / get the precipitation intensity. intensity is a normalized value (0.0 to 1.0)
|
virtual |
Set / get the precipitation intensity. intensity is a normalized value (0.0 to 1.0)
|
virtual |
Set / get the air temperature. Converts to VRV Native units. METOC network value is C, native VRV app units are kelvin.
|
virtual |
Set / get the air temperature. Converts to VRV Native units. METOC network value is C, native VRV app units are kelvin.
|
virtual |
Set / get the air pressure Converts to VRV Native units. METOC network value is millibars, native VRV app units are pascals.
|
virtual |
Set / get the air pressure Converts to VRV Native units. METOC network value is millibars, native VRV app units are pascals.
|
virtual |
Set / get the water concentration of the atmosphere in PPMV (parts per million by volume) at sea level.
|
virtual |
Set / get the water concentration of the atmosphere in PPMV (parts per million by volume) at sea level.
|
virtual |
Set / get whether lightning is present.
|
virtual |
Set / get whether lightning is present.
|
virtual |
Set / get the minimum elevation (meters) at which snow is on the ground.
|
virtual |
Set / get the minimum elevation (meters) at which snow is on the ground.
|
virtual |
Set / get the amount of snow accumulation on roads.
|
virtual |
Set / get the amount of snow accumulation on roads.
|
virtual |
Set / get the amount of rain accumulation on the ground.
|
virtual |
Set / get the amount of rain accumulation on the ground.
|
virtual |
Set / get the amount of snow accumulation on the ground.
|
virtual |
Set / get the amount of snow accumulation on the ground.
|
virtual |
Set / get the current fog color.
|
virtual |
Set / get the current fog color.
|
virtual |
Set / get the current fog height.
|
virtual |
Set / get the current fog height.
|
virtual |
Set / get the altitude for which air pressure has been specified.
|
virtual |
Set / get the altitude for which air pressure has been specified.
|
virtual |
Set / get the altitude for which temperature has been specified.
|
virtual |
|
virtual |
Set / get the sea swell conditions based on the Douglas sea scale.
|
virtual |
Set / get the sea swell conditions based on the Douglas sea scale.
|
virtual |
Set / get the direction, in radians from True North, of sea swells.
|
virtual |
Set / get the direction, in radians from True North, of sea swells.
|
virtual |
Set / get the sea state conditions based on the Douglas sea scale.
|
virtual |
Set / get the sea state conditions based on the Douglas sea scale.
|
virtual |
Set / get the sea state direction, in radians from True North.
|
virtual |
Set / get the sea state direction, in radians from True North.
|
virtual |
Set / get the wind driven seas enabled parameter to allow the wind to determine the sea state.
|
virtual |
Set / get the wind driven seas enabled parameter to allow the wind to determine the sea state.
|
virtual |
Set / get the ocean wind fetch.
|
virtual |
Set / get the ocean wind fetch.
|
virtual |
Set / get the sea choppiness.
|
virtual |
Set / get the sea choppiness.
|
virtual |
Set / get the maximum visibility under water in meters.
|
virtual |
Set / get the maximum visibility under water in meters.
|
virtual |
Set / get the surface transparency.
|
virtual |
Set / get the surface transparency.
|
virtual |
Set / get the surge depth.
|
virtual |
Set / get the surge depth.
|
virtual |
Set / get the ambient water temperature, in Kelvins. Converts to VRV Native units. METOC network value is C, native VRV app units are kelvin.
|
virtual |
Set / get the ambient water temperature, in Kelvins. Converts to VRV Native units. METOC network value is C, native VRV app units are kelvin.
|
virtual |
Set / get the speed of water currents in meters per second.
|
virtual |
Set / get the speed of water currents in meters per second.
|
virtual |
Set the direction of water currents in radians from north (clockwise).
|
virtual |
Set the direction of water currents in radians from north (clockwise).
|
virtual |
Set / get the current tidal offset from mean-sea-level in meters.
|
virtual |
Set / get the current tidal offset from mean-sea-level in meters.
|
virtual |
Set / get the date and time of day.
|
virtual |
Set / get the date and time of day.
|
virtual |
Set / get whether to use GMT time as the means to position the sun/moon rather than always moving with the observer.
|
virtual |
Set / get whether to use GMT time as the means to position the sun/moon rather than always moving with the observer.
|
virtual |
Set / get the time of day advancement speed.
|
virtual |
Set / get the time of day advancement speed.
|
virtual |
Set / get the thermocline permeability at the specified depth.
|
virtual |
Set / get the thermocline permeability at the specified depth.
|
static |
Find an instance of the DtEnvironmentStatusManager registered with a connection.
|
protectedvirtual |
Find the weather area (as a pointer to the base class). Returns nullptr if it doesn't exist.
|
protectedvirtual |
Find the weather area (as a const pointer to the base class). Returns nullptr if it doesn't exist.
|
static |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |