DtRemoteEnvironmentController allows the user to interrogate the back-end which is simulating the environmental weather object to get the current weather state. More...

Public Member Functions
	DtRemoteEnvironmentController ()
	Constructor.
virtual	~DtRemoteEnvironmentController ()
	DTOR.
virtual void	init (DtVrfMessageInterface msgIf, DtReflectedEnvironmentProcessList rel, int sessionId)
	Caches the given pointers as myMsgIf and myReflectedEnvironmentProcessList.
bool	reflectingCurrentWeatherState ()
	Indicates if the weather state of the back-end simulating the weather has been reflected.
virtual void	setUseDayNightIlluminationModel (bool value)
	Sets wheter or not to use the day/night illumination model (true) or to always assume noon GMT.
virtual void	processEnvironmentProcessAdded (DtReflectedEnvironmentProcess *obj)
	Checks to see if the first recordPointer in the state repository of the DtReflectedEnvironmentProcess is of type DtEnvVrfWeatherStateRecordType, and if so it caches a pointer to the SR in myReflectedWeatherSR.
virtual void	processEnvironmentProcessRemoved (DtReflectedEnvironmentProcess *obj)
	Checks to see if the DtReflectedEnvironmentProcess being removed corresponds to the one cached in myReflectedWeatherSR, and if so myReflectedWeatherSR is set to 0.
virtual double	dT () const
	Returns delta time from last time received update and now (simTime)

virtual void	setAirTurbidity (double value, const DtString &weatherArea="")
	Air Turbidity.
virtual double	airTurbidity (const DtVector &geocentricLocation)
	If !reflectingCurrentWeatherState(), the default is 0.0.

virtual void	setAmbientAirTemperature (double value, const DtString &weatherArea="")
	Ambient Air Temperature.
virtual double	ambientAirTemperature (const DtVector &geocentricLocation)
	If !reflectingCurrentWeatherState(), the default is 0.0.

virtual void	setCloudState (DtVrfWeatherCloudState, const DtString &weatherArea="")
	Cloud State.
virtual DtVrfWeatherCloudState	cloudState (const DtVector &geocentricLocation)
	If !reflectingCurrentWeatherState(), the default is DtVrfWeatherCloudStateClear.

virtual void	setPrecipitationIntensity (double value, const DtString &weatherArea="")
	Precipitation Intensity.
virtual double	precipitationIntensity (const DtVector &geocentricLocation)
	If !reflectingCurrentWeatherState(), the default is 0.0.

virtual void	setPrecipitationType (DtVrfWeatherPrecipitationType, const DtString &weatherArea="")
	Precipitation Intensity.
virtual DtVrfWeatherPrecipitationType	precipitationType (const DtVector &geocentricLocation)
	If !reflectingCurrentWeatherState(), the default is 0.0.

virtual void	setWindSpeed (double value, const DtString &weatherArea="")
	Wind speed in m/s.
virtual double	windSpeed (const DtVector &geocentricLocation)
	If !reflectingCurrentWeatherState(), the default is 0.0.

virtual void	setWindDirection (double value, const DtString &weatherArea="")
	Wind direction in radians.
virtual double	windDirection (const DtVector &geocentricLocation)
	If !reflectingCurrentWeatherState(), the default is 0.0.

virtual void	setVisibility (double value, const DtString &weatherArea="")
	Visibility in meters.
virtual double	visibility (const DtVector &geocentricLocation)
	If !reflectingCurrentWeatherState(), the default is 16,000 (16km)

virtual void	setTimeOfDay (double secondsPastMidnight)
	The current time of day, specified by the number of seconds past midnight.
virtual double	timeOfDay ()
	If !reflectingCurrentWeatherState(), the default is 43200 (12:00 noon)

virtual void	setDateAndTimeOfDay (double secondsPastUtc)
	The current date/time of day, specified by the number of seconds past 00:00 hours, Jan 1, 1970 UTC.
virtual void	setDateAndTimeOfDay (int year, int month, int day, int hours, int minutes, int seconds)
	The current date/time of day, specified by the number of seconds past 00:00 hours, Jan 1, 1970 UTC.
virtual double	dateAndTimeOfDay ()
	If !reflectingCurrentWeatherState(), the default is current date and 43200 (12:00 noon)
virtual void	dateAndTimeOfDay (int &year, int &month, int &day, int &hours, int &minutes, int &seconds)
	The current date/time of day, specified by the number of seconds past 00:00 hours, Jan 1, 1970 UTC.

virtual void	setTimeOfDayAdvancementSpeed (double speed)
	The current time of day advancement speed.
virtual double	timeOfDayAdvancementSpeed ()
	If !reflectingCurrentWeatherState(), the default is 0 (no advance)

virtual void	setUnderwaterVisibility (double underwaterVisibility, const DtString &weatherArea="")
	Underwater visibility in meters.
virtual double	underwaterVisibility (const DtVector &geocentricLocation)
	Underwater visibility in meters.

virtual void	setSurfaceTransparency (double transparency, const DtString &weatherArea="")
	Surface transparency (percentage)
virtual double	surfaceTransparency (const DtVector &geocentricLocation)
	Surface transparency (percentage)

virtual void	setWaterCurrentSpeed (double waterCurrentSpeed, const DtString &weatherArea="")
	Water velocity in meters per second.
virtual double	waterCurrentSpeed (const DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	Tidal offset in meters from the water polygons in the database.

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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	Swell direction in in radians clockwise from 0 (north)

virtual void	setSeaState (unsigned int douglasScale, const DtString &weatherArea="")
virtual unsigned int	seaState (const DtVector &geocentricLocation)

virtual void	setSeaStateDirection (double radiansFromNorth, const DtString &weatherArea="")
virtual double	seaStateDirection (const DtVector &geocentricLocation)

virtual void	setWindDrivenSeaStateEnabled (bool enabled, const DtString &weatherArea="")
virtual bool	windDrivenSeaStateEnabled (const DtVector &geocentricLocation)

virtual void	setChoppiness (double choppiness, const DtString &weatherArea="")
	Wave choppiness (0..1)
virtual double	choppiness (const DtVector &geocentricLocation)
	Wave choppiness (0..1)

virtual void	setSurgeDepth (double depth, const DtString &weatherArea="")
	Surge depth (meters)
virtual double	surgeDepth (const DtVector &geocentricLocation)
	Surge depth (meters)

virtual void	setThermoclineLayer1Depth (double depth, const DtString &weatherArea="")
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer1Depth (const DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	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 DtVector &geocentricLocation)
	Thermocline depth (in meters) and permeability (0..1).

Static Public Member Functions
static void	environmentProcessAddedCallback (DtReflectedEnvironmentProcess obj, void userData)
	Registered by onInit, calls processEnvironmentProcessAdded.
static void	environmentProcessRemovedCallback (DtReflectedEnvironmentProcess obj, void userData)
	Registered by onInit, calls processEnvironmentProcessRemoved.

Protected Types
typedef std::map < DtControlObjectRepository , DtVrfEnvironmentalWeatherStateRecord >	WeatherObjects

Protected Member Functions
virtual DtVrfEnvironmentalWeatherStateRecord *	weatherObjectFor (const DtVector &geocentricLocation) const
	Returns weather struct for object that contains given point.
virtual bool	inside (const DtVector &, const DtControlObjectRepository::DtCOVertexList &) const
	Returns true if the geocentric location is inside the given area.
virtual bool	updateGlobalEnvironment ()
	Called by all the weather accessors to update myVrfEnvironmentalWeatherStateRecord and mySimulationDateTimeStateRecord from DtEnvironmentProcessRepository.
virtual bool	updateWeatherEnvironment (DtEnvironmentProcessRepository , DtVrfEnvironmentalWeatherStateRecord )
	Updates the weather environmnt from weather record into supplied weather state record.
virtual void	processUpdatedCallback (DtReflectedEnvironmentProcess *e)

Static Protected Member Functions
static void	environmentProcessUpdatedCallback (DtReflectedEnvironmentProcess e, void usr)
	Update internal data structures.

Protected Attributes
DtReflectedEnvironmentProcessList *	myReflectedEnvironmentProcessList
DtVrfMessageInterface *	myMsgIf
WeatherObjects	myWeatherObjects
DtEnvironmentProcessRepository *	myGlobalWeatherSR
DtVrfEnvironmentalWeatherStateRecord *	myGlobalWeatherStateRecord
DtVrfSimulationDateTimeStateRecord *	mySimulationDateTimeStateRecord
double	myLastTimeReceived
int	mySessionId

Detailed Description

DtRemoteEnvironmentController allows the user to interrogate the back-end which is simulating the environmental weather object to get the current weather state.

Sim commands can also be sent to change the weather state. If there is no weather state available, the accessors will all provide reasonable default values which represent a clear, windless and sunny environment state. The user can check to see if the back-end's weather values are being reflected by calling reflectingCurrentWeatherState().

A vector location of zero() will also return global weather

Member Typedef Documentation

typedef std::map<DtControlObjectRepository*, DtVrfEnvironmentalWeatherStateRecord*> DtRemoteEnvironmentController::WeatherObjects

protected

Constructor & Destructor Documentation

DtRemoteEnvironmentController::DtRemoteEnvironmentController ( )

Constructor.

virtual DtRemoteEnvironmentController::~DtRemoteEnvironmentController ( )

virtual

DTOR.

Member Function Documentation

virtual void DtRemoteEnvironmentController::init	(	DtVrfMessageInterface *	msgIf,
		DtReflectedEnvironmentProcessList *	rel,
		int	sessionId
	)

virtual

Caches the given pointers as myMsgIf and myReflectedEnvironmentProcessList.

Registers environmentProcessAddedCallback and environmentProcessRemovedCallback with the DtReflectedEnvironmentProcessList. In order to check to see if the environment object has already been reflected, the environment list is walked and each reflected object is passed to processEnvironmentProcessAdded.

bool DtRemoteEnvironmentController::reflectingCurrentWeatherState ( )

Indicates if the weather state of the back-end simulating the weather has been reflected.

Unless this returns true, none of the accessors will return real data!

virtual void DtRemoteEnvironmentController::setAirTurbidity	(	double	value,
		const DtString &	weatherArea = `""`
	)

virtual

Air Turbidity.

virtual double DtRemoteEnvironmentController::airTurbidity ( const DtVector & geocentricLocation )

virtual

If !reflectingCurrentWeatherState(), the default is 0.0.

virtual void DtRemoteEnvironmentController::setAmbientAirTemperature	(	double	value,
		const DtString &	weatherArea = `""`
	)

virtual

Ambient Air Temperature.

virtual double DtRemoteEnvironmentController::ambientAirTemperature ( const DtVector & geocentricLocation )

virtual

If !reflectingCurrentWeatherState(), the default is 0.0.

virtual void DtRemoteEnvironmentController::setCloudState	(	DtVrfWeatherCloudState	,
		const DtString &	weatherArea = `""`
	)

virtual

Cloud State.

virtual DtVrfWeatherCloudState DtRemoteEnvironmentController::cloudState ( const DtVector & geocentricLocation )

virtual

If !reflectingCurrentWeatherState(), the default is DtVrfWeatherCloudStateClear.

virtual void DtRemoteEnvironmentController::setPrecipitationIntensity	(	double	value,
		const DtString &	weatherArea = `""`
	)

virtual

Precipitation Intensity.

virtual double DtRemoteEnvironmentController::precipitationIntensity ( const DtVector & geocentricLocation )

virtual

If !reflectingCurrentWeatherState(), the default is 0.0.

virtual void DtRemoteEnvironmentController::setPrecipitationType	(	DtVrfWeatherPrecipitationType	,
		const DtString &	weatherArea = `""`
	)

virtual

Precipitation Intensity.

virtual DtVrfWeatherPrecipitationType DtRemoteEnvironmentController::precipitationType ( const DtVector & geocentricLocation )

virtual

If !reflectingCurrentWeatherState(), the default is 0.0.

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

virtual

Wind speed in m/s.

virtual double DtRemoteEnvironmentController::windSpeed ( const DtVector & geocentricLocation )

virtual

If !reflectingCurrentWeatherState(), the default is 0.0.

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

virtual

Wind direction in radians.

virtual double DtRemoteEnvironmentController::windDirection ( const DtVector & geocentricLocation )

virtual

If !reflectingCurrentWeatherState(), the default is 0.0.

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

virtual

Visibility in meters.

virtual double DtRemoteEnvironmentController::visibility ( const DtVector & geocentricLocation )

virtual

If !reflectingCurrentWeatherState(), the default is 16,000 (16km)

virtual void DtRemoteEnvironmentController::setTimeOfDay ( double secondsPastMidnight )

virtual

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

virtual double DtRemoteEnvironmentController::timeOfDay ( )

virtual

If !reflectingCurrentWeatherState(), the default is 43200 (12:00 noon)

virtual void DtRemoteEnvironmentController::setDateAndTimeOfDay ( double secondsPastUtc )

virtual

The current date/time of day, specified by the number of seconds past 00:00 hours, Jan 1, 1970 UTC.

virtual void DtRemoteEnvironmentController::setDateAndTimeOfDay	(	int	year,
		int	month,
		int	day,
		int	hours,
		int	minutes,
		int	seconds
	)

virtual

The current date/time of day, specified by the number of seconds past 00:00 hours, Jan 1, 1970 UTC.

virtual double DtRemoteEnvironmentController::dateAndTimeOfDay ( )

virtual

If !reflectingCurrentWeatherState(), the default is current date and 43200 (12:00 noon)

virtual void DtRemoteEnvironmentController::dateAndTimeOfDay	(	int &	year,
		int &	month,
		int &	day,
		int &	hours,
		int &	minutes,
		int &	seconds
	)

virtual

The current date/time of day, specified by the number of seconds past 00:00 hours, Jan 1, 1970 UTC.

virtual void DtRemoteEnvironmentController::setUseDayNightIlluminationModel ( bool value )

virtual

Sets wheter or not to use the day/night illumination model (true) or to always assume noon GMT.

virtual void DtRemoteEnvironmentController::setTimeOfDayAdvancementSpeed ( double speed )

virtual

The current time of day advancement speed.

virtual double DtRemoteEnvironmentController::timeOfDayAdvancementSpeed ( )

virtual

If !reflectingCurrentWeatherState(), the default is 0 (no advance)

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

virtual

Underwater visibility in meters.

virtual double DtRemoteEnvironmentController::underwaterVisibility ( const DtVector & geocentricLocation )

virtual

Underwater visibility in meters.

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

virtual

Surface transparency (percentage)

virtual double DtRemoteEnvironmentController::surfaceTransparency ( const DtVector & geocentricLocation )

virtual

Surface transparency (percentage)

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

virtual

Water velocity in meters per second.

virtual double DtRemoteEnvironmentController::waterCurrentSpeed ( const DtVector & geocentricLocation )

virtual

Water velocity in meters per second.

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

virtual

Water direction in radians clockwise from 0 (north)

virtual double DtRemoteEnvironmentController::waterCurrentDirection ( const DtVector & geocentricLocation )

virtual

Water direction in radians clockwise from 0 (north)

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

virtual

Ambient water temperature in Celsius.

virtual double DtRemoteEnvironmentController::ambientWaterTemperature ( const DtVector & geocentricLocation )

virtual

Ambient water temperature in Celsius.

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

virtual

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

virtual double DtRemoteEnvironmentController::tidalOffset ( const DtVector & geocentricLocation )

virtual

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

virtual void DtRemoteEnvironmentController::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 DtRemoteEnvironmentController::tidalDirection ( const DtVector & geocentricLocation )

virtual

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

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

virtual

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

virtual unsigned int DtRemoteEnvironmentController::swellState ( const DtVector & geocentricLocation )

virtual

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

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

virtual

Swell direction in in radians clockwise from 0 (north)

virtual double DtRemoteEnvironmentController::swellStateDirection ( const DtVector & geocentricLocation )

virtual

Swell direction in in radians clockwise from 0 (north)

virtual void DtRemoteEnvironmentController::setSeaState	(	unsigned int	douglasScale,
		const DtString &	weatherArea = `""`
	)

virtual

Sea state according to the Douglas Sea Scale.

virtual unsigned int DtRemoteEnvironmentController::seaState ( const DtVector & geocentricLocation )

virtual

Sea state according to the Douglas Sea Scale.

virtual void DtRemoteEnvironmentController::setSeaStateDirection	(	double	radiansFromNorth,
		const DtString &	weatherArea = `""`
	)

virtual

The direction waves travel from in radians from North.

virtual double DtRemoteEnvironmentController::seaStateDirection ( const DtVector & geocentricLocation )

virtual

The direction waves travel from in radians from North.

virtual void DtRemoteEnvironmentController::setWindDrivenSeaStateEnabled	(	bool	enabled,
		const DtString &	weatherArea = `""`
	)

virtual

Flag for enabling sea-state to be driven by wind.

virtual bool DtRemoteEnvironmentController::windDrivenSeaStateEnabled ( const DtVector & geocentricLocation )

virtual

Flag for enabling sea-state to be driven by wind.

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

virtual

Wave choppiness (0..1)

virtual double DtRemoteEnvironmentController::choppiness ( const DtVector & geocentricLocation )

virtual

Wave choppiness (0..1)

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

virtual

Surge depth (meters)

virtual double DtRemoteEnvironmentController::surgeDepth ( const DtVector & geocentricLocation )

virtual

Surge depth (meters)

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

virtual

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