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.
virtual void	reinitialize (DtReflectedEnvironmentProcessList *rel)
	Only call in the case of the originally supplied reflected list being deleted.
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	setFogColor (const DtVector &, const DtUUID &weatherArea=DtUUID::nullUUID())
	{@ Sets fog information (color and height)
virtual DtVector	fogColor (const DtVector &geocentricLocation)
virtual void	setFogHeight (double, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	fogHeight (const DtVector &geocentricLocation)
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 DtUUID &weatherArea=DtUUID::nullUUID())
	Air Turbidity.
virtual double	airTurbidity (const DtVector &geocentricLocation)
	If !reflectingCurrentWeatherState(), the default is 0.0.

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

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

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

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

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

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

virtual void	setVisibility (double value, const DtUUID &weatherArea=DtUUID::nullUUID())
	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)
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)

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 DtUUID &weatherArea=DtUUID::nullUUID())
	Underwater visibility in meters.
virtual double	underwaterVisibility (const DtVector &geocentricLocation)

virtual void	setSurfaceTransparency (double transparency, const DtUUID &weatherArea=DtUUID::nullUUID())
	Surface transparency (percentage)
virtual double	surfaceTransparency (const DtVector &geocentricLocation)

virtual void	setWaterCurrentSpeed (double waterCurrentSpeed, const DtUUID &weatherArea=DtUUID::nullUUID())
	Water velocity in meters per second.
virtual double	waterCurrentSpeed (const DtVector &geocentricLocation)

virtual void	setWaterCurrentDirection (double waterCurrentDirection, const DtUUID &weatherArea=DtUUID::nullUUID())
	Water direction in radians clockwise from 0 (north)
virtual double	waterCurrentDirection (const DtVector &geocentricLocation)

virtual void	setAmbientWaterTemperature (double waterTemperature, const DtUUID &weatherArea=DtUUID::nullUUID())
	Ambient water temperature in Celsius.
virtual double	ambientWaterTemperature (const DtVector &geocentricLocation)

virtual void	setTidalOffset (double tidalOffset, const DtUUID &weatherArea=DtUUID::nullUUID())
	Tidal offset in meters from the water polygons in the database.
virtual double	tidalOffset (const DtVector &geocentricLocation)

virtual void	setTidalDirection (bool tidalDirection, const DtUUID &weatherArea=DtUUID::nullUUID())
	Tidal direction where true represents the tide going in and false represents the tide going out.
virtual bool	tidalDirection (const DtVector &geocentricLocation)

virtual void	setSwellState (unsigned int state, const DtUUID &weatherArea=DtUUID::nullUUID())
	Swell state according to the Douglas Sea Scale (integer 0 - 9)
virtual unsigned int	swellState (const DtVector &geocentricLocation)

virtual void	setSwellStateDirection (double direction, const DtUUID &weatherArea=DtUUID::nullUUID())
	Swell direction in in radians clockwise from 0 (north)
virtual double	swellStateDirection (const DtVector &geocentricLocation)

virtual void	setSeaState (unsigned int douglasScale, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual unsigned int	seaState (const DtVector &geocentricLocation)

virtual void	setSeaStateDirection (double radiansFromNorth, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	seaStateDirection (const DtVector &geocentricLocation)

virtual void	setWindDrivenSeaStateEnabled (bool enabled, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual bool	windDrivenSeaStateEnabled (const DtVector &geocentricLocation)

virtual void	setChoppiness (double choppiness, const DtUUID &weatherArea=DtUUID::nullUUID())
	Wave choppiness (0..1)
virtual double	choppiness (const DtVector &geocentricLocation)

virtual void	setSurgeDepth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
	Surge depth (meters)
virtual double	surgeDepth (const DtVector &geocentricLocation)

virtual void	setThermoclineLayer1Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
	Thermocline depth (in meters) and permeability (0..1).
virtual double	thermoclineLayer1Depth (const DtVector &geocentricLocation)
virtual void	setThermoclineLayer1Permeability (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	thermoclineLayer1Permeability (const DtVector &geocentricLocation)
virtual void	setThermoclineLayer2Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	thermoclineLayer2Depth (const DtVector &geocentricLocation)
virtual void	setThermoclineLayer2Permeability (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	thermoclineLayer2Permeability (const DtVector &geocentricLocation)
virtual void	setThermoclineLayer3Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	thermoclineLayer3Depth (const DtVector &geocentricLocation)
virtual void	setThermoclineLayer3Permeability (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	thermoclineLayer3Permeability (const DtVector &geocentricLocation)
virtual void	setThermoclineLayer4Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	thermoclineLayer4Depth (const DtVector &geocentricLocation)
virtual void	setThermoclineLayer4Permeability (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	thermoclineLayer4Permeability (const DtVector &geocentricLocation)
virtual void	setThermoclineLayer5Depth (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	thermoclineLayer5Depth (const DtVector &geocentricLocation)
virtual void	setThermoclineLayer5Permeability (double depth, const DtUUID &weatherArea=DtUUID::nullUUID())
virtual double	thermoclineLayer5Permeability (const DtVector &geocentricLocation)

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.

virtual void DtRemoteEnvironmentController::reinitialize ( DtReflectedEnvironmentProcessList * rel )

virtual

Only call in the case of the originally supplied reflected list being deleted.

This will not clean up the previous list as it is assumed that the deletion did that

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 DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

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 DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

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 DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Cloud State.

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

virtual

If !reflectingCurrentWeatherState(), the default is DtVrfWeatherCloudStateClear.

virtual void DtRemoteEnvironmentController::setPrecipitationIntensity	(	double	value,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Precipitation Intensity.

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

virtual

If !reflectingCurrentWeatherState(), the default is 0.0.

virtual void DtRemoteEnvironmentController::setPrecipitationType	(	DtVrfWeatherPrecipitationType	,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

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 DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

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 DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

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 DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

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

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

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 DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Underwater visibility in meters.

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

virtual

virtual void DtRemoteEnvironmentController::setSurfaceTransparency	(	double	transparency,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Surface transparency (percentage)

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

virtual

virtual void DtRemoteEnvironmentController::setWaterCurrentSpeed	(	double	waterCurrentSpeed,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Water velocity in meters per second.

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

virtual

virtual void DtRemoteEnvironmentController::setWaterCurrentDirection	(	double	waterCurrentDirection,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Water direction in radians clockwise from 0 (north)

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

virtual

virtual void DtRemoteEnvironmentController::setAmbientWaterTemperature	(	double	waterTemperature,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Ambient water temperature in Celsius.

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

virtual

virtual void DtRemoteEnvironmentController::setTidalOffset	(	double	tidalOffset,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

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

virtual

virtual void DtRemoteEnvironmentController::setTidalDirection	(	bool	tidalDirection,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

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

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

virtual

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

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

virtual

virtual void DtRemoteEnvironmentController::setSwellStateDirection	(	double	direction,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Swell direction in in radians clockwise from 0 (north)

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

virtual

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

virtual

Sea state according to the Douglas Sea Scale.

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

virtual

virtual void DtRemoteEnvironmentController::setSeaStateDirection	(	double	radiansFromNorth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

The direction waves travel from in radians from North.

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

virtual

virtual void DtRemoteEnvironmentController::setWindDrivenSeaStateEnabled	(	bool	enabled,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

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

virtual

virtual void DtRemoteEnvironmentController::setChoppiness	(	double	choppiness,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Wave choppiness (0..1)

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

virtual

virtual void DtRemoteEnvironmentController::setSurgeDepth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

Surge depth (meters)

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

virtual

virtual void DtRemoteEnvironmentController::setFogColor	(	const DtVector &	,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

{@ Sets fog information (color and height)

virtual DtVector DtRemoteEnvironmentController::fogColor ( const DtVector & geocentricLocation )

virtual

virtual void DtRemoteEnvironmentController::setFogHeight	(	double	,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

virtual

virtual void DtRemoteEnvironmentController::setThermoclineLayer1Depth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

A depth of zero means that layer is not used.

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

virtual

virtual void DtRemoteEnvironmentController::setThermoclineLayer1Permeability	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

virtual

virtual void DtRemoteEnvironmentController::setThermoclineLayer2Depth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

virtual

virtual void DtRemoteEnvironmentController::setThermoclineLayer2Permeability	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

virtual

virtual void DtRemoteEnvironmentController::setThermoclineLayer3Depth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

virtual

virtual void DtRemoteEnvironmentController::setThermoclineLayer3Permeability	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

virtual

virtual void DtRemoteEnvironmentController::setThermoclineLayer4Depth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

virtual

virtual void DtRemoteEnvironmentController::setThermoclineLayer4Permeability	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

virtual

virtual void DtRemoteEnvironmentController::setThermoclineLayer5Depth	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

virtual

virtual void DtRemoteEnvironmentController::setThermoclineLayer5Permeability	(	double	depth,
		const DtUUID &	weatherArea = `DtUUID::nullUUID()`
	)

virtual

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

virtual

static void DtRemoteEnvironmentController::environmentProcessAddedCallback	(	DtReflectedEnvironmentProcess *	obj,
		void *	userData
	)

static

Registered by onInit, calls processEnvironmentProcessAdded.

virtual void DtRemoteEnvironmentController::processEnvironmentProcessAdded ( DtReflectedEnvironmentProcess * obj )

virtual

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.

static void DtRemoteEnvironmentController::environmentProcessRemovedCallback	(	DtReflectedEnvironmentProcess *	obj,
		void *	userData
	)

static

Registered by onInit, calls processEnvironmentProcessRemoved.

virtual void DtRemoteEnvironmentController::processEnvironmentProcessRemoved ( DtReflectedEnvironmentProcess * obj )

virtual

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 DtRemoteEnvironmentController::dT ( ) const

virtual

Returns delta time from last time received update and now (simTime)

virtual DtVrfEnvironmentalWeatherStateRecord* DtRemoteEnvironmentController::weatherObjectFor ( const DtVector & geocentricLocation ) const

protectedvirtual

Returns weather struct for object that contains given point.

virtual bool DtRemoteEnvironmentController::inside	(	const DtVector &	,
		const DtControlObjectRepository::DtCOVertexList &
	)		const

protectedvirtual

Returns true if the geocentric location is inside the given area.

virtual bool DtRemoteEnvironmentController::updateGlobalEnvironment ( )

protectedvirtual

Called by all the weather accessors to update myVrfEnvironmentalWeatherStateRecord and mySimulationDateTimeStateRecord from DtEnvironmentProcessRepository.

virtual bool DtRemoteEnvironmentController::updateWeatherEnvironment	(	DtEnvironmentProcessRepository *	,
		DtVrfEnvironmentalWeatherStateRecord *
	)

protectedvirtual

Updates the weather environmnt from weather record into supplied weather state record.

static void DtRemoteEnvironmentController::environmentProcessUpdatedCallback	(	DtReflectedEnvironmentProcess *	e,
		void *	usr
	)

staticprotected

Update internal data structures.

virtual void DtRemoteEnvironmentController::processUpdatedCallback ( DtReflectedEnvironmentProcess * e )

protectedvirtual

Member Data Documentation

DtReflectedEnvironmentProcessList* DtRemoteEnvironmentController::myReflectedEnvironmentProcessList

protected

DtVrfMessageInterface* DtRemoteEnvironmentController::myMsgIf

protected

WeatherObjects DtRemoteEnvironmentController::myWeatherObjects

protected

DtEnvironmentProcessRepository* DtRemoteEnvironmentController::myGlobalWeatherSR

protected

DtVrfEnvironmentalWeatherStateRecord* DtRemoteEnvironmentController::myGlobalWeatherStateRecord

protected

DtVrfSimulationDateTimeStateRecord* DtRemoteEnvironmentController::mySimulationDateTimeStateRecord

protected

double DtRemoteEnvironmentController::myLastTimeReceived

protected

int DtRemoteEnvironmentController::mySessionId

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfcontrol/remoteEnvironmentController.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation