makArchives::DtEnvironmentRecord Class Reference

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

Classes
class	DtColorRecord
	Record of color settings. More...
class	DtThermoclineRecord
	Record of thermocline settings. More...

Public Types
typedef std::vector < DtCloudLayerRecord >	CloudLayerRecordList
typedef std::vector < DtThermoclineRecord >	ThermoclineRecordList
typedef std::map< std::string, std::string >	OptionalParameterMap

Public Member Functions
	DtEnvironmentRecord ()
	CTOR.
	DtEnvironmentRecord (const DtEnvironmentRecord &orig)
	Copy CTOR.
virtual	~DtEnvironmentRecord ()
	DTOR.
void	swap (DtEnvironmentRecord &other)
	Swap data from this object with another.
DtEnvironmentRecord &	operator= (DtEnvironmentRecord rhs)
	Assignment Operator.
void	setEnvironmentName (const std::string &name)
const std::string &	environmentName () 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
CloudLayerRecordList &	customCloudLayers ()
const CloudLayerRecordList &	customCloudLayers () const
void	setCloudCoverType (DtVrfWeatherCloudState cloudCoverType)
DtVrfWeatherCloudState	cloudCoverType () const
void	setUseCustomCloudCover (bool enabled)
bool	useCustomCloudCover () const
void	setWindSpeed (float metersPerSecond)
float	windSpeed () const
void	setWindDirection (float radiansFromNorth)
float	windDirection () const
void	setAmbientAirTemperature (float celsius)
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 celsius)
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 DtColorRecord &	fogColor () 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
virtual const std::string *	findOptionalParameter (const std::string &name) const
virtual void	setOptionalParameter (const std::string &name, const std::string &value)
	Set an optional parameter.
virtual void	setOptionalParameters (const OptionalParameterMap &)
	Set an optional parameters.
virtual void	removeOptionalParameter (const std::string &name)
	Remove an optional parameter.
const OptionalParameterMap &	optionalParameters () const
	Get the optional parameters.

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Protected Attributes
std::string	myEnvironmentName
float	myAirTurbidity
float	myVisibilityDistance
int	myPrecipitation
float	myPrecipitationIntensity
CloudLayerRecordList	myCloudLayers
DtVrfWeatherCloudState	myCloudCoverType
float	myWindSpeed
float	myWindDirection
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

Friends
class	boost::serialization::access

Detailed Description

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

Member Typedef Documentation

typedef std::vector<DtCloudLayerRecord> makArchives::DtEnvironmentRecord::CloudLayerRecordList

typedef std::vector<DtThermoclineRecord> makArchives::DtEnvironmentRecord::ThermoclineRecordList

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

void makArchives::DtEnvironmentRecord::setAirTurbidity

(

float

turbidity

)

Set / Get the air turbidity value

float makArchives::DtEnvironmentRecord::airTurbidity

(

)

const

void makArchives::DtEnvironmentRecord::setVisibleDistance

(

float

distance

)

Set / Get the visible distance.

float makArchives::DtEnvironmentRecord::visibleDistance

(

)

const

void makArchives::DtEnvironmentRecord::setPrecipitation

(

int

type

)

Set / Get the type of precipitation.

int makArchives::DtEnvironmentRecord::precipitation

(

)

const

void makArchives::DtEnvironmentRecord::setPrecipitationIntensity

(

float

intensity

)

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

float makArchives::DtEnvironmentRecord::precipitationIntensity

(

)

const

CloudLayerRecordList& makArchives::DtEnvironmentRecord::customCloudLayers

(

)

Set / Get the the list of custom cloud layers. For future use...

const CloudLayerRecordList& makArchives::DtEnvironmentRecord::customCloudLayers

(

)

const

void makArchives::DtEnvironmentRecord::setCloudCoverType

(

DtVrfWeatherCloudState

cloudCoverType

)

Set / Get the cloud cover name

DtVrfWeatherCloudState makArchives::DtEnvironmentRecord::cloudCoverType

(

)

const

void makArchives::DtEnvironmentRecord::setUseCustomCloudCover

(

bool

enabled

)

Set / get whether custom clouds are used Currently always false. For future use

bool makArchives::DtEnvironmentRecord::useCustomCloudCover

(

)

const

void makArchives::DtEnvironmentRecord::setWindSpeed

(

float

metersPerSecond

)

Set / Get the wind speed in meters per second.

float makArchives::DtEnvironmentRecord::windSpeed

(

)

const

void makArchives::DtEnvironmentRecord::setWindDirection

(

float

radiansFromNorth

)

Set / Get the direction wind blows from in radians from North.

float makArchives::DtEnvironmentRecord::windDirection

(

)

const

void makArchives::DtEnvironmentRecord::setAmbientAirTemperature

(

float

celsius

)

Set / Get the ambient air temperature in degrees celsius.

float makArchives::DtEnvironmentRecord::ambientAirTemperature

(

)

const

void makArchives::DtEnvironmentRecord::setSeaState

(

int

douglasScale

)

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

int makArchives::DtEnvironmentRecord::seaState

(

)

const

void makArchives::DtEnvironmentRecord::setSeaStateDirection

(

float

radiansFromNorth

)

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

float makArchives::DtEnvironmentRecord::seaStateDirection

(

)

const

void makArchives::DtEnvironmentRecord::setWindDrivenSeaStateEnabled

(

bool

enabled

)

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

bool makArchives::DtEnvironmentRecord::windDrivenSeaStateEnabled

(

)

const

void makArchives::DtEnvironmentRecord::setSwellState

(

int

douglasScale

)

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

int makArchives::DtEnvironmentRecord::swellState

(

)

const

void makArchives::DtEnvironmentRecord::setSwellStateDirection

(

float

radiansFromNorth

)

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

float makArchives::DtEnvironmentRecord::swellStateDirection

(

)

const

void makArchives::DtEnvironmentRecord::setWindFetch

(

float

meters

)

Set / Get the ocean fetch in distance.

float makArchives::DtEnvironmentRecord::windFetch

(

)

const

void makArchives::DtEnvironmentRecord::setSeaChoppiness

(

float

chop

)

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

float makArchives::DtEnvironmentRecord::seaChoppiness

(

)

const

void makArchives::DtEnvironmentRecord::setUnderwaterVisibilityEnabled

(

bool

enabled

)

Set / Get underwater visibility enabled.

bool makArchives::DtEnvironmentRecord::underwaterVisibilityEnabled

(

)

const

void makArchives::DtEnvironmentRecord::setUnderwaterVisibility

(

float

meters

)

Set / Get the underwater visibility in distance.

float makArchives::DtEnvironmentRecord::underwaterVisibility

(

)

const

void makArchives::DtEnvironmentRecord::setSurfaceTransparency

(

float

normalizedValue

)

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

float makArchives::DtEnvironmentRecord::surfaceTransparency

(

)

const

void makArchives::DtEnvironmentRecord::setSurgeDepth

(

float

meters

)

Set / Get the surge depth in distance.

float makArchives::DtEnvironmentRecord::surgeDepth

(

)

const

void makArchives::DtEnvironmentRecord::setDepthOffset

(

float

meters

)

Set / Get the depth offset in distance.

float makArchives::DtEnvironmentRecord::depthOffset

(

)

const

void makArchives::DtEnvironmentRecord::setAmbientWaterTemperature

(

float

celsius

)

Set / Get the ambient water temperature in degrees celsius.

float makArchives::DtEnvironmentRecord::ambientWaterTemperature

(

)

const

void makArchives::DtEnvironmentRecord::setWaterCurrentSpeed

(

float

metersPerSecond

)

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

float makArchives::DtEnvironmentRecord::waterCurrentSpeed

(

)

const

void makArchives::DtEnvironmentRecord::setWaterCurrentDirection

(

float

radiansFromNorth

)

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

float makArchives::DtEnvironmentRecord::waterCurrentDirection

(

)

const

void makArchives::DtEnvironmentRecord::setTidalOffset

(

float

meters

)

Set / Get the tidal offset in distance.

float makArchives::DtEnvironmentRecord::tidalOffset

(

)

const

void makArchives::DtEnvironmentRecord::setTidalDirection

(

bool

inOut

)

Set / Get the tidal direction flag

bool makArchives::DtEnvironmentRecord::tidalDirection

(

)

const

void makArchives::DtEnvironmentRecord::setFogHeight

(

float

meters

)

Set / Get the fog height in distance.

float makArchives::DtEnvironmentRecord::fogHeight

(

)

const

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

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

Set / Get a thermocline data.

DtThermoclineRecord makArchives::DtEnvironmentRecord::thermoclineRecord

(

unsigned int

index

)

const

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

float makArchives::DtEnvironmentRecord::thermoclineDepth

(

unsigned int

index

)

const

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

float makArchives::DtEnvironmentRecord::thermoclinePermeability

(

unsigned int

index

)

const

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.

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

float makArchives::DtEnvironmentRecord::myAirTurbidity

protected

float makArchives::DtEnvironmentRecord::myVisibilityDistance

protected

int makArchives::DtEnvironmentRecord::myPrecipitation

protected

float makArchives::DtEnvironmentRecord::myPrecipitationIntensity

protected

CloudLayerRecordList makArchives::DtEnvironmentRecord::myCloudLayers

protected

DtVrfWeatherCloudState makArchives::DtEnvironmentRecord::myCloudCoverType

protected

float makArchives::DtEnvironmentRecord::myWindSpeed

protected

float makArchives::DtEnvironmentRecord::myWindDirection

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

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/makArchives/DtEnvironmentRecord.h