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 Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
makArchives::DtEnvironmentRecord Class Reference

Record of environment/weather settings Includes precipitation, air, and clouds.

Classes

class  DtColorRecord
 
class  DtElevationalConfigurationRecord
 
class  DtElevationalWindRecord
 
class  DtThermoclineRecord
 

Public Types

typedef std::vector
< DtCloudLayerRecord
CloudLayerRecordList
 
typedef std::vector
< DtThermoclineRecord
ThermoclineRecordList
 
typedef std::vector
< DtElevationalWindRecord
ElevationalWindRecordList
 
typedef std::vector
< DtElevationalConfigurationRecord
ElevationalConfigurationRecordList
 
typedef std::map< std::string,
std::string > 
OptionalParameterMap
 

Public Member Functions

 DtEnvironmentRecord ()
 
 DtEnvironmentRecord (const DtEnvironmentRecord &orig)
 
virtual ~DtEnvironmentRecord ()
 
void swap (DtEnvironmentRecord &other)
 
DtEnvironmentRecordoperator= (DtEnvironmentRecord rhs)
 
virtual void addElevationalConfigurationRecord (DtElevationalConfigurationRecord rec)
 
virtual bool removeElevationalConfigurationRecord (unsigned int index)
 
bool setElevationalConfigurationRecord (unsigned int index, const DtElevationalConfigurationRecord &wRec)
 
const
DtElevationalConfigurationRecord
getElevationalConfigurationRecord (unsigned int index) const
 
DtElevationalConfigurationRecordgetElevationalConfigurationRecord (unsigned int index)
 
bool setElevationalConfigurationBaseMSLAltitude (unsigned int index, float baseMSLAltitude)
 
bool getElevationalConfigurationBaseMSLAltitude (unsigned int index, float &baseMSLAltitude) const
 
bool setElevationalWindSpeed (unsigned int index, float metersPerSecond)
 
bool getElevationalWindSpeed (unsigned int index, float &windSpeed) const
 
bool setElevationalWindDirection (unsigned int index, float radiansFromNorth)
 
bool getElevationalWindDirection (unsigned int index, float &windDirection) const
 
bool setElevationalVisibilityDistance (unsigned int index, float meters)
 
bool getElevationalVisibilityDistance (unsigned int index, float &visibilityDistance) const
 
bool setElevationalVisibilityObscurant (unsigned int index, VisibilityObscurant obscurant)
 
bool getElevationalVisibilityObscurant (unsigned int index, VisibilityObscurant &obscurant) const
 
bool setElevationalCloudType (unsigned int index, std::string cloudTypeName)
 
bool getElevationalCloudType (unsigned int index, std::string &cloudTypeName) const
 
bool setElevationalCloudDensity (unsigned int index, float cloudDensity)
 
bool getElevationalCloudDensity (unsigned int index, float &cloudDensity) const
 
bool setElevationalSkyCoverage (unsigned int index, float cloudCoverage)
 
bool getElevationalSkyCoverage (unsigned int index, float &cloudCoverage) const
 
void setEnvironmentName (const std::string &name)
 
const std::string & environmentName () const
 
void setIsLocalOnly (bool isLocalOnly)
 
bool isLocalOnly () const
 
void setAirTurbidity (float turbidity)
 
float airTurbidity () const
 
void setVisibleDistance (float distance)
 
float visibleDistance () const
 
void setPrecipitation (int type)
 
int precipitation () const
 
void setPrecipitationIntensity (float intensity)
 
float precipitationIntensity () const
 
CloudLayerRecordListcustomCloudLayers ()
 
const CloudLayerRecordListcustomCloudLayers () const
 
void setCloudCoverType (DtCloudCoverType cloudCoverType)
 
DtCloudCoverType cloudCoverType () const
 
virtual void setLightningPresent (bool lightningPresent)
 
virtual bool lightningPresent () const
 
virtual void setBlowingParticulateMatter (makArchives::BlowingParticulateMatterType type)
 
virtual
makArchives::BlowingParticulateMatterType 
blowingParticulateMatter () const
 
ElevationalConfigurationRecordListelevationalConfigurations ()
 
const
ElevationalConfigurationRecordList
elevationalConfigurations () const
 
void setWindSpeed (float metersPerSecond)
 
float windSpeed () const
 
void setWindDirection (float radiansFromNorth)
 
float windDirection () const
 
void setAmbientAirTemperature (float kelvins)
 
float ambientAirTemperature () const
 
void setSeaState (int douglasScale)
 
int seaState () const
 
void setSeaStateDirection (float radiansFromNorth)
 
float seaStateDirection () const
 
void setWindDrivenSeaStateEnabled (bool enabled)
 
bool windDrivenSeaStateEnabled () const
 
void setSwellState (int douglasScale)
 
int swellState () const
 
void setSwellStateDirection (float radiansFromNorth)
 
float swellStateDirection () const
 
void setWindFetch (float meters)
 
float windFetch () const
 
void setSeaChoppiness (float chop)
 
float seaChoppiness () const
 
void setUnderwaterVisibilityEnabled (bool enabled)
 
bool underwaterVisibilityEnabled () const
 
void setUnderwaterVisibility (float meters)
 
float underwaterVisibility () const
 
void setSurfaceTransparency (float normalizedValue)
 
float surfaceTransparency () const
 
void setSurgeDepth (float meters)
 
float surgeDepth () const
 
void setDepthOffset (float meters)
 
float depthOffset () const
 
void setAmbientWaterTemperature (float kelvins)
 
float ambientWaterTemperature () const
 
void setWaterCurrentSpeed (float metersPerSecond)
 
float waterCurrentSpeed () const
 
void setWaterCurrentDirection (float radiansFromNorth)
 
float waterCurrentDirection () const
 
void setTidalOffset (float meters)
 
float tidalOffset () const
 
void setTidalDirection (bool inOut)
 
bool tidalDirection () const
 
void setFogHeight (float meters)
 
float fogHeight () const
 
void setFogColor (const DtColorRecord &color)
 
const DtColorRecordfogColor () const
 
void setThermoclineRecord (unsigned int index, const DtThermoclineRecord &tRec)
 
DtThermoclineRecord thermoclineRecord (unsigned int index) const
 
void setThermoclineDepth (unsigned int index, float depth)
 
float thermoclineDepth (unsigned int index) const
 
void setThermoclinePermeability (unsigned int index, float permeability)
 
float thermoclinePermeability (unsigned int index) const
 
void setGroundSnowAccumulation (float depth)
 
float groundSnowAccumulation () const
 
void setRoadSnowAccumulation (float depth)
 
float roadSnowAccumulation () const
 
void setSnowMinimumElevation (float elevation)
 
float snowMinimumElevation () const
 
void setSnowElevationTransition (float elevation)
 
float snowElevationTransition () const
 
void setGroundRainAccumulation (float depth)
 
float groundRainAccumulation () const
 
void setAmbientAirPressure (float pressure)
 
float ambientAirPressure () const
 
void setAirPressureAltitude (float altitude)
 
float airPressureAltitude () const
 
void setAirTemperatureAltitude (float altitude)
 
float airTemperatureAltitude () const
 
void setAirPressureAltitudeIsSeaLevel (bool seaLevel)
 
bool airPressureAltitudeIsSeaLevel () const
 
void setAirTemperatureAltitudeIsSeaLevel (bool seaLevel)
 
bool airTemperatureAltitudeIsSeaLevel () const
 
void setSeaLevelWaterConcentration (float water)
 
float seaLevelWaterConcentration () const
 
virtual const std::string * findOptionalParameter (const std::string &name) const
 
virtual void setOptionalParameter (const std::string &name, const std::string &value)
 
virtual void setOptionalParameters (const OptionalParameterMap &)
 
virtual void removeOptionalParameter (const std::string &name)
 
const OptionalParameterMapoptionalParameters () const
 

Protected Member Functions

virtual void sortElevationalWindRecordsByBaseMSLAltitude ()
 
virtual void sortElevationalConfigurationRecordsByBaseMSLAltitude ()
 
virtual void copyOldWindSpecificElevationalConfigurationsToNewElevationalConfigurations ()
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Protected Attributes

std::string myEnvironmentName
 
bool myIsLocalOnly
 
float myAirTurbidity
 
int myPrecipitation
 
float myPrecipitationIntensity
 
CloudLayerRecordList myCloudLayers
 
DtCloudCoverType myCloudCoverType
 
bool myLightningPresent
 
BlowingParticulateMatterType myBlowingParticulateMatter
 
float myWindSpeed
 
float myWindDirection
 
float myVisibilityDistance
 
ElevationalWindRecordList myWindConfigurations
 
ElevationalConfigurationRecordList myElevationalConfigurations
 
float myAmbientAirTemperature
 
int mySeaState
 
float mySeaStateDirection
 
bool myWindDrivenSeaStateEnabled
 
int mySwellState
 
float mySwellStateDirection
 
float myWindFetch
 
float mySeaChoppiness
 
float myUnderwaterVisibility
 
float mySurfaceTransparency
 
float mySurgeDepth
 
float myDepthOffset
 
float myAmbientWaterTemperature
 
float myWaterCurrentSpeed
 
float myWaterCurrentDirection
 
float myTidalOffset
 
bool myTidalDirection
 
float myFogHeight
 
DtColorRecord myFogColor
 
ThermoclineRecordList myThermoclineRecordList
 
bool myUseCustomCloudCover
 
OptionalParameterMap myOptionalParameters
 
bool myPrecipitationEnabledFlag
 
std::string myPrecipitationType
 
bool myUnderwaterVisibilityEnabled
 
float myGroundSnowAccumulation
 
float myRoadSnowAccumulation
 
float mySnowMinimumElevation
 
float mySnowElevationTransition
 
float myGroundRainAccumulation
 
float myAirPressure
 
float myAirPressureAltitude
 
float myAirTemperatureAltitude
 
bool myAirPressureAltitudeIsSeaLevel
 
bool myAirTemperatureAltitudeIsSeaLevel
 
float mySeaLevelWaterConcentration
 

Friends

class boost::serialization::access
 

Member Typedef Documentation

typedef std::map<std::string, std::string> makArchives::DtEnvironmentRecord::OptionalParameterMap

Constructor & Destructor Documentation

makArchives::DtEnvironmentRecord::DtEnvironmentRecord ( )

CTOR.

makArchives::DtEnvironmentRecord::DtEnvironmentRecord ( const DtEnvironmentRecord orig)

Copy CTOR.

virtual makArchives::DtEnvironmentRecord::~DtEnvironmentRecord ( )
virtual

DTOR.

Member Function Documentation

void makArchives::DtEnvironmentRecord::swap ( DtEnvironmentRecord other)

Swap data from this object with another.

DtEnvironmentRecord& makArchives::DtEnvironmentRecord::operator= ( DtEnvironmentRecord  rhs)

Assignment Operator.

void makArchives::DtEnvironmentRecord::setEnvironmentName ( const std::string &  name)

Set / Get the name for this environment.

const std::string& makArchives::DtEnvironmentRecord::environmentName ( ) const

Set / Get the name for this environment.

void makArchives::DtEnvironmentRecord::setIsLocalOnly ( bool  isLocalOnly)

Set / Get whether or not this environment condition is a 'local-only' environment condition. This local-only environment condition flag is used by VR-Forces to determine if a given environment condition can be applied to a published local weather area. VR-Vantage supports the configuration of environment conditions that can be applied to the global environment to restrict which environment conditions the user can use and modify.

bool makArchives::DtEnvironmentRecord::isLocalOnly ( ) const

Set / Get whether or not this environment condition is a 'local-only' environment condition. This local-only environment condition flag is used by VR-Forces to determine if a given environment condition can be applied to a published local weather area. VR-Vantage supports the configuration of environment conditions that can be applied to the global environment to restrict which environment conditions the user can use and modify.

void makArchives::DtEnvironmentRecord::setAirTurbidity ( float  turbidity)

Set / Get the air turbidity value.

float makArchives::DtEnvironmentRecord::airTurbidity ( ) const

Set / Get the air turbidity value.

void makArchives::DtEnvironmentRecord::setVisibleDistance ( float  distance)

Set / Get the visible distance. Deprecated as of version 12, use setElevationalVisibilityDistance(...) and getElevationalVisibilityDistance(...) instead.

float makArchives::DtEnvironmentRecord::visibleDistance ( ) const

Set / Get the visible distance. Deprecated as of version 12, use setElevationalVisibilityDistance(...) and getElevationalVisibilityDistance(...) instead.

void makArchives::DtEnvironmentRecord::setPrecipitation ( int  type)

Set / Get the type of precipitation.

int makArchives::DtEnvironmentRecord::precipitation ( ) const

Set / Get the type of precipitation.

void makArchives::DtEnvironmentRecord::setPrecipitationIntensity ( float  intensity)

Set / Get intensity of precipitation in normalized values (0.0 - 1.0).

float makArchives::DtEnvironmentRecord::precipitationIntensity ( ) const

Set / Get intensity of precipitation in normalized values (0.0 - 1.0).

CloudLayerRecordList& makArchives::DtEnvironmentRecord::customCloudLayers ( )

Set / Get the the list of custom cloud layers. Deprecated.

const CloudLayerRecordList& makArchives::DtEnvironmentRecord::customCloudLayers ( ) const

Set / Get the the list of custom cloud layers. Deprecated.

void makArchives::DtEnvironmentRecord::setCloudCoverType ( DtCloudCoverType  cloudCoverType)

Set / Get the cloud cover name. Deprecated as of version 1 of DtElevationalConfigurationRecord, use setElevationalCloudType(...) and getElevationalCloudType(...) instead.

DtCloudCoverType makArchives::DtEnvironmentRecord::cloudCoverType ( ) const

Set / Get the cloud cover name. Deprecated as of version 1 of DtElevationalConfigurationRecord, use setElevationalCloudType(...) and getElevationalCloudType(...) instead.

virtual void makArchives::DtEnvironmentRecord::setLightningPresent ( bool  lightningPresent)
virtual

Set/Get whether or not lightning is present.

virtual bool makArchives::DtEnvironmentRecord::lightningPresent ( ) const
virtual

Set/Get whether or not lightning is present.

virtual void makArchives::DtEnvironmentRecord::setBlowingParticulateMatter ( makArchives::BlowingParticulateMatterType  type)
virtual

Set/Get the blowing particulate matter.

virtual makArchives::BlowingParticulateMatterType makArchives::DtEnvironmentRecord::blowingParticulateMatter ( ) const
virtual

Set/Get the blowing particulate matter.

ElevationalConfigurationRecordList& makArchives::DtEnvironmentRecord::elevationalConfigurations ( )

Get the the list of elevational configurations.

const ElevationalConfigurationRecordList& makArchives::DtEnvironmentRecord::elevationalConfigurations ( ) const

Get the the list of elevational configurations.

virtual void makArchives::DtEnvironmentRecord::addElevationalConfigurationRecord ( DtElevationalConfigurationRecord  rec)
virtual

Add an elevational configuration record to the environment record. The internal records are sorted by their base MSL altitude after the new record is added.

virtual bool makArchives::DtEnvironmentRecord::removeElevationalConfigurationRecord ( unsigned int  index)
virtual

Remove an elevational configuration record from the environment record by its index.

bool makArchives::DtEnvironmentRecord::setElevationalConfigurationRecord ( unsigned int  index,
const DtElevationalConfigurationRecord wRec 
)

Update an elevational configuration record by its index Returns false if an elevational configuration record at the specified index does not exist, returns true otherwise.

const DtElevationalConfigurationRecord* makArchives::DtEnvironmentRecord::getElevationalConfigurationRecord ( unsigned int  index) const

Get an elevational configuration record by its index, returned by const pointer.

Note
This function can return nullptr.
DtElevationalConfigurationRecord* makArchives::DtEnvironmentRecord::getElevationalConfigurationRecord ( unsigned int  index)

Get an elevational configuration record by its index, returned by pointer.

Note
This function can return nullptr.
bool makArchives::DtEnvironmentRecord::setElevationalConfigurationBaseMSLAltitude ( unsigned int  index,
float  baseMSLAltitude 
)

Set an elevational configuration record's base MSL altitude by its index. Returns false if an elevational configuration record at the specified index does not exist, returns true otherwise. Altitude is expressed in meters. The internal records are sorted by their base MSL altitude after the elevational configuration record's base MSL altitude is updated.

bool makArchives::DtEnvironmentRecord::getElevationalConfigurationBaseMSLAltitude ( unsigned int  index,
float &  baseMSLAltitude 
) const

Get an elevational configuration record's base MSL altitude by its index, returned by reference. The function returns true if an elevational configuration record at the specified index is found. False otherwise. Altitude is expressed in meters.

bool makArchives::DtEnvironmentRecord::setElevationalWindSpeed ( unsigned int  index,
float  metersPerSecond 
)

Set an elevational configuration record's wind speed by its index. Returns false if an elevational configuration record at the specified index does not exist, returns true otherwise. Wind Speed is expressed in meters per second.

bool makArchives::DtEnvironmentRecord::getElevationalWindSpeed ( unsigned int  index,
float &  windSpeed 
) const

Get an elevational configuration record's wind speed by its index, returned by reference. The function returns true if an elevational configuration record at the specified index is found. False otherwise. Wind Speed is expressed in meters per second.

bool makArchives::DtEnvironmentRecord::setElevationalWindDirection ( unsigned int  index,
float  radiansFromNorth 
)

Set an elevational configuration record's wind direction by its index. Returns false if an elevational configuration record at the specified index does not exist, returns true otherwise. Wind direction is expressed in radians from True North (clockwise).

bool makArchives::DtEnvironmentRecord::getElevationalWindDirection ( unsigned int  index,
float &  windDirection 
) const

Get an elevational configuration record's wind direction by its index, returned by reference. The function returns true if an elevational configuration record at the specified index is found. False otherwise. Wind direction is expressed in radians from True North (clockwise).

bool makArchives::DtEnvironmentRecord::setElevationalVisibilityDistance ( unsigned int  index,
float  meters 
)

Set an elevational configuration record's visibility distance by its index. Returns false if a elevational configuration record at the specified index does not exist, returns true otherwise. Visibility distance is expressed in meters.

bool makArchives::DtEnvironmentRecord::getElevationalVisibilityDistance ( unsigned int  index,
float &  visibilityDistance 
) const

Get an elevational configuration record's visibility distance by its index, returned by reference. The function returns true if an elevational configuration record at the specified index is found. False otherwise. Visibility distance is expressed in meters.

bool makArchives::DtEnvironmentRecord::setElevationalVisibilityObscurant ( unsigned int  index,
VisibilityObscurant  obscurant 
)

Set an elevational configuration record's obscurant by its index. Returns false if an elevational configuration record at the specified index does not exist, returns true otherwise. Obscurant is expressed as the VisibilityObscurant enumeration.

bool makArchives::DtEnvironmentRecord::getElevationalVisibilityObscurant ( unsigned int  index,
VisibilityObscurant obscurant 
) const

Get an elevational configuration record's obscurant by its index, returned by reference. The function returns true if an elevational configuration record at the specified index is found. False otherwise. Obscurant is expressed as the VisibilityObscurant enumeration.

bool makArchives::DtEnvironmentRecord::setElevationalCloudType ( unsigned int  index,
std::string  cloudTypeName 
)

Set an elevational configuration record's cloud type by its index. Returns false if an elevational configuration record at the specified index does not exist, returns true otherwise. Cloud type is expressed as a std::string representing the name of the type of cloud.

bool makArchives::DtEnvironmentRecord::getElevationalCloudType ( unsigned int  index,
std::string &  cloudTypeName 
) const

Get an elevational configuration record's cloud type by its index, returned by reference. The function returns true if an elevational configuration record at the specified index is found. False otherwise. Cloud type is expressed as a std::string representing the name of the type of cloud.

bool makArchives::DtEnvironmentRecord::setElevationalCloudDensity ( unsigned int  index,
float  cloudDensity 
)

Set an elevational configuration record's cloud density by its index. Returns false if an elevational configuration record at the specified index does not exist, returns true otherwise. Cloud density is expressed in kg/m^3. As of VRV 2.8, this property is not used. It is only used by VR-Forces.

bool makArchives::DtEnvironmentRecord::getElevationalCloudDensity ( unsigned int  index,
float &  cloudDensity 
) const

Get an elevational configuration record's cloud density by its index, returned by reference. The function returns true if an elevational configuration record at the specified index is found. False otherwise. Cloud density is expressed in kg/m^3. As of VRV 2.8, this property is not used. It is only used by VR-Forces.

bool makArchives::DtEnvironmentRecord::setElevationalSkyCoverage ( unsigned int  index,
float  cloudCoverage 
)

Set an elevational configuration record's sky coverage by its index. Returns false if an elevational configuration record at the specified index does not exist, returns true otherwise. Sky coverage is expressed, in normalized Oktas [0-1] (which is what SilverLining expects).

bool makArchives::DtEnvironmentRecord::getElevationalSkyCoverage ( unsigned int  index,
float &  cloudCoverage 
) const

Get an elevational configuration record's sky coverage by its index, returned by reference. The function returns true if an elevational configuration record at the specified index is found. False otherwise. Sky coverage is expressed, in normalized Oktas [0-1] (which is what SilverLining expects).

void makArchives::DtEnvironmentRecord::setWindSpeed ( float  metersPerSecond)

Set / Get the wind speed in meters per second. Deprecated as of version 11, use setElevationalWindSpeed(...) and getElevationalWindSpeed(...) instead.

float makArchives::DtEnvironmentRecord::windSpeed ( ) const

Set / Get the wind speed in meters per second. Deprecated as of version 11, use setElevationalWindSpeed(...) and getElevationalWindSpeed(...) instead.

void makArchives::DtEnvironmentRecord::setWindDirection ( float  radiansFromNorth)

Set / Get the direction wind blows from in radians from North. Deprecated as of version 11, use setElevationalWindDirection(...) and getElevationalWindDirection(...) instead.

float makArchives::DtEnvironmentRecord::windDirection ( ) const

Set / Get the direction wind blows from in radians from North. Deprecated as of version 11, use setElevationalWindDirection(...) and getElevationalWindDirection(...) instead.

void makArchives::DtEnvironmentRecord::setAmbientAirTemperature ( float  kelvins)

Set / Get the ambient air temperature, in Kelvins.

float makArchives::DtEnvironmentRecord::ambientAirTemperature ( ) const

Set / Get the ambient air temperature, in Kelvins.

void makArchives::DtEnvironmentRecord::setSeaState ( int  douglasScale)

Set / Get the sea-state according to the Douglas Sea Scale.

int makArchives::DtEnvironmentRecord::seaState ( ) const

Set / Get the sea-state according to the Douglas Sea Scale.

void makArchives::DtEnvironmentRecord::setSeaStateDirection ( float  radiansFromNorth)

Set / Get the direction waves travel from in radians from North.

float makArchives::DtEnvironmentRecord::seaStateDirection ( ) const

Set / Get the direction waves travel from in radians from North.

void makArchives::DtEnvironmentRecord::setWindDrivenSeaStateEnabled ( bool  enabled)

Set / Get the flag for enabling sea-state to be driven by wind.

bool makArchives::DtEnvironmentRecord::windDrivenSeaStateEnabled ( ) const

Set / Get the flag for enabling sea-state to be driven by wind.

void makArchives::DtEnvironmentRecord::setSwellState ( int  douglasScale)

Set / Get the sea-swell state according to the Douglas Sea Scale.

int makArchives::DtEnvironmentRecord::swellState ( ) const

Set / Get the sea-swell state according to the Douglas Sea Scale.

void makArchives::DtEnvironmentRecord::setSwellStateDirection ( float  radiansFromNorth)

Set / Get the direction sea-swells travel from in radians from North.

float makArchives::DtEnvironmentRecord::swellStateDirection ( ) const

Set / Get the direction sea-swells travel from in radians from North.

void makArchives::DtEnvironmentRecord::setWindFetch ( float  meters)

Set / Get the ocean fetch in distance.

float makArchives::DtEnvironmentRecord::windFetch ( ) const

Set / Get the ocean fetch in distance.

void makArchives::DtEnvironmentRecord::setSeaChoppiness ( float  chop)

Set / Get the wave choppiness in normalized values (0.0 - 1.0).

float makArchives::DtEnvironmentRecord::seaChoppiness ( ) const

Set / Get the wave choppiness in normalized values (0.0 - 1.0).

void makArchives::DtEnvironmentRecord::setUnderwaterVisibilityEnabled ( bool  enabled)

Set / Get underwater visibility enabled.

bool makArchives::DtEnvironmentRecord::underwaterVisibilityEnabled ( ) const

Set / Get underwater visibility enabled.

void makArchives::DtEnvironmentRecord::setUnderwaterVisibility ( float  meters)

Set / Get the underwater visibility in distance.

float makArchives::DtEnvironmentRecord::underwaterVisibility ( ) const

Set / Get the underwater visibility in distance.

void makArchives::DtEnvironmentRecord::setSurfaceTransparency ( float  normalizedValue)

Set / Get the surface transparency in normalized values (0.0 - 1.0).

float makArchives::DtEnvironmentRecord::surfaceTransparency ( ) const

Set / Get the surface transparency in normalized values (0.0 - 1.0).

void makArchives::DtEnvironmentRecord::setSurgeDepth ( float  meters)

Set / Get the surge depth in distance.

float makArchives::DtEnvironmentRecord::surgeDepth ( ) const

Set / Get the surge depth in distance.

void makArchives::DtEnvironmentRecord::setDepthOffset ( float  meters)

Set / Get the depth offset in distance.

float makArchives::DtEnvironmentRecord::depthOffset ( ) const

Set / Get the depth offset in distance.

void makArchives::DtEnvironmentRecord::setAmbientWaterTemperature ( float  kelvins)

Set / Get the ambient water temperature, in Kelvins.

float makArchives::DtEnvironmentRecord::ambientWaterTemperature ( ) const

Set / Get the ambient water temperature, in Kelvins.

void makArchives::DtEnvironmentRecord::setWaterCurrentSpeed ( float  metersPerSecond)

Set / Get the water-current speed in meters per second.

float makArchives::DtEnvironmentRecord::waterCurrentSpeed ( ) const

Set / Get the water-current speed in meters per second.

void makArchives::DtEnvironmentRecord::setWaterCurrentDirection ( float  radiansFromNorth)

Set / Get the direction of water-currents in radians from North.

float makArchives::DtEnvironmentRecord::waterCurrentDirection ( ) const

Set / Get the direction of water-currents in radians from North.

void makArchives::DtEnvironmentRecord::setTidalOffset ( float  meters)

Set / Get the tidal offset in distance.

float makArchives::DtEnvironmentRecord::tidalOffset ( ) const

Set / Get the tidal offset in distance.

void makArchives::DtEnvironmentRecord::setTidalDirection ( bool  inOut)

Set / Get the tidal direction flag.

bool makArchives::DtEnvironmentRecord::tidalDirection ( ) const

Set / Get the tidal direction flag.

void makArchives::DtEnvironmentRecord::setFogHeight ( float  meters)

Set / Get the fog height in distance.

float makArchives::DtEnvironmentRecord::fogHeight ( ) const

Set / Get the fog height in distance.

void makArchives::DtEnvironmentRecord::setFogColor ( const DtColorRecord color)

Set / Get the fog color. Components are normalized values (0.0 - 1.0).

const DtColorRecord& makArchives::DtEnvironmentRecord::fogColor ( ) const

Set / Get the fog color. Components are normalized values (0.0 - 1.0).

void makArchives::DtEnvironmentRecord::setThermoclineRecord ( unsigned int  index,
const DtThermoclineRecord tRec 
)

Set / Get a thermocline data.

DtThermoclineRecord makArchives::DtEnvironmentRecord::thermoclineRecord ( unsigned int  index) const

Set / Get a thermocline data.

void makArchives::DtEnvironmentRecord::setThermoclineDepth ( unsigned int  index,
float  depth 
)

Set / Get a thermocline data.

float makArchives::DtEnvironmentRecord::thermoclineDepth ( unsigned int  index) const

Set / Get a thermocline data.

void makArchives::DtEnvironmentRecord::setThermoclinePermeability ( unsigned int  index,
float  permeability 
)

Set / Get a thermocline data.

float makArchives::DtEnvironmentRecord::thermoclinePermeability ( unsigned int  index) const

Set / Get a thermocline data.

void makArchives::DtEnvironmentRecord::setGroundSnowAccumulation ( float  depth)

get/set the ground snow accumulation depth

float makArchives::DtEnvironmentRecord::groundSnowAccumulation ( ) const

get/set the ground snow accumulation depth

void makArchives::DtEnvironmentRecord::setRoadSnowAccumulation ( float  depth)

get/set the road snow accumulation depth

float makArchives::DtEnvironmentRecord::roadSnowAccumulation ( ) const

get/set the road snow accumulation depth

void makArchives::DtEnvironmentRecord::setSnowMinimumElevation ( float  elevation)

get/set the snow minimum elevation

float makArchives::DtEnvironmentRecord::snowMinimumElevation ( ) const

get/set the snow minimum elevation

void makArchives::DtEnvironmentRecord::setSnowElevationTransition ( float  elevation)

get/set the snow elevation transition which specifies how long it takes to go from no snow to the full snow depth.

float makArchives::DtEnvironmentRecord::snowElevationTransition ( ) const

get/set the snow elevation transition which specifies how long it takes to go from no snow to the full snow depth.

void makArchives::DtEnvironmentRecord::setGroundRainAccumulation ( float  depth)

get/set the ground rain accumulation depth

float makArchives::DtEnvironmentRecord::groundRainAccumulation ( ) const

get/set the ground rain accumulation depth

void makArchives::DtEnvironmentRecord::setAmbientAirPressure ( float  pressure)

get/set the ambient air pressure

float makArchives::DtEnvironmentRecord::ambientAirPressure ( ) const

get/set the ambient air pressure

void makArchives::DtEnvironmentRecord::setAirPressureAltitude ( float  altitude)

get/set the air pressure altitude

float makArchives::DtEnvironmentRecord::airPressureAltitude ( ) const

get/set the air pressure altitude

void makArchives::DtEnvironmentRecord::setAirTemperatureAltitude ( float  altitude)

get/set the air temperature altitude

float makArchives::DtEnvironmentRecord::airTemperatureAltitude ( ) const

get/set the air temperature altitude

void makArchives::DtEnvironmentRecord::setAirPressureAltitudeIsSeaLevel ( bool  seaLevel)

get/set the air pressure altitude is sea level

bool makArchives::DtEnvironmentRecord::airPressureAltitudeIsSeaLevel ( ) const

get/set the air pressure altitude is sea level

void makArchives::DtEnvironmentRecord::setAirTemperatureAltitudeIsSeaLevel ( bool  seaLevel)

get/set the air temperature altitude is sea level

bool makArchives::DtEnvironmentRecord::airTemperatureAltitudeIsSeaLevel ( ) const

get/set the air temperature altitude is sea level

void makArchives::DtEnvironmentRecord::setSeaLevelWaterConcentration ( float  water)

get/set the sea level water concentration

float makArchives::DtEnvironmentRecord::seaLevelWaterConcentration ( ) const

get/set the sea level water concentration

virtual const std::string* makArchives::DtEnvironmentRecord::findOptionalParameter ( const std::string &  name) const
virtual

Find an optional parameter.

virtual void makArchives::DtEnvironmentRecord::setOptionalParameter ( const std::string &  name,
const std::string &  value 
)
virtual

Set an optional parameter.

virtual void makArchives::DtEnvironmentRecord::setOptionalParameters ( const OptionalParameterMap )
virtual

Set an optional parameters. This will overwrite any existing optional parameters.

virtual void makArchives::DtEnvironmentRecord::removeOptionalParameter ( const std::string &  name)
virtual

Remove an optional parameter.

const OptionalParameterMap& makArchives::DtEnvironmentRecord::optionalParameters ( ) const

Get the optional parameters.

virtual void makArchives::DtEnvironmentRecord::sortElevationalWindRecordsByBaseMSLAltitude ( )
protectedvirtual

Sorts the internal elevational wind records by their base MSL altitude. This function is used whenever a new elevational wind record is added or when a record's base MSL altitude is updated.

virtual void makArchives::DtEnvironmentRecord::sortElevationalConfigurationRecordsByBaseMSLAltitude ( )
protectedvirtual

Sorts the internal elevational configuration records by their base MSL altitude. This function is used whenever a new elevational configuration record is added or when a record's base MSL altitude is updated.

virtual void makArchives::DtEnvironmentRecord::copyOldWindSpecificElevationalConfigurationsToNewElevationalConfigurations ( )
protectedvirtual

Copy over myWindConfiguration to myElevationalConfigurations.

template<class Archive >
void makArchives::DtEnvironmentRecord::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<. Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Member Data Documentation

std::string makArchives::DtEnvironmentRecord::myEnvironmentName
protected
bool makArchives::DtEnvironmentRecord::myIsLocalOnly
protected
float makArchives::DtEnvironmentRecord::myAirTurbidity
protected
int makArchives::DtEnvironmentRecord::myPrecipitation
protected
float makArchives::DtEnvironmentRecord::myPrecipitationIntensity
protected
CloudLayerRecordList makArchives::DtEnvironmentRecord::myCloudLayers
protected
DtCloudCoverType makArchives::DtEnvironmentRecord::myCloudCoverType
protected
bool makArchives::DtEnvironmentRecord::myLightningPresent
protected
BlowingParticulateMatterType makArchives::DtEnvironmentRecord::myBlowingParticulateMatter
protected
float makArchives::DtEnvironmentRecord::myWindSpeed
protected
float makArchives::DtEnvironmentRecord::myWindDirection
protected
float makArchives::DtEnvironmentRecord::myVisibilityDistance
protected
ElevationalWindRecordList makArchives::DtEnvironmentRecord::myWindConfigurations
protected
ElevationalConfigurationRecordList makArchives::DtEnvironmentRecord::myElevationalConfigurations
protected
float makArchives::DtEnvironmentRecord::myAmbientAirTemperature
protected
int makArchives::DtEnvironmentRecord::mySeaState
protected
float makArchives::DtEnvironmentRecord::mySeaStateDirection
protected
bool makArchives::DtEnvironmentRecord::myWindDrivenSeaStateEnabled
protected
int makArchives::DtEnvironmentRecord::mySwellState
protected
float makArchives::DtEnvironmentRecord::mySwellStateDirection
protected
float makArchives::DtEnvironmentRecord::myWindFetch
protected
float makArchives::DtEnvironmentRecord::mySeaChoppiness
protected
float makArchives::DtEnvironmentRecord::myUnderwaterVisibility
protected
float makArchives::DtEnvironmentRecord::mySurfaceTransparency
protected
float makArchives::DtEnvironmentRecord::mySurgeDepth
protected
float makArchives::DtEnvironmentRecord::myDepthOffset
protected
float makArchives::DtEnvironmentRecord::myAmbientWaterTemperature
protected
float makArchives::DtEnvironmentRecord::myWaterCurrentSpeed
protected
float makArchives::DtEnvironmentRecord::myWaterCurrentDirection
protected
float makArchives::DtEnvironmentRecord::myTidalOffset
protected
bool makArchives::DtEnvironmentRecord::myTidalDirection
protected
float makArchives::DtEnvironmentRecord::myFogHeight
protected
DtColorRecord makArchives::DtEnvironmentRecord::myFogColor
protected
ThermoclineRecordList makArchives::DtEnvironmentRecord::myThermoclineRecordList
protected
bool makArchives::DtEnvironmentRecord::myUseCustomCloudCover
protected
OptionalParameterMap makArchives::DtEnvironmentRecord::myOptionalParameters
protected
bool makArchives::DtEnvironmentRecord::myPrecipitationEnabledFlag
protected
std::string makArchives::DtEnvironmentRecord::myPrecipitationType
protected
bool makArchives::DtEnvironmentRecord::myUnderwaterVisibilityEnabled
protected
float makArchives::DtEnvironmentRecord::myGroundSnowAccumulation
protected
float makArchives::DtEnvironmentRecord::myRoadSnowAccumulation
protected
float makArchives::DtEnvironmentRecord::mySnowMinimumElevation
protected
float makArchives::DtEnvironmentRecord::mySnowElevationTransition
protected
float makArchives::DtEnvironmentRecord::myGroundRainAccumulation
protected
float makArchives::DtEnvironmentRecord::myAirPressure
protected
float makArchives::DtEnvironmentRecord::myAirPressureAltitude
protected
float makArchives::DtEnvironmentRecord::myAirTemperatureAltitude
protected
bool makArchives::DtEnvironmentRecord::myAirPressureAltitudeIsSeaLevel
protected
bool makArchives::DtEnvironmentRecord::myAirTemperatureAltitudeIsSeaLevel
protected
float makArchives::DtEnvironmentRecord::mySeaLevelWaterConcentration
protected

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

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)