VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
makVrv::DtEnvironmentStatusManager Class Reference

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.

Inheritance diagram for makVrv::DtEnvironmentStatusManager:
Inheritance graph
[legend]

Classes

class  DtSubsurfaceRecord
 

Public Member Functions

 DtEnvironmentStatusManager (DtBaseConnection &conn)
 
 DtEnvironmentStatusManager ()=delete
 
virtual ~DtEnvironmentStatusManager ()
 
 DtEnvironmentStatusManager (const DtEnvironmentStatusManager &)=delete
 
DtEnvironmentStatusManageroperator= (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 DtEnvironmentStatusManagerinstance (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

DtBaseConnectionmyConnection
 
std::unordered_map< DtUniqueID,
DtLocalLayeredEnvironmentData * > 
myLocalWeatherAreasMap
 
std::unordered_map< DtUniqueID,
DtLocalEnvironmentalsControllerObjectAgent * > 
myLocalWeatherAgentsMap
 
DtSceneEnvironmentalsControllerObjectAgent * myGlobalWeatherAgent
 
DtGlobalLayeredEnvironmentDatamyGlobalWeatherArea
 
std::map< float,
DtSubsurfaceRecord
myGlobalThermoclineMap
 

Constructor & Destructor Documentation

makVrv::DtEnvironmentStatusManager::DtEnvironmentStatusManager ( DtBaseConnection conn)

CTOR.

makVrv::DtEnvironmentStatusManager::DtEnvironmentStatusManager ( )
delete

Default CTOR - not allowed.

virtual makVrv::DtEnvironmentStatusManager::~DtEnvironmentStatusManager ( )
virtual

Virtual DTOR.

makVrv::DtEnvironmentStatusManager::DtEnvironmentStatusManager ( const DtEnvironmentStatusManager )
delete

Copy constructor - not allowed.

Member Function Documentation

DtEnvironmentStatusManager& makVrv::DtEnvironmentStatusManager::operator= ( const DtEnvironmentStatusManager )
delete

Assignment operator - not allowed.

virtual void makVrv::DtEnvironmentStatusManager::addWeatherArea ( DtUniqueID  areaId)
virtual

Add a new weather area. If the areaId is DtEnvironmentStatusManager::GlobalWeatherAreaId the call is ignored; the Global weather area always exists.

virtual void makVrv::DtEnvironmentStatusManager::removeWeatherArea ( DtUniqueID  areaId)
virtual

Remove a weather area. If the areaId is DtEnvironmentStatusManager::GlobalWeatherAreaId the call is ignored; the Global weather area always exists.

virtual void makVrv::DtEnvironmentStatusManager::addElevationalConfiguration ( DtUniqueID  areaId,
DtUniqueID  layerId 
)
virtual

Add a weather config layer to a weather area.

virtual void makVrv::DtEnvironmentStatusManager::removeElevationalConfiguration ( DtUniqueID  areaId,
DtUniqueID  uniqueId 
)
virtual

Remove a weather config layer from a weather area.

virtual void makVrv::DtEnvironmentStatusManager::setLocalZoneOrigin ( DtUniqueID  areaId,
const DtVector origin 
)
virtual

Set the origin of a local weather area. If the areaId is DtEnvironmentStatusManager::GlobalWeatherAreaId the call is ignored.

virtual void makVrv::DtEnvironmentStatusManager::setLocalZoneShape ( DtUniqueID  areaId,
float  width,
float  length,
float  height,
float  cornerRadius 
)
virtual

Set the dimensions of a local weather area. If the areaId is DtEnvironmentStatusManager::GlobalWeatherAreaId the call is ignored.

virtual DtLocalLayeredEnvironmentData* makVrv::DtEnvironmentStatusManager::findLocalWeatherArea ( DtUniqueID  areaId)
virtual

Find a local weather area by it's area id. If not found, the method returns nullptr.

virtual const DtLocalLayeredEnvironmentData* makVrv::DtEnvironmentStatusManager::findLocalWeatherArea ( DtUniqueID  areaId) const
virtual

Find a local weather area (const) by it's area id. If not found, the method returns nullptr.

virtual DtGlobalLayeredEnvironmentData* makVrv::DtEnvironmentStatusManager::globalWeatherArea ( )
virtual

Get a pointer to the global weather area.

virtual const DtGlobalLayeredEnvironmentData* makVrv::DtEnvironmentStatusManager::globalWeatherArea ( ) const
virtual

Get a const pointer to the global weather area.

virtual void makVrv::DtEnvironmentStatusManager::setBaseMSLAltitude ( DtUniqueID  areaId,
DtUniqueID  layerId,
float  mslAltitudeInMeters 
)
virtual

Set / get the base MSL Altitude, in meters, for this elevational configuration.

virtual float makVrv::DtEnvironmentStatusManager::baseMSLAltitude ( DtUniqueID  areaId,
DtUniqueID  layerId 
) const
virtual

Set / get the base MSL Altitude, in meters, for this elevational configuration.

virtual void makVrv::DtEnvironmentStatusManager::setWindSpeed ( DtUniqueID  areaId,
DtUniqueID  layerId,
float  speedInMetersPerSecond 
)
virtual

Set / get the speed, in meters per second, for this elevational configuration.

virtual float makVrv::DtEnvironmentStatusManager::windSpeed ( DtUniqueID  areaId,
DtUniqueID  layerId 
) const
virtual

Set / get the speed, in meters per second, for this elevational configuration.

virtual void makVrv::DtEnvironmentStatusManager::setWindDirection ( DtUniqueID  areaId,
DtUniqueID  layerId,
float  offsetInRadiansFromTrueNorth 
)
virtual

Set / get the angular offset (clockwise) from True North, in radians, for this elevational configuration.

virtual float makVrv::DtEnvironmentStatusManager::windDirection ( DtUniqueID  areaId,
DtUniqueID  layerId 
) const
virtual

Set / get the angular offset (clockwise) from True North, in radians, for this elevational configuration.

virtual void makVrv::DtEnvironmentStatusManager::setVisibilityDistance ( DtUniqueID  areaId,
DtUniqueID  layerId,
float  visibilityInMeters 
)
virtual

Set / get the visibility distance, in meters, for this elevational configuration.

virtual float makVrv::DtEnvironmentStatusManager::visibilityDistance ( DtUniqueID  areaId,
DtUniqueID  layerId 
) const
virtual

Set / get the visibility distance, in meters, for this elevational configuration.

virtual void makVrv::DtEnvironmentStatusManager::setObscurant ( DtUniqueID  areaId,
DtUniqueID  layerId,
makArchives::VisibilityObscurant  obscurantEnumerationValue 
)
virtual

Set / get the visibility obscurant for this elevational configuration.

virtual makArchives::VisibilityObscurant makVrv::DtEnvironmentStatusManager::obscurant ( DtUniqueID  areaId,
DtUniqueID  layerId 
) const
virtual

Set / get the visibility obscurant for this elevational configuration.

virtual void makVrv::DtEnvironmentStatusManager::setCloudType ( DtUniqueID  areaId,
DtUniqueID  layerId,
const std::string &  cloudTypeEnumerationValue 
)
virtual

Set / get the cloud type, by name, for this elevational configuration.

virtual std::string makVrv::DtEnvironmentStatusManager::cloudType ( DtUniqueID  areaId,
DtUniqueID  layerId 
) const
virtual

Set / get the cloud type, by name, for this elevational configuration.

virtual void makVrv::DtEnvironmentStatusManager::setCloudDensity ( DtUniqueID  areaId,
DtUniqueID  layerId,
float  cloudDensity 
)
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 float makVrv::DtEnvironmentStatusManager::cloudDensity ( DtUniqueID  areaId,
DtUniqueID  layerId 
) const
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 void makVrv::DtEnvironmentStatusManager::setSkyCoverage ( DtUniqueID  areaId,
DtUniqueID  layerId,
float  skyCoverage 
)
virtual

Set / get the sky coverage, in normalized Oktas [0-1] (which is what SilverLining expects), for this elevational configuration.

virtual float makVrv::DtEnvironmentStatusManager::skyCoverage ( DtUniqueID  areaId,
DtUniqueID  layerId 
) const
virtual

Set / get the sky coverage, in normalized Oktas [0-1] (which is what SilverLining expects), for this elevational configuration.

virtual void makVrv::DtEnvironmentStatusManager::setPrecipitationType ( DtUniqueID  areaId,
DtEnvironment::PrecipitationType  type 
)
virtual

Set / get the precipitation type.

virtual DtEnvironment::PrecipitationType makVrv::DtEnvironmentStatusManager::precipitationType ( DtUniqueID  areaId) const
virtual

Set / get the precipitation type.

virtual void makVrv::DtEnvironmentStatusManager::setPrecipitationIntensity ( DtUniqueID  areaId,
float  intensity 
)
virtual

Set / get the precipitation intensity. intensity is a normalized value (0.0 to 1.0)

virtual float makVrv::DtEnvironmentStatusManager::precipitationIntensity ( DtUniqueID  areaId) const
virtual

Set / get the precipitation intensity. intensity is a normalized value (0.0 to 1.0)

virtual void makVrv::DtEnvironmentStatusManager::setAirTemperature ( DtUniqueID  areaId,
float  temperature 
)
virtual

Set / get the air temperature. Converts to VRV Native units. METOC network value is C, native VRV app units are kelvin.

virtual float makVrv::DtEnvironmentStatusManager::airTemperature ( DtUniqueID  areaId) const
virtual

Set / get the air temperature. Converts to VRV Native units. METOC network value is C, native VRV app units are kelvin.

virtual void makVrv::DtEnvironmentStatusManager::setAirPressure ( DtUniqueID  areaId,
float  pressure 
)
virtual

Set / get the air pressure Converts to VRV Native units. METOC network value is millibars, native VRV app units are pascals.

virtual float makVrv::DtEnvironmentStatusManager::airPressure ( DtUniqueID  areaId)
virtual

Set / get the air pressure Converts to VRV Native units. METOC network value is millibars, native VRV app units are pascals.

virtual void makVrv::DtEnvironmentStatusManager::setSeaLevelWaterConcentration ( DtUniqueID  areaId,
float  ppmv 
)
virtual

Set / get the water concentration of the atmosphere in PPMV (parts per million by volume) at sea level.

virtual float makVrv::DtEnvironmentStatusManager::seaLevelWaterConcentration ( DtUniqueID  areaId) const
virtual

Set / get the water concentration of the atmosphere in PPMV (parts per million by volume) at sea level.

virtual void makVrv::DtEnvironmentStatusManager::setLightningPresent ( DtUniqueID  areaId,
bool  present 
)
virtual

Set / get whether lightning is present.

virtual bool makVrv::DtEnvironmentStatusManager::lightningPresent ( DtUniqueID  areaId) const
virtual

Set / get whether lightning is present.

virtual void makVrv::DtEnvironmentStatusManager::setSnowMinimumElevation ( DtUniqueID  areaId,
float  elevation 
)
virtual

Set / get the minimum elevation (meters) at which snow is on the ground.

virtual float makVrv::DtEnvironmentStatusManager::snowMinimumElevation ( DtUniqueID  areaId) const
virtual

Set / get the minimum elevation (meters) at which snow is on the ground.

virtual void makVrv::DtEnvironmentStatusManager::setRoadSnowAccumulation ( DtUniqueID  areaId,
float  accumulation 
)
virtual

Set / get the amount of snow accumulation on roads.

virtual float makVrv::DtEnvironmentStatusManager::roadSnowAccumulation ( DtUniqueID  areaId) const
virtual

Set / get the amount of snow accumulation on roads.

virtual void makVrv::DtEnvironmentStatusManager::setGroundRainAccumulation ( DtUniqueID  areaId,
float  accumulation 
)
virtual

Set / get the amount of rain accumulation on the ground.

virtual float makVrv::DtEnvironmentStatusManager::groundRainAccumulation ( DtUniqueID  areaId) const
virtual

Set / get the amount of rain accumulation on the ground.

virtual void makVrv::DtEnvironmentStatusManager::setGroundSnowAccumulation ( DtUniqueID  areaId,
float  accumulation 
)
virtual

Set / get the amount of snow accumulation on the ground.

virtual float makVrv::DtEnvironmentStatusManager::groundSnowAccumulation ( DtUniqueID  areaId) const
virtual

Set / get the amount of snow accumulation on the ground.

virtual void makVrv::DtEnvironmentStatusManager::setFogColor ( DtUniqueID  areaId,
float  red,
float  green,
float  blue 
)
virtual

Set / get the current fog color.

virtual void makVrv::DtEnvironmentStatusManager::getFogColor ( DtUniqueID  areaId,
float &  red,
float &  green,
float &  blue 
) const
virtual

Set / get the current fog color.

virtual void makVrv::DtEnvironmentStatusManager::setFogHeight ( DtUniqueID  areaId,
float  height 
)
virtual

Set / get the current fog height.

virtual float makVrv::DtEnvironmentStatusManager::fogHeight ( DtUniqueID  areaId) const
virtual

Set / get the current fog height.

virtual void makVrv::DtEnvironmentStatusManager::setAirPressureAltitude ( DtUniqueID  areaId,
float  altitude 
)
virtual

Set / get the altitude for which air pressure has been specified.

virtual float makVrv::DtEnvironmentStatusManager::airPressureAltitude ( DtUniqueID  areaId) const
virtual

Set / get the altitude for which air pressure has been specified.

virtual void makVrv::DtEnvironmentStatusManager::setAirTemperatureAltitude ( DtUniqueID  areaId,
float  altitude 
)
virtual

Set / get the altitude for which temperature has been specified.

virtual float makVrv::DtEnvironmentStatusManager::airTemperatureAltitude ( DtUniqueID  areaId) const
virtual
virtual void makVrv::DtEnvironmentStatusManager::setSwellState ( DtDouglasSwellState::Scale  state)
virtual

Set / get the sea swell conditions based on the Douglas sea scale.

virtual DtDouglasSwellState::Scale makVrv::DtEnvironmentStatusManager::swellState ( ) const
virtual

Set / get the sea swell conditions based on the Douglas sea scale.

virtual void makVrv::DtEnvironmentStatusManager::setSwellStateDirection ( float  value)
virtual

Set / get the direction, in radians from True North, of sea swells.

virtual float makVrv::DtEnvironmentStatusManager::swellStateDirection ( ) const
virtual

Set / get the direction, in radians from True North, of sea swells.

virtual void makVrv::DtEnvironmentStatusManager::setSeaState ( DtDouglasSeaState::Scale  state)
virtual

Set / get the sea state conditions based on the Douglas sea scale.

virtual DtDouglasSeaState::Scale makVrv::DtEnvironmentStatusManager::seaState ( ) const
virtual

Set / get the sea state conditions based on the Douglas sea scale.

virtual void makVrv::DtEnvironmentStatusManager::setSeaStateDirection ( float  value)
virtual

Set / get the sea state direction, in radians from True North.

virtual float makVrv::DtEnvironmentStatusManager::seaStateDirection ( ) const
virtual

Set / get the sea state direction, in radians from True North.

virtual void makVrv::DtEnvironmentStatusManager::setWindDrivenSeaStateEnabled ( bool  value,
bool  force = false 
)
virtual

Set / get the wind driven seas enabled parameter to allow the wind to determine the sea state.

virtual bool makVrv::DtEnvironmentStatusManager::windDrivenSeaStateEnabled ( ) const
virtual

Set / get the wind driven seas enabled parameter to allow the wind to determine the sea state.

virtual void makVrv::DtEnvironmentStatusManager::setWindFetch ( float  value)
virtual

Set / get the ocean wind fetch.

virtual float makVrv::DtEnvironmentStatusManager::windFetch ( ) const
virtual

Set / get the ocean wind fetch.

virtual void makVrv::DtEnvironmentStatusManager::setSeaChoppiness ( float  value)
virtual

Set / get the sea choppiness.

virtual float makVrv::DtEnvironmentStatusManager::seaChoppiness ( ) const
virtual

Set / get the sea choppiness.

virtual void makVrv::DtEnvironmentStatusManager::setUnderwaterVisibility ( float  depth,
float  distance 
)
virtual

Set / get the maximum visibility under water in meters.

virtual float makVrv::DtEnvironmentStatusManager::underwaterVisibility ( ) const
virtual

Set / get the maximum visibility under water in meters.

virtual void makVrv::DtEnvironmentStatusManager::setSurfaceTransparency ( float  value)
virtual

Set / get the surface transparency.

virtual float makVrv::DtEnvironmentStatusManager::surfaceTransparency ( ) const
virtual

Set / get the surface transparency.

virtual void makVrv::DtEnvironmentStatusManager::setSurgeDepth ( float  value)
virtual

Set / get the surge depth.

virtual float makVrv::DtEnvironmentStatusManager::surgeDepth ( ) const
virtual

Set / get the surge depth.

virtual void makVrv::DtEnvironmentStatusManager::setAmbientWaterTemperature ( float  temperature)
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 float makVrv::DtEnvironmentStatusManager::ambientWaterTemperature ( ) const
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 void makVrv::DtEnvironmentStatusManager::setWaterCurrentSpeed ( float  speed)
virtual

Set / get the speed of water currents in meters per second.

virtual float makVrv::DtEnvironmentStatusManager::waterCurrentSpeed ( ) const
virtual

Set / get the speed of water currents in meters per second.

virtual void makVrv::DtEnvironmentStatusManager::setWaterCurrentDirection ( float  direction)
virtual

Set the direction of water currents in radians from north (clockwise).

virtual float makVrv::DtEnvironmentStatusManager::waterCurrentDirection ( ) const
virtual

Set the direction of water currents in radians from north (clockwise).

virtual void makVrv::DtEnvironmentStatusManager::setTidalOffset ( float  meters)
virtual

Set / get the current tidal offset from mean-sea-level in meters.

virtual float makVrv::DtEnvironmentStatusManager::tidalOffset ( ) const
virtual

Set / get the current tidal offset from mean-sea-level in meters.

virtual void makVrv::DtEnvironmentStatusManager::setDateAndTimeOfDay ( int  year,
int  month,
int  day,
int  hour,
int  minutes,
double  seconds 
)
virtual

Set / get the date and time of day.

virtual void makVrv::DtEnvironmentStatusManager::getDateAndTimeOfDay ( int year,
int month,
int day,
int hour,
int minutes,
double seconds 
)
virtual

Set / get the date and time of day.

virtual void makVrv::DtEnvironmentStatusManager::setUseGlobalTimeZone ( bool  ,
bool  force = false 
)
virtual

Set / get whether to use GMT time as the means to position the sun/moon rather than always moving with the observer.

virtual bool makVrv::DtEnvironmentStatusManager::useGlobalTimeZone ( ) const
virtual

Set / get whether to use GMT time as the means to position the sun/moon rather than always moving with the observer.

virtual void makVrv::DtEnvironmentStatusManager::setTimeOfDayAdvancementSpeed ( float  speed)
virtual

Set / get the time of day advancement speed.

virtual float makVrv::DtEnvironmentStatusManager::timeOfDayAdvancementSpeed ( ) const
virtual

Set / get the time of day advancement speed.

virtual void makVrv::DtEnvironmentStatusManager::setThermoclinePermeability ( float  depth,
float  permeability 
)
virtual

Set / get the thermocline permeability at the specified depth.

virtual float makVrv::DtEnvironmentStatusManager::thermoclinePermeability ( float  depth) const
virtual

Set / get the thermocline permeability at the specified depth.

static DtEnvironmentStatusManager& makVrv::DtEnvironmentStatusManager::instance ( DtBaseConnection conn)
static

Find an instance of the DtEnvironmentStatusManager registered with a connection.

virtual DtLayeredEnvironmentDataBase* makVrv::DtEnvironmentStatusManager::findWeatherAreaBase ( DtUniqueID  areaId)
protectedvirtual

Find the weather area (as a pointer to the base class). Returns nullptr if it doesn't exist.

virtual const DtLayeredEnvironmentDataBase* makVrv::DtEnvironmentStatusManager::findWeatherAreaBase ( DtUniqueID  areaId) const
protectedvirtual

Find the weather area (as a const pointer to the base class). Returns nullptr if it doesn't exist.

Member Data Documentation

const DtUniqueID makVrv::DtEnvironmentStatusManager::GlobalWeatherAreaId = (DtUniqueID)-1
static
DtBaseConnection& makVrv::DtEnvironmentStatusManager::myConnection
protected
std::unordered_map<DtUniqueID, DtLocalLayeredEnvironmentData*> makVrv::DtEnvironmentStatusManager::myLocalWeatherAreasMap
protected
std::unordered_map<DtUniqueID, DtLocalEnvironmentalsControllerObjectAgent*> makVrv::DtEnvironmentStatusManager::myLocalWeatherAgentsMap
protected
DtSceneEnvironmentalsControllerObjectAgent* makVrv::DtEnvironmentStatusManager::myGlobalWeatherAgent
protected
DtGlobalLayeredEnvironmentData* makVrv::DtEnvironmentStatusManager::myGlobalWeatherArea
protected
std::map<float, DtSubsurfaceRecord> makVrv::DtEnvironmentStatusManager::myGlobalThermoclineMap
protected

The documentation for this class was generated from the following file:

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)