DtGlobalEnvironmentStateRepository Class Reference

This repository holds all information that is common to all the forms of all objects within VR-Forces that can move. More...

Inheritance diagram for DtGlobalEnvironmentStateRepository:

List of all members.

Public Member Functions
	DtGlobalEnvironmentStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtGlobalEnvironmentStateRepository (const DtGlobalEnvironmentStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Copy Constructor.
DtGlobalEnvironmentStateRepository &	operator= (const DtGlobalEnvironmentStateRepository &orig)
	Assignment Operator.
virtual	~DtGlobalEnvironmentStateRepository ()
	Destructor.
virtual void	resetToDefaults ()
	Called by the constructor to initialize all environment values.
virtual DtSimObjectStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	Clone.
virtual DtString	type () const
	returns DtSimObjectStateRepositoryType
virtual bool	createParameters ()
virtual void	initializeFromParameters ()
virtual const DtGlobalEnvironmentParameters *	globalEnvironmentParameters () const
virtual void	setAirTurbidity (double value)
	See #myAirTurbidiry.
virtual double	airTurbidity () const
	See #myAirTurbidiry.
virtual void	setCloudState (DtVrfWeatherCloudState current)
	See myCloudState.
virtual DtVrfWeatherCloudState	cloudState () const
	See myCloudState.
virtual void	setPrecipitationIntensity (double value)
	See myPrecipitationIntensity.
virtual double	precipitationIntensity () const
	See myPrecipitationIntensity.
virtual void	setPrecipitationType (DtVrfWeatherPrecipitationType value)
	See myPrecipitationType.
virtual DtVrfWeatherPrecipitationType	precipitationType () const
	See myPrecipitationType.
virtual void	setWindSpeed (double value)
	See myWindSpeed.
virtual double	windSpeed () const
	See myWindSpeed.
virtual void	setWindDirection (double value)
	See myWindDirection.
virtual double	windDirection () const
	See myWindDirection.
virtual void	setVisibility (double value)
	See myVisibility.
virtual double	visibility () const
	See myVisibility.
virtual void	setIllumination (double value)
	See #myIllumination.
virtual double	illumination () const
	See #myIllumination.
virtual void	setTimeOfDay (double value)
	See myTimeOfDay.
virtual double	timeOfDay () const
	See myTimeOfDay.
virtual DtString	timeOfDayString () const
virtual void	setTimeOfDayAdvancementSpeed (double value)
virtual double	timeOfDayAdvancementSpeed () const
Static Public Member Functions
static DtVrfObjectStateRepository *	creator (const DtString &name, DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry)
static DtGlobalEnvironmentStateRepository *	isGlobalEnvironmentStateRepository (DtSimObjectStateRepository *repository)
Protected Attributes
parameters
These parameters are available for setting in the physicalWorldParams.
DtRwReal	myAirTurbidity
	Parameter Name: air-turbidity Parameter Description: Turbidity of the air Default Value: 0.0.
DtRwInt	myCloudState
	Parameter Name: cloud-state Parameter Description: A string describing the cloud state Clear, Mostly Clear, Cloudy, Partly Cloudy, Mostly Cloudy Default Value: DtVrfWeatherCloudStateClear.
DtRwReal	myPrecipitationIntensity
	Parameter Name: precipitation-intensity Parameter Description: Precipitation intensity Default Value: 0.0.
DtRwInt	myPrecipitationType
	Parameter Name: precipitation-type Parameter Description: A string describing the type of precipitation None, Snow, or Rain Default Value: DtVrfWeatherPrecipitationNone.
DtRwReal	myWindSpeed
	Parameter Name: wind-speed Parameter Description: Speed of the wind Default Value: 0.0 Units: meters/second.
DtRwReal	myWindDirection
	Parameter Name: wind-direction Parameter Description: Indicates what direction the wind is blowing from Default Value: 0.0 Units: radians.
DtRwReal	myIlluminationPercentage
	Parameter Name: percent-illumination Parameter Description: Indicates the percentage of illumination Default Value: 100.0 --Full illumination.
DtRwReal	myTimeOfDay
	Numerical representation in seconds from midnight which is 0.
DtRwReal	myTimeOfDayAdvancementSpeed
	Parameter Name: time-of-day-advancement-speed Parameter Description: Indicates the rate that time of day is advancing.
DtRwReal	myVisibility
	Parameter Name: visibility Parameter Description: How far one can see and still distinguish things Default Value: Units: meters.
Private Member Functions
	DtGlobalEnvironmentStateRepository ()
	Default Constructor. Do not use.

---

Detailed Description

This repository holds all information that is common to all the forms of all objects within VR-Forces that can move.

---

Constructor & Destructor Documentation

DtGlobalEnvironmentStateRepository::DtGlobalEnvironmentStateRepository	(	DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Constructor.

DtGlobalEnvironmentStateRepository::DtGlobalEnvironmentStateRepository	(	const DtGlobalEnvironmentStateRepository &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Copy Constructor.

virtual DtGlobalEnvironmentStateRepository::~DtGlobalEnvironmentStateRepository

(

)

[virtual]

Destructor.

DtGlobalEnvironmentStateRepository::DtGlobalEnvironmentStateRepository

(

)

[private]

Default Constructor. Do not use.

---

Member Function Documentation

DtGlobalEnvironmentStateRepository& DtGlobalEnvironmentStateRepository::operator=

(

const DtGlobalEnvironmentStateRepository &

orig

)

Assignment Operator.

virtual void DtGlobalEnvironmentStateRepository::resetToDefaults

(

)

[virtual]

Called by the constructor to initialize all environment values.

Also used by the DtEnvironmentalStateManager::processObjectRemoved to reset all values when the scenario is closed.

static DtVrfObjectStateRepository* DtGlobalEnvironmentStateRepository::creator	(	const DtString &	name,
		DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		DtReaderWriterRegistry *	parentRegistry
	)		[static]

Reimplemented from DtVrfObjectStateRepository.

static DtGlobalEnvironmentStateRepository* DtGlobalEnvironmentStateRepository::isGlobalEnvironmentStateRepository

(

DtSimObjectStateRepository *

repository

)

[static]

virtual DtSimObjectStateRepository* DtGlobalEnvironmentStateRepository::clone	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Clone.

Reimplemented from DtVrfObjectStateRepository.

virtual DtString DtGlobalEnvironmentStateRepository::type

(

)

const [virtual]

returns DtSimObjectStateRepositoryType

Reimplemented from DtVrfObjectStateRepository.

virtual bool DtGlobalEnvironmentStateRepository::createParameters

(

)

[virtual]

Reimplemented from DtVrfObjectStateRepository.

virtual void DtGlobalEnvironmentStateRepository::initializeFromParameters

(

)

[virtual]

Reimplemented from DtVrfObjectStateRepository.

virtual const DtGlobalEnvironmentParameters* DtGlobalEnvironmentStateRepository::globalEnvironmentParameters

(

)

const [virtual]

virtual void DtGlobalEnvironmentStateRepository::setAirTurbidity

(

double

value

)

[virtual]

See #myAirTurbidiry.

virtual double DtGlobalEnvironmentStateRepository::airTurbidity

(

)

const [virtual]

See #myAirTurbidiry.

virtual void DtGlobalEnvironmentStateRepository::setCloudState

(

DtVrfWeatherCloudState

current

)

[virtual]

See myCloudState.

virtual DtVrfWeatherCloudState DtGlobalEnvironmentStateRepository::cloudState

(

)

const [virtual]

See myCloudState.

virtual void DtGlobalEnvironmentStateRepository::setPrecipitationIntensity

(

double

value

)

[virtual]

See myPrecipitationIntensity.

virtual double DtGlobalEnvironmentStateRepository::precipitationIntensity

(

)

const [virtual]

See myPrecipitationIntensity.

virtual void DtGlobalEnvironmentStateRepository::setPrecipitationType

(

DtVrfWeatherPrecipitationType

value

)

[virtual]

See myPrecipitationType.

virtual DtVrfWeatherPrecipitationType DtGlobalEnvironmentStateRepository::precipitationType

(

)

const [virtual]

See myPrecipitationType.

virtual void DtGlobalEnvironmentStateRepository::setWindSpeed

(

double

value

)

[virtual]

See myWindSpeed.

virtual double DtGlobalEnvironmentStateRepository::windSpeed

(

)

const [virtual]

See myWindSpeed.

virtual void DtGlobalEnvironmentStateRepository::setWindDirection

(

double

value

)

[virtual]

See myWindDirection.

virtual double DtGlobalEnvironmentStateRepository::windDirection

(

)

const [virtual]

See myWindDirection.

virtual void DtGlobalEnvironmentStateRepository::setVisibility

(

double

value

)

[virtual]

See myVisibility.

virtual double DtGlobalEnvironmentStateRepository::visibility

(

)

const [virtual]

See myVisibility.

virtual void DtGlobalEnvironmentStateRepository::setIllumination

(

double

value

)

[virtual]

See #myIllumination.

virtual double DtGlobalEnvironmentStateRepository::illumination

(

)

const [virtual]

See #myIllumination.

virtual void DtGlobalEnvironmentStateRepository::setTimeOfDay

(

double

value

)

[virtual]

See myTimeOfDay.

Will wrap the input value into the valid 0:0:0 - 23:59:59 range for this value.

virtual double DtGlobalEnvironmentStateRepository::timeOfDay

(

)

const [virtual]

See myTimeOfDay.

Will wrap the input value into the valid 0:0:0 - 23:59:59 range for this value.

virtual DtString DtGlobalEnvironmentStateRepository::timeOfDayString

(

)

const [virtual]

Returns:

Time of Day in string form, in the format hh:mm:ss

virtual void DtGlobalEnvironmentStateRepository::setTimeOfDayAdvancementSpeed

(

double

value

)

[virtual]

See also:

myTimeOfDayAdvancementSpeed

virtual double DtGlobalEnvironmentStateRepository::timeOfDayAdvancementSpeed

(

)

const [virtual]

See also:

myTimeOfDayAdvancementSpeed

---

Member Data Documentation

DtRwReal DtGlobalEnvironmentStateRepository::myAirTurbidity [protected]

Parameter Name: air-turbidity
Parameter Description: Turbidity of the air Default Value: 0.0.

DtRwInt DtGlobalEnvironmentStateRepository::myCloudState [protected]

Parameter Name: cloud-state
Parameter Description: A string describing the cloud state Clear, Mostly Clear, Cloudy, Partly Cloudy, Mostly Cloudy Default Value: DtVrfWeatherCloudStateClear.

DtRwReal DtGlobalEnvironmentStateRepository::myPrecipitationIntensity [protected]

Parameter Name: precipitation-intensity
Parameter Description: Precipitation intensity Default Value: 0.0.

DtRwInt DtGlobalEnvironmentStateRepository::myPrecipitationType [protected]

Parameter Name: precipitation-type
Parameter Description: A string describing the type of precipitation None, Snow, or Rain Default Value: DtVrfWeatherPrecipitationNone.

DtRwReal DtGlobalEnvironmentStateRepository::myWindSpeed [protected]

Parameter Name: wind-speed
Parameter Description: Speed of the wind Default Value: 0.0 Units: meters/second.

DtRwReal DtGlobalEnvironmentStateRepository::myWindDirection [protected]

Parameter Name: wind-direction
Parameter Description: Indicates what direction the wind is blowing from
Default Value: 0.0 Units: radians.

DtRwReal DtGlobalEnvironmentStateRepository::myIlluminationPercentage [protected]

Parameter Name: percent-illumination
Parameter Description: Indicates the percentage of illumination
Default Value: 100.0 --Full illumination.

DtRwReal DtGlobalEnvironmentStateRepository::myTimeOfDay [protected]

Numerical representation in seconds from midnight which is 0.

DtRwReal DtGlobalEnvironmentStateRepository::myTimeOfDayAdvancementSpeed [protected]

Parameter Name: time-of-day-advancement-speed
Parameter Description: Indicates the rate that time of day is advancing.

Default Value: 1.0 Units: time of day seconds per sim time seconds.

DtRwReal DtGlobalEnvironmentStateRepository::myVisibility [protected]

Parameter Name: visibility
Parameter Description: How far one can see and still distinguish things
Default Value: Units: meters.

---

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

• include/vrfobjcore/globalEnvironmentSR.h