makArchives::DtEnvironmentRecord Class Reference

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

Public Types
typedef std::vector < DtCloudLayerRecord >	CloudLayerRecordList

Public Member Functions
	DtEnvironmentRecord ()
	CTOR.
	DtEnvironmentRecord (const DtEnvironmentRecord &orig)
	Copy CTOR.
DtEnvironmentRecord &	operator= (DtEnvironmentRecord orig)
	Assignment OP.
	~DtEnvironmentRecord ()
	DTOR.
void	swap (DtEnvironmentRecord &other)
	Swap data from this object with another.
void	setAirTurbidity (float turbidity)
float	airTurbidity () const
void	setVisibleDistance (float distance)
float	visibleDistance () const
void	setPrecipitationEnabled (bool enabled)
bool	precipitationEnabled () const
void	setPrecipitationType (const std::string &type)
const std::string &	precipitationType () const
void	setPrecipitationIntensity (float intensity)
float	precipitationIntensity () const
CloudLayerRecordList &	cloudLayers ()
const CloudLayerRecordList &	cloudLayers () 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 beaufortScale)
int	seaState () const
void	setSeaChoppiness (float chop)
float	seaChoppiness () const
void	setUnderwaterVisibility (float distanceInMeters)
float	underwaterVisibility () 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

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
float	myAirTurbidity
float	myVisibilityDistance
bool	myPrecipitationEnabledFlag
std::string	myPrecipitationType
float	myPrecipitationIntensity
CloudLayerRecordList	myCloudLayers
float	myWindSpeed
float	myWindDirection
float	myAmbientAirTemperature
int	mySeaState
float	mySeaChoppiness
float	myUnderwaterVisibility
float	myAmbientWaterTemperature
float	myWaterCurrentSpeed
float	myWaterCurrentDirection
float	myTidalOffset
bool	myTidalDirection

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

Constructor & Destructor Documentation

makArchives::DtEnvironmentRecord::DtEnvironmentRecord

(

)

CTOR.

makArchives::DtEnvironmentRecord::DtEnvironmentRecord

(

const DtEnvironmentRecord &

orig

)

Copy CTOR.

makArchives::DtEnvironmentRecord::~DtEnvironmentRecord

(

)

DTOR.

Member Function Documentation

DtEnvironmentRecord& makArchives::DtEnvironmentRecord::operator=

(

DtEnvironmentRecord

orig

)

Assignment OP.

void makArchives::DtEnvironmentRecord::swap

(

DtEnvironmentRecord &

other

)

Swap data from this object with another.

void makArchives::DtEnvironmentRecord::setAirTurbidity

(

float

turbidity

)

float makArchives::DtEnvironmentRecord::airTurbidity

(

)

const

void makArchives::DtEnvironmentRecord::setVisibleDistance

(

float

distance

)

float makArchives::DtEnvironmentRecord::visibleDistance

(

)

const

void makArchives::DtEnvironmentRecord::setPrecipitationEnabled

(

bool

enabled

)

bool makArchives::DtEnvironmentRecord::precipitationEnabled

(

)

const

void makArchives::DtEnvironmentRecord::setPrecipitationType

(

const std::string &

type

)

const std::string& makArchives::DtEnvironmentRecord::precipitationType

(

)

const

void makArchives::DtEnvironmentRecord::setPrecipitationIntensity

(

float

intensity

)

float makArchives::DtEnvironmentRecord::precipitationIntensity

(

)

const

CloudLayerRecordList& makArchives::DtEnvironmentRecord::cloudLayers

(

)

const CloudLayerRecordList& makArchives::DtEnvironmentRecord::cloudLayers

(

)

const

void makArchives::DtEnvironmentRecord::setWindSpeed

(

float

metersPerSecond

)

float makArchives::DtEnvironmentRecord::windSpeed

(

)

const

void makArchives::DtEnvironmentRecord::setWindDirection

(

float

radiansFromNorth

)

float makArchives::DtEnvironmentRecord::windDirection

(

)

const

void makArchives::DtEnvironmentRecord::setAmbientAirTemperature

(

float

celsius

)

float makArchives::DtEnvironmentRecord::ambientAirTemperature

(

)

const

void makArchives::DtEnvironmentRecord::setSeaState

(

int

beaufortScale

)

int makArchives::DtEnvironmentRecord::seaState

(

)

const

void makArchives::DtEnvironmentRecord::setSeaChoppiness

(

float

chop

)

float makArchives::DtEnvironmentRecord::seaChoppiness

(

)

const

void makArchives::DtEnvironmentRecord::setUnderwaterVisibility

(

float

distanceInMeters

)

float makArchives::DtEnvironmentRecord::underwaterVisibility

(

)

const

void makArchives::DtEnvironmentRecord::setAmbientWaterTemperature

(

float

celsius

)

float makArchives::DtEnvironmentRecord::ambientWaterTemperature

(

)

const

void makArchives::DtEnvironmentRecord::setWaterCurrentSpeed

(

float

metersPerSecond

)

float makArchives::DtEnvironmentRecord::waterCurrentSpeed

(

)

const

void makArchives::DtEnvironmentRecord::setWaterCurrentDirection

(

float

radiansFromNorth

)

float makArchives::DtEnvironmentRecord::waterCurrentDirection

(

)

const

void makArchives::DtEnvironmentRecord::setTidalOffset

(

float

meters

)

float makArchives::DtEnvironmentRecord::tidalOffset

(

)

const

void makArchives::DtEnvironmentRecord::setTidalDirection

(

bool

inOut

)

bool makArchives::DtEnvironmentRecord::tidalDirection

(

)

const

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

float makArchives::DtEnvironmentRecord::myAirTurbidity

protected

float makArchives::DtEnvironmentRecord::myVisibilityDistance

protected

bool makArchives::DtEnvironmentRecord::myPrecipitationEnabledFlag

protected

std::string makArchives::DtEnvironmentRecord::myPrecipitationType

protected

float makArchives::DtEnvironmentRecord::myPrecipitationIntensity

protected

CloudLayerRecordList makArchives::DtEnvironmentRecord::myCloudLayers

protected

float makArchives::DtEnvironmentRecord::myWindSpeed

protected

float makArchives::DtEnvironmentRecord::myWindDirection

protected

float makArchives::DtEnvironmentRecord::myAmbientAirTemperature

protected

int makArchives::DtEnvironmentRecord::mySeaState

protected

float makArchives::DtEnvironmentRecord::mySeaChoppiness

protected

float makArchives::DtEnvironmentRecord::myUnderwaterVisibility

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

---

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

• include/makArchives/DtEnvironmentRecord.h