DtEnvironmentalStateManager Class Reference

Handles the environmental state of the simulation. More...

Public Member Functions
	DtEnvironmentalStateManager (DtSimManager *simManager)
	constructor
virtual	~DtEnvironmentalStateManager ()
	destructor
virtual bool	init ()
virtual void	tick ()
virtual DtSimManager *	simManager ()
virtual bool	globalEnvironmentSimulatedLocally () const
virtual bool	startEnvironmentSimulationLocally ()
	Starts simulating the global environment locally on this simulation engine.
virtual DtVrfObject *	weatherObjectFor (const DtString &="") const
	Returns the weather object given the specified name (if blank uses global weather)
virtual DtVrfObject *	weatherObjectFor (const DtVector &localPosition) const
	Returns the weather object of the highest priority at the given location.
virtual DtVrfObject *	weatherObjectFor (const DtChord &localChord) const
	Returns the weather object of the first area hit by this chord.
virtual std::vector < DtVrfObject * >	weatherObjectsFor (const DtChord &localChord) const
	Returns all weather objects that are intersected by this chord.
virtual void	setWeatherState (const DtChangeWeatherCommand &command)
	Calls the appropriate setXXX() functions locally, depending on what is in the command.
virtual void	setUseDayNightIlluminationModel (const DtChangeTimeOfDayCommand &command)
	The current time of day, specified by the number of seconds passed midnight.
virtual void	setDateAndTimeOfDay (double secondsPastMidnight)
virtual void	setDateAndTimeOfDay (const DtChangeTimeOfDayCommand &command)
virtual double	timeOfDay () const
virtual double	dateAndTimeOfDay () const
virtual void	setTimeOfDayAdvancementSpeed (double speed)
	The current time of day advancement speed.
virtual void	setTimeOfDayAdvancementSpeed (const DtChangeTimeOfDayCommand &command)
virtual double	timeOfDayAdvancementSpeed () const
virtual DtObjectType	globalEnvironmentObjectType () const
virtual void	setAirTurbidity (double factor, const DtString &weatherArea="")
	Individual Environmental effects accessors Air Turbidity.
virtual double	airTurbidity (const DtString &weatherArea) const
	Individual Environmental effects accessors Air Turbidity.
virtual double	airTurbidity (const DtVector &) const
	Individual Environmental effects accessors Air Turbidity.
virtual void	setAmbientAirTemperature (double temp, const DtString &weatherArea="")
	Ambient Air Temperature (in celsius)
virtual double	ambientAirTemperature (const DtString &weatherArea) const
	Ambient Air Temperature (in celsius)
virtual double	ambientAirTemperature (const DtVector &) const
	Ambient Air Temperature (in celsius)
virtual void	setCloudState (DtVrfWeatherCloudState current, const DtString &weatherArea="")
	Cloud state enumeration.
virtual DtVrfWeatherCloudState	cloudState (const DtString &weatherArea) const
	Cloud state enumeration.
virtual DtVrfWeatherCloudState	cloudState (const DtVector &) const
	Cloud state enumeration.
virtual void	setPrecipitationIntensity (double factor, const DtString &weatherArea="")
	Precipitation Intensity.
virtual double	precipitationIntensity (const DtString &weatherArea) const
	Precipitation Intensity.
virtual double	precipitationIntensity (const DtVector &) const
	Precipitation Intensity.
virtual void	setPrecipitationType (DtVrfWeatherPrecipitationType current, const DtString &weatherArea="")
	Weather state enumeration.
virtual DtVrfWeatherPrecipitationType	precipitationType (const DtString &weatherArea) const
	Weather state enumeration.
virtual DtVrfWeatherPrecipitationType	precipitationType (const DtVector &) const
	Weather state enumeration.
virtual void	setWindSpeed (double value, const DtString &weatherArea="")
	Wind speed in m/s.
virtual double	windSpeed (const DtString &weatherArea) const
	Wind speed in m/s.
virtual double	windSpeed (const DtVector &) const
	Wind speed in m/s.
virtual void	setWindDirection (double value, const DtString &weatherArea="")
	Wind direction in radians.
virtual double	windDirection (const DtString &weatherArea) const
	Wind direction in radians.
virtual double	windDirection (const DtVector &) const
	Wind direction in radians.
virtual void	setVisibility (double value, const DtString &weatherArea="")
	Visibility in meters.
virtual double	visibility (const DtString &weatherArea) const
	Visibility in meters.
virtual double	visibility (const DtVector &) const
	Visibility in meters.
virtual double	visibility (const DtChord &) const
	Supply a chord in local coordinates – this will get the visibility through a particular weather area or simply use global if it crosses no area.
virtual double	illumination (const DtVector &localPosition) const
	Illumination in percentage (0 to 1.0) at a particular location.
virtual void	setPriority (int p, const DtString &weatherArea="")
	Sets the priority of the weather area. This value is not used for global weather.
virtual int	priority (const DtString &weatherArea) const
	Sets the priority of the weather area. This value is not used for global weather.
virtual int	priority (const DtVector &) const
	Sets the priority of the weather area. This value is not used for global weather.
virtual void	setUnderwaterVisibility (double underwaterVisibility, const DtString &weatherArea="")
	Underwater visibility in meters.
virtual double	underwaterVisibility (const DtString &weatherArea) const
	Underwater visibility in meters.
virtual double	underwaterVisibility (const DtVector &) const
	Underwater visibility in meters.
virtual void	setSurfaceTransparency (double transparency, const DtString &weatherArea="")
	Surface transparency (percentage)
virtual double	surfaceTransparency (const DtString &weatherArea) const
	Surface transparency (percentage)
virtual double	surfaceTransparency (const DtVector &) const
	Surface transparency (percentage)
virtual void	setWaterCurrentSpeed (double waterCurrentSpeed, const DtString &weatherArea="")
	Water velocity in meters per second.
virtual double	waterCurrentSpeed (const DtString &weatherArea) const
	Water velocity in meters per second.
virtual double	waterCurrentSpeed (const DtVector &) const
	Water velocity in meters per second.
virtual void	setWaterCurrentDirection (double waterCurrentDirection, const DtString &weatherArea="")
	Water direction in radians clockwise from 0 (north)
virtual double	waterCurrentDirection (const DtString &weatherArea) const
	Water direction in radians clockwise from 0 (north)
virtual double	waterCurrentDirection (const DtVector &) const
	Water direction in radians clockwise from 0 (north)
virtual void	setAmbientWaterTemperature (double waterTemperature, const DtString &weatherArea="")
	Ambient water temperature in Celsius.
virtual double	ambientWaterTemperature (const DtString &weatherArea) const
	Ambient water temperature in Celsius.
virtual double	ambientWaterTemperature (const DtVector &) const
	Ambient water temperature in Celsius.
virtual void	setTidalOffset (double tidalOffset, const DtString &weatherArea="")
	Tidal offset in meters from the water polygons in the database.
virtual double	tidalOffset (const DtString &weatherArea) const
	Tidal offset in meters from the water polygons in the database.
virtual double	tidalOffset (const DtVector &) const
	Tidal offset in meters from the water polygons in the database.
virtual void	setUseDayNightIlluminationModel (bool)
	If false uses GMT as the position of sunrise/sunset (default) rather than entity position.
virtual bool	useDayNightIlluminationModel () const
	If false uses GMT as the position of sunrise/sunset (default) rather than entity position.
virtual void	setTidalDirection (bool tidalDirection, const DtString &weatherArea="")
	Tidal direction where true represents the tide going in and false represents the tide going out.
virtual bool	tidalDirection (const DtString &weatherArea) const
	Tidal direction where true represents the tide going in and false represents the tide going out.
virtual bool	tidalDirection (const DtVector &) const
	Tidal direction where true represents the tide going in and false represents the tide going out.
virtual void	setSwellState (unsigned int state, const DtString &weatherArea="")
	Swell state according to the Douglas Sea Scale (integer 0 - 9)
virtual unsigned int	swellState (const DtString &weatherArea) const
	Swell state according to the Douglas Sea Scale (integer 0 - 9)
virtual unsigned int	swellState (const DtVector &) const
	Swell state according to the Douglas Sea Scale (integer 0 - 9)
virtual void	setSwellStateDirection (double direction, const DtString &weatherArea="")
	Swell direction in in radians clockwise from 0 (north)
virtual double	swellStateDirection (const DtString &weatherArea) const
	Swell direction in in radians clockwise from 0 (north)
virtual double	swellStateDirection (const DtVector &) const
	Swell direction in in radians clockwise from 0 (north)
virtual void	setSeaState (unsigned int state, const DtString &weatherArea="")
	Swell state according to the Douglas Sea Scale (integer 0 - 9)
virtual unsigned int	seaState (const DtString &weatherArea) const
	Swell state according to the Douglas Sea Scale (integer 0 - 9)
virtual unsigned int	seaState (const DtVector &) const
	Swell state according to the Douglas Sea Scale (integer 0 - 9)
virtual void	setSeaStateDirection (double direction, const DtString &weatherArea="")
	Swell direction in in radians clockwise from 0 (north)
virtual double	seaStateDirection (const DtString &weatherArea) const
	Swell direction in in radians clockwise from 0 (north)
virtual double	seaStateDirection (const DtVector &) const
	Swell direction in in radians clockwise from 0 (north)
virtual void	setWindDrivenSeaStateEnabled (bool b, const DtString &weatherArea="")
	Determines if the sea state is set based on the wind.
virtual bool	windDrivenSeaStateEnabled (const DtString &weatherArea) const
	Determines if the sea state is set based on the wind.
virtual bool	windDrivenSeaStateEnabled (const DtVector &) const
	Determines if the sea state is set based on the wind.
virtual void	setChoppiness (double choppiness, const DtString &weatherArea="")
	Wave choppiness (0..1)
virtual double	choppiness (const DtString &weatherArea) const
	Wave choppiness (0..1)
virtual double	choppiness (const DtVector &) const
	Wave choppiness (0..1)
virtual void	setSurgeDepth (double depth, const DtString &weatherArea="")
	Surge depth (meters)
virtual double	surgeDepth (const DtString &weatherArea) const
	Surge depth (meters)
virtual double	surgeDepth (const DtVector &) const
	Surge depth (meters)
virtual void	setThermoclineLayer1Depth (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer1Depth (const DtString &weatherArea) const
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer1Depth (const DtVector &) const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer1Permeability (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer1Permeability (const DtString &weatherArea) const
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer1Permeability (const DtVector &) const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer2Depth (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer2Depth (const DtString &weatherArea) const
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer2Depth (const DtVector &) const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer2Permeability (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer2Permeability (const DtString &weatherArea) const
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer2Permeability (const DtVector &) const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer3Depth (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer3Depth (const DtString &weatherArea) const
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer3Depth (const DtVector &) const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer3Permeability (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer3Permeability (const DtString &weatherArea) const
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer3Permeability (const DtVector &) const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer4Depth (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer4Depth (const DtString &weatherArea) const
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer4Depth (const DtVector &) const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer4Permeability (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer4Permeability (const DtString &weatherArea) const
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer4Permeability (const DtVector &) const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer5Depth (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer5Depth (const DtString &weatherArea) const
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer5Depth (const DtVector &) const
	Thermocline depth (in meters) and permeability (0..1).
virtual void	setThermoclineLayer5Permeability (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer5Permeability (const DtString &weatherArea) const
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer5Permeability (const DtVector &) const
	Thermocline depth (in meters) and permeability (0..1).

Protected Member Functions
virtual void	processObjectAdded (DtVrfObject *object)
virtual void	processObjectRemoved (DtVrfObject *object)
virtual void	createGlobalEnvironmentObject ()
	Creates a new locally simulated VRF object with the type returned from glovalEnvironmentObjectType().
virtual DtEnvironmentalStateSetter *	createLocalEnvironmentalStateSetter ()
virtual DtEnvironmentalStateSetter *	createRemoteEnvironmentalStateSetter ()
virtual void	processChangeWeatherPriorities (DtSimMessage *msg)

Static Protected Member Functions
static void	objectAddedCallback (DtVrfObject *object, void *usr)
static void	objectRemovedCallback (DtVrfObject *object, void *usr)
static void	changeWeatherPrioritiesCallback (DtSimMessage *msg, void *usr)

Protected Attributes
DtSimManager *	mySimManager
DtVrfObject *	myGlobalEnvironmentObject
std::set< DtVrfObject * >	myWeatherObjects
DtEnvironmentalStateSetter *	myEnvironmentalStateSetter
	This is only for setting global weather – local weather will use local vrf objects.
bool	myFirstTick
DtVector	myLastPointChecked
	For faster access for consecutive lookups given a point.
DtVrfObject *	myLastWeatherByPoint

Private Member Functions
	DtEnvironmentalStateManager (const DtEnvironmentalStateManager &orig)
	Not implemented.
const DtEnvironmentalStateManager &	operator= (const DtEnvironmentalStateManager &orig)
	Not implemented.
	DtEnvironmentalStateManager ()
	Not implemented.

Detailed Description

Handles the environmental state of the simulation.

Currently there is only one environmental state for the whole simulation. This manager provides access to the environmental state and is responsible for updating the environmental state from the network.

As a general rule an empty weatherArea name will return weather for the global area. A vector location of zero() will also return global weather

Constructor & Destructor Documentation

DtEnvironmentalStateManager::DtEnvironmentalStateManager ( const DtEnvironmentalStateManager &  orig )

private

Not implemented.

DtEnvironmentalStateManager::DtEnvironmentalStateManager ( )

private

Not implemented.

DtEnvironmentalStateManager::DtEnvironmentalStateManager

(

DtSimManager *

simManager

)

constructor

virtual DtEnvironmentalStateManager::~DtEnvironmentalStateManager ( )

virtual

destructor

Member Function Documentation

const DtEnvironmentalStateManager& DtEnvironmentalStateManager::operator= ( const DtEnvironmentalStateManager &  orig )

private

Not implemented.

virtual bool DtEnvironmentalStateManager::init ( )

virtual

virtual void DtEnvironmentalStateManager::tick ( )

virtual

virtual DtSimManager* DtEnvironmentalStateManager::simManager ( )

virtual

virtual bool DtEnvironmentalStateManager::globalEnvironmentSimulatedLocally ( ) const

virtual

Returns

True if the global environment is currently being simulated by this simulation engine.

virtual bool DtEnvironmentalStateManager::startEnvironmentSimulationLocally ( )

virtual

Starts simulating the global environment locally on this simulation engine.

Only starts the local simulation if there is not one (remote or local) already running.

Returns

True if successful.

virtual DtVrfObject* DtEnvironmentalStateManager::weatherObjectFor ( const DtString &  = "" ) const

virtual

Returns the weather object given the specified name (if blank uses global weather)

virtual DtVrfObject* DtEnvironmentalStateManager::weatherObjectFor ( const DtVector &  localPosition ) const

virtual

Returns the weather object of the highest priority at the given location.

If no local weather returns global weather

virtual DtVrfObject* DtEnvironmentalStateManager::weatherObjectFor ( const DtChord &  localChord ) const

virtual

Returns the weather object of the first area hit by this chord.

virtual std::vector<DtVrfObject*> DtEnvironmentalStateManager::weatherObjectsFor ( const DtChord &  localChord ) const

virtual

Returns all weather objects that are intersected by this chord.

If none are intersected returns global weather as only object

virtual void DtEnvironmentalStateManager::setAirTurbidity ( double  factor, const DtString &  weatherArea = ""  )

virtual

Individual Environmental effects accessors Air Turbidity.

virtual double DtEnvironmentalStateManager::airTurbidity ( const DtString &  weatherArea ) const

virtual

Individual Environmental effects accessors Air Turbidity.

virtual double DtEnvironmentalStateManager::airTurbidity ( const DtVector &  ) const

virtual

Individual Environmental effects accessors Air Turbidity.

virtual void DtEnvironmentalStateManager::setAmbientAirTemperature ( double  temp, const DtString &  weatherArea = ""  )

virtual

Ambient Air Temperature (in celsius)

virtual double DtEnvironmentalStateManager::ambientAirTemperature ( const DtString &  weatherArea ) const

virtual

Ambient Air Temperature (in celsius)

virtual double DtEnvironmentalStateManager::ambientAirTemperature ( const DtVector &  ) const

virtual

Ambient Air Temperature (in celsius)

virtual void DtEnvironmentalStateManager::setCloudState ( DtVrfWeatherCloudState  current, const DtString &  weatherArea = ""  )

virtual

Cloud state enumeration.

virtual DtVrfWeatherCloudState DtEnvironmentalStateManager::cloudState ( const DtString &  weatherArea ) const

virtual

Cloud state enumeration.

virtual DtVrfWeatherCloudState DtEnvironmentalStateManager::cloudState ( const DtVector &  ) const

virtual

Cloud state enumeration.

virtual void DtEnvironmentalStateManager::setPrecipitationIntensity ( double  factor, const DtString &  weatherArea = ""  )

virtual

Precipitation Intensity.

virtual double DtEnvironmentalStateManager::precipitationIntensity ( const DtString &  weatherArea ) const

virtual

Precipitation Intensity.

virtual double DtEnvironmentalStateManager::precipitationIntensity ( const DtVector &  ) const

virtual

Precipitation Intensity.

virtual void DtEnvironmentalStateManager::setPrecipitationType ( DtVrfWeatherPrecipitationType  current, const DtString &  weatherArea = ""  )

virtual

Weather state enumeration.

virtual DtVrfWeatherPrecipitationType DtEnvironmentalStateManager::precipitationType ( const DtString &  weatherArea ) const

virtual

Weather state enumeration.

virtual DtVrfWeatherPrecipitationType DtEnvironmentalStateManager::precipitationType ( const DtVector &  ) const

virtual

Weather state enumeration.

virtual void DtEnvironmentalStateManager::setWindSpeed ( double  value, const DtString &  weatherArea = ""  )

virtual

Wind speed in m/s.

virtual double DtEnvironmentalStateManager::windSpeed ( const DtString &  weatherArea ) const

virtual

Wind speed in m/s.

virtual double DtEnvironmentalStateManager::windSpeed ( const DtVector &  ) const

virtual

Wind speed in m/s.

virtual void DtEnvironmentalStateManager::setWindDirection ( double  value, const DtString &  weatherArea = ""  )

virtual

Wind direction in radians.

virtual double DtEnvironmentalStateManager::windDirection ( const DtString &  weatherArea ) const

virtual

Wind direction in radians.

virtual double DtEnvironmentalStateManager::windDirection ( const DtVector &  ) const

virtual

Wind direction in radians.

virtual void DtEnvironmentalStateManager::setVisibility ( double  value, const DtString &  weatherArea = ""  )

virtual

Visibility in meters.

virtual double DtEnvironmentalStateManager::visibility ( const DtString &  weatherArea ) const

virtual

Visibility in meters.

virtual double DtEnvironmentalStateManager::visibility ( const DtVector &  ) const

virtual

Visibility in meters.

virtual double DtEnvironmentalStateManager::visibility ( const DtChord &  ) const

virtual

Supply a chord in local coordinates – this will get the visibility through a particular weather area or simply use global if it crosses no area.

virtual double DtEnvironmentalStateManager::illumination ( const DtVector &  localPosition ) const

virtual

Illumination in percentage (0 to 1.0) at a particular location.

Illumination cannot be set directly. It is a function of time of day.

Note

Currently, the location is ignored, and the illumination is the same over the entire simulation.

virtual void DtEnvironmentalStateManager::setWeatherState ( const DtChangeWeatherCommand &  command )

virtual

Calls the appropriate setXXX() functions locally, depending on what is in the command.

virtual void DtEnvironmentalStateManager::setUseDayNightIlluminationModel ( const DtChangeTimeOfDayCommand &  command )

virtual

The current time of day, specified by the number of seconds passed midnight.

virtual void DtEnvironmentalStateManager::setDateAndTimeOfDay ( double  secondsPastMidnight )

virtual

virtual void DtEnvironmentalStateManager::setDateAndTimeOfDay ( const DtChangeTimeOfDayCommand &  command )

virtual

virtual double DtEnvironmentalStateManager::timeOfDay ( ) const

virtual

virtual double DtEnvironmentalStateManager::dateAndTimeOfDay ( ) const

virtual

virtual void DtEnvironmentalStateManager::setTimeOfDayAdvancementSpeed ( double  speed )

virtual

The current time of day advancement speed.

virtual void DtEnvironmentalStateManager::setTimeOfDayAdvancementSpeed ( const DtChangeTimeOfDayCommand &  command )

virtual

virtual double DtEnvironmentalStateManager::timeOfDayAdvancementSpeed ( ) const

virtual

virtual void DtEnvironmentalStateManager::setPriority ( int  p, const DtString &  weatherArea = ""  )

virtual

Sets the priority of the weather area. This value is not used for global weather.

virtual int DtEnvironmentalStateManager::priority ( const DtString &  weatherArea ) const

virtual

Sets the priority of the weather area. This value is not used for global weather.

virtual int DtEnvironmentalStateManager::priority ( const DtVector &  ) const

virtual

Sets the priority of the weather area. This value is not used for global weather.

virtual void DtEnvironmentalStateManager::setUnderwaterVisibility ( double  underwaterVisibility, const DtString &  weatherArea = ""  )

virtual

Underwater visibility in meters.

virtual double DtEnvironmentalStateManager::underwaterVisibility ( const DtString &  weatherArea ) const

virtual

Underwater visibility in meters.

virtual double DtEnvironmentalStateManager::underwaterVisibility ( const DtVector &  ) const

virtual

Underwater visibility in meters.

virtual void DtEnvironmentalStateManager::setSurfaceTransparency ( double  transparency, const DtString &  weatherArea = ""  )

virtual

Surface transparency (percentage)

virtual double DtEnvironmentalStateManager::surfaceTransparency ( const DtString &  weatherArea ) const

virtual

Surface transparency (percentage)

virtual double DtEnvironmentalStateManager::surfaceTransparency ( const DtVector &  ) const

virtual

Surface transparency (percentage)

virtual void DtEnvironmentalStateManager::setWaterCurrentSpeed ( double  waterCurrentSpeed, const DtString &  weatherArea = ""  )

virtual

Water velocity in meters per second.

virtual double DtEnvironmentalStateManager::waterCurrentSpeed ( const DtString &  weatherArea ) const

virtual

Water velocity in meters per second.

virtual double DtEnvironmentalStateManager::waterCurrentSpeed ( const DtVector &  ) const

virtual

Water velocity in meters per second.

virtual void DtEnvironmentalStateManager::setWaterCurrentDirection ( double  waterCurrentDirection, const DtString &  weatherArea = ""  )

virtual

Water direction in radians clockwise from 0 (north)

virtual double DtEnvironmentalStateManager::waterCurrentDirection ( const DtString &  weatherArea ) const

virtual

Water direction in radians clockwise from 0 (north)

virtual double DtEnvironmentalStateManager::waterCurrentDirection ( const DtVector &  ) const

virtual

Water direction in radians clockwise from 0 (north)

virtual void DtEnvironmentalStateManager::setAmbientWaterTemperature ( double  waterTemperature, const DtString &  weatherArea = ""  )

virtual

Ambient water temperature in Celsius.

virtual double DtEnvironmentalStateManager::ambientWaterTemperature ( const DtString &  weatherArea ) const

virtual

Ambient water temperature in Celsius.

virtual double DtEnvironmentalStateManager::ambientWaterTemperature ( const DtVector &  ) const

virtual

Ambient water temperature in Celsius.

virtual void DtEnvironmentalStateManager::setTidalOffset ( double  tidalOffset, const DtString &  weatherArea = ""  )

virtual

Tidal offset in meters from the water polygons in the database.

virtual double DtEnvironmentalStateManager::tidalOffset ( const DtString &  weatherArea ) const

virtual

Tidal offset in meters from the water polygons in the database.

virtual double DtEnvironmentalStateManager::tidalOffset ( const DtVector &  ) const

virtual

Tidal offset in meters from the water polygons in the database.

virtual void DtEnvironmentalStateManager::setUseDayNightIlluminationModel ( bool  )

virtual

If false uses GMT as the position of sunrise/sunset (default) rather than entity position.

virtual bool DtEnvironmentalStateManager::useDayNightIlluminationModel ( ) const

virtual

If false uses GMT as the position of sunrise/sunset (default) rather than entity position.

virtual void DtEnvironmentalStateManager::setTidalDirection ( bool  tidalDirection, const DtString &  weatherArea = ""  )

virtual

Tidal direction where true represents the tide going in and false represents the tide going out.

virtual bool DtEnvironmentalStateManager::tidalDirection ( const DtString &  weatherArea ) const

virtual

Tidal direction where true represents the tide going in and false represents the tide going out.

virtual bool DtEnvironmentalStateManager::tidalDirection ( const DtVector &  ) const

virtual

Tidal direction where true represents the tide going in and false represents the tide going out.

virtual void DtEnvironmentalStateManager::setSwellState ( unsigned int  state, const DtString &  weatherArea = ""  )

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual unsigned int DtEnvironmentalStateManager::swellState ( const DtString &  weatherArea ) const

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual unsigned int DtEnvironmentalStateManager::swellState ( const DtVector &  ) const

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual void DtEnvironmentalStateManager::setSwellStateDirection ( double  direction, const DtString &  weatherArea = ""  )

virtual

Swell direction in in radians clockwise from 0 (north)

virtual double DtEnvironmentalStateManager::swellStateDirection ( const DtString &  weatherArea ) const

virtual

Swell direction in in radians clockwise from 0 (north)

virtual double DtEnvironmentalStateManager::swellStateDirection ( const DtVector &  ) const

virtual

Swell direction in in radians clockwise from 0 (north)

virtual void DtEnvironmentalStateManager::setSeaState ( unsigned int  state, const DtString &  weatherArea = ""  )

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual unsigned int DtEnvironmentalStateManager::seaState ( const DtString &  weatherArea ) const

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual unsigned int DtEnvironmentalStateManager::seaState ( const DtVector &  ) const

virtual

Swell state according to the Douglas Sea Scale (integer 0 - 9)

virtual void DtEnvironmentalStateManager::setSeaStateDirection ( double  direction, const DtString &  weatherArea = ""  )

virtual

Swell direction in in radians clockwise from 0 (north)

virtual double DtEnvironmentalStateManager::seaStateDirection ( const DtString &  weatherArea ) const

virtual

Swell direction in in radians clockwise from 0 (north)

virtual double DtEnvironmentalStateManager::seaStateDirection ( const DtVector &  ) const

virtual

Swell direction in in radians clockwise from 0 (north)

virtual void DtEnvironmentalStateManager::setWindDrivenSeaStateEnabled ( bool  b, const DtString &  weatherArea = ""  )

virtual

Determines if the sea state is set based on the wind.

virtual bool DtEnvironmentalStateManager::windDrivenSeaStateEnabled ( const DtString &  weatherArea ) const

virtual

Determines if the sea state is set based on the wind.

virtual bool DtEnvironmentalStateManager::windDrivenSeaStateEnabled ( const DtVector &  ) const

virtual

Determines if the sea state is set based on the wind.

virtual void DtEnvironmentalStateManager::setChoppiness ( double  choppiness, const DtString &  weatherArea = ""  )

virtual

Wave choppiness (0..1)

virtual double DtEnvironmentalStateManager::choppiness ( const DtString &  weatherArea ) const

virtual

Wave choppiness (0..1)

virtual double DtEnvironmentalStateManager::choppiness ( const DtVector &  ) const

virtual

Wave choppiness (0..1)

virtual void DtEnvironmentalStateManager::setSurgeDepth ( double  depth, const DtString &  weatherArea = ""  )

virtual

Surge depth (meters)

virtual double DtEnvironmentalStateManager::surgeDepth ( const DtString &  weatherArea ) const

virtual

Surge depth (meters)

virtual double DtEnvironmentalStateManager::surgeDepth ( const DtVector &  ) const

virtual

Surge depth (meters)

virtual DtObjectType DtEnvironmentalStateManager::globalEnvironmentObjectType ( ) const

virtual

Returns

The object type that will be used for the global environment object. Returns 1:21:0:0:1:0:0:0

virtual void DtEnvironmentalStateManager::setThermoclineLayer1Depth ( double  depth, const DtString &  weatherArea = ""  )

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer1Depth ( const DtString &  weatherArea ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer1Depth ( const DtVector &  ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual void DtEnvironmentalStateManager::setThermoclineLayer1Permeability ( double  depth, const DtString &  weatherArea = ""  )

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer1Permeability ( const DtString &  weatherArea ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer1Permeability ( const DtVector &  ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual void DtEnvironmentalStateManager::setThermoclineLayer2Depth ( double  depth, const DtString &  weatherArea = ""  )

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer2Depth ( const DtString &  weatherArea ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer2Depth ( const DtVector &  ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual void DtEnvironmentalStateManager::setThermoclineLayer2Permeability ( double  depth, const DtString &  weatherArea = ""  )

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer2Permeability ( const DtString &  weatherArea ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer2Permeability ( const DtVector &  ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual void DtEnvironmentalStateManager::setThermoclineLayer3Depth ( double  depth, const DtString &  weatherArea = ""  )

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer3Depth ( const DtString &  weatherArea ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer3Depth ( const DtVector &  ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual void DtEnvironmentalStateManager::setThermoclineLayer3Permeability ( double  depth, const DtString &  weatherArea = ""  )

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer3Permeability ( const DtString &  weatherArea ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer3Permeability ( const DtVector &  ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual void DtEnvironmentalStateManager::setThermoclineLayer4Depth ( double  depth, const DtString &  weatherArea = ""  )

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer4Depth ( const DtString &  weatherArea ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer4Depth ( const DtVector &  ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual void DtEnvironmentalStateManager::setThermoclineLayer4Permeability ( double  depth, const DtString &  weatherArea = ""  )

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer4Permeability ( const DtString &  weatherArea ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer4Permeability ( const DtVector &  ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual void DtEnvironmentalStateManager::setThermoclineLayer5Depth ( double  depth, const DtString &  weatherArea = ""  )

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer5Depth ( const DtString &  weatherArea ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer5Depth ( const DtVector &  ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual void DtEnvironmentalStateManager::setThermoclineLayer5Permeability ( double  depth, const DtString &  weatherArea = ""  )

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer5Permeability ( const DtString &  weatherArea ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

virtual double DtEnvironmentalStateManager::thermoclineLayer5Permeability ( const DtVector &  ) const

virtual

Thermocline depth (in meters) and permeability (0..1).

A depth of zero means that layer is not used.

static void DtEnvironmentalStateManager::objectAddedCallback ( DtVrfObject *  object, void *  usr  )

staticprotected

virtual void DtEnvironmentalStateManager::processObjectAdded ( DtVrfObject *  object )

protectedvirtual

static void DtEnvironmentalStateManager::objectRemovedCallback ( DtVrfObject *  object, void *  usr  )

staticprotected

virtual void DtEnvironmentalStateManager::processObjectRemoved ( DtVrfObject *  object )

protectedvirtual

virtual void DtEnvironmentalStateManager::createGlobalEnvironmentObject ( )

protectedvirtual

Creates a new locally simulated VRF object with the type returned from glovalEnvironmentObjectType().

Sets this new object to myGlovalEnvironmentObject, and sets up myEnvironmentalStateSetter.

virtual DtEnvironmentalStateSetter* DtEnvironmentalStateManager::createLocalEnvironmentalStateSetter ( )

protectedvirtual

Returns

A new instance of DtLocalEnvironmentalStateSetter().

virtual DtEnvironmentalStateSetter* DtEnvironmentalStateManager::createRemoteEnvironmentalStateSetter ( )

protectedvirtual

Returns

A new instance of DtRemoteEnvironmentalStateSetter().

static void DtEnvironmentalStateManager::changeWeatherPrioritiesCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

virtual void DtEnvironmentalStateManager::processChangeWeatherPriorities ( DtSimMessage *  msg )

protectedvirtual

Member Data Documentation

DtSimManager* DtEnvironmentalStateManager::mySimManager

protected

DtVrfObject* DtEnvironmentalStateManager::myGlobalEnvironmentObject

protected

std::set<DtVrfObject*> DtEnvironmentalStateManager::myWeatherObjects

protected

DtEnvironmentalStateSetter* DtEnvironmentalStateManager::myEnvironmentalStateSetter

protected

This is only for setting global weather – local weather will use local vrf objects.

bool DtEnvironmentalStateManager::myFirstTick

protected

DtVector DtEnvironmentalStateManager::myLastPointChecked

mutableprotected

For faster access for consecutive lookups given a point.

DtVrfObject* DtEnvironmentalStateManager::myLastWeatherByPoint

mutableprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/environmentalStateManager.h