VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
remoteEnvironmentController.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c ) 2015 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
11 
12 #pragma once
13 
14 #include "vrfcontrol/vrfcontrolDefines.h"
15 #include <vrfExtObjects/vrfWeatherStateEnums.h>
16 #include <vrfExtObjects/vrfEnvironmentalWeatherStateRecord.h>
17 #include <vrfExtObjects/vrfSimulationDateTimeStateRecord.h>
18 #include <vrfExtObjects/controlObjectRepository.h>
19 #include <vlutil/vlString.h>
20 #include <vrfutil/rwUUID.h>
21 #include <matrix/vlVector.h>
22 #include <readerWriter/noArgumentCallbackList.h>
23 
24 #include <map>
25 #include "vl/reflectedObjectListDIS.h"
26 
27 class DtVrfMessageInterface;
28 class DtReflectedEnvironmentProcessList;
29 class DtReflectedEnvironmentProcess;
30 class DtEnvironmentProcessRepository;
31 class DtWeatherObjectRepository;
32 class DtVrfEnvironmentalWeatherStateRecord;
33 class DtVrfSimulationDateTimeStateRecord;
34 class DtReflectedObject;
35 
45 
46 typedef DtCallbackList<const DtEnvironmentProcessRepository*> DtGlobalWeatherCreatedCallbackList;
47 
48 class DT_DLL_vrfcontrol DtRemoteEnvironmentController
49 {
50 public:
52  DtRemoteEnvironmentController();
53 
55  virtual ~DtRemoteEnvironmentController();
56 
64  virtual void init(DtVrfMessageInterface* msgIf,
65  DtReflectedEnvironmentProcessList* rel, int sessionId);
66 
69  virtual void reinitialize(DtReflectedEnvironmentProcessList* rel);
70 
71  static bool envProcessDiscoveryCriteria(
72  DtReflectedObject* envProcess, void* userData);
73  virtual bool processEnvProcessDiscoveryCriteria(
74  DtReflectedEnvironmentProcess* envProcess);
75 
79  bool reflectingCurrentWeatherState();
80 
82  DtEnvironmentProcessRepository* globalEnvironment() const
83  {
84  return myGlobalWeatherSR;
85  }
86 
88 
89  virtual void setAirTurbidity(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
91  virtual double airTurbidity(const DtVector& geocentricLocation);
93 
95 
96  virtual void setAmbientAirTemperature(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
98  virtual double ambientAirTemperature(const DtVector& geocentricLocation);
100 
102 
103  virtual void setPrecipitationIntensity(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
105  virtual double precipitationIntensity(const DtVector& geocentricLocation);
107 
109 
110  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType, const DtUUID& weatherArea = DtUUID::nullUUID());
112  virtual DtVrfWeatherPrecipitationType precipitationType(const DtVector& geocentricLocation);
114 
116 
117  virtual void setWindSpeed(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
119  virtual double windSpeed(const DtVector& geocentricLocation);
121 
123 
124  virtual void setWindDirection(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
126  virtual double windDirection(const DtVector& geocentricLocation);
128 
130 
131  virtual void setVisibility(double value, const DtUUID& weatherArea = DtUUID::nullUUID());
133  virtual double visibility(const DtVector& geocentricLocation);
135 
138 
139  virtual void setTimeOfDay(double secondsPastMidnight);
141  virtual double timeOfDay();
143 
146 
147  virtual void setDateAndTimeOfDay(double secondsPastUtc);
148  virtual void setDateAndTimeOfDay(int year, int month, int day, int hours, int minutes, int seconds);
149 
151  virtual double dateAndTimeOfDay();
152  virtual void dateAndTimeOfDay(int& year, int& month, int& day, int& hours, int& minutes, int& seconds);
154 
156  virtual void setUseDayNightIlluminationModel(bool value);
157 
159 
160  virtual void setTimeOfDayAdvancementSpeed(double speed);
162  virtual double timeOfDayAdvancementSpeed();
164 
166 
167  virtual void setLightningPresent(bool isPresent, const DtUUID& weatherArea = DtUUID::nullUUID());
168  virtual bool lightningPresent(const DtVector& geocentricLocation) const;
170 
172 
173  virtual void setUnderwaterVisibility(double underwaterVisibility, const DtUUID& weatherArea = DtUUID::nullUUID());
174  virtual double underwaterVisibility(const DtVector& geocentricLocation);
176 
178 
179  virtual void setSurfaceTransparency(double transparency, const DtUUID& weatherArea = DtUUID::nullUUID());
180  virtual double surfaceTransparency(const DtVector& geocentricLocation);
182 
184 
185  virtual void setWaterCurrentSpeed(double waterCurrentSpeed, const DtUUID& weatherArea = DtUUID::nullUUID());
186  virtual double waterCurrentSpeed(const DtVector& geocentricLocation);
188 
190 
191  virtual void setWaterCurrentDirection(double waterCurrentDirection, const DtUUID& weatherArea = DtUUID::nullUUID());
192  virtual double waterCurrentDirection(const DtVector& geocentricLocation);
194 
196 
197  virtual void setAmbientWaterTemperature(double waterTemperature, const DtUUID& weatherArea = DtUUID::nullUUID());
198  virtual double ambientWaterTemperature(const DtVector& geocentricLocation);
200 
202 
203  virtual void setTidalOffset(double tidalOffset, const DtUUID& weatherArea = DtUUID::nullUUID());
204  virtual double tidalOffset(const DtVector& geocentricLocation);
206 
209 
210  virtual void setTidalDirection(bool tidalDirection, const DtUUID& weatherArea = DtUUID::nullUUID());
211  virtual bool tidalDirection(const DtVector& geocentricLocation);
213 
215 
216  virtual void setSwellState(unsigned int state, const DtUUID& weatherArea = DtUUID::nullUUID());
217  virtual unsigned int swellState(const DtVector& geocentricLocation);
219 
221 
222  virtual void setSwellStateDirection(double direction, const DtUUID& weatherArea = DtUUID::nullUUID());
223  virtual double swellStateDirection(const DtVector& geocentricLocation);
225 
228  virtual void setSeaState(unsigned int douglasScale, const DtUUID& weatherArea = DtUUID::nullUUID());
229  virtual unsigned int seaState(const DtVector& geocentricLocation);
231 
234  virtual void setSeaStateDirection(double radiansFromNorth, const DtUUID& weatherArea = DtUUID::nullUUID());
235  virtual double seaStateDirection(const DtVector& geocentricLocation);
237 
240  virtual void setWindDrivenSeaStateEnabled(bool enabled, const DtUUID& weatherArea = DtUUID::nullUUID());
241  virtual bool windDrivenSeaStateEnabled(const DtVector& geocentricLocation);
243 
245 
246  virtual void setChoppiness(double choppiness, const DtUUID& weatherArea = DtUUID::nullUUID());
247  virtual double choppiness(const DtVector& geocentricLocation);
249 
251 
252  virtual void setSurgeDepth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
253  virtual double surgeDepth(const DtVector& geocentricLocation);
255 
258  virtual void setFogColor(const DtVector&, const DtUUID& weatherArea = DtUUID::nullUUID());
259  virtual DtVector fogColor(const DtVector& geocentricLocation);
260 
261  virtual void setFogHeight(double, const DtUUID& weatherArea = DtUUID::nullUUID());
262  virtual double fogHeight(const DtVector& geocentricLocation);
264 
267  virtual void setSnowAccumulation(double, const DtUUID& weatherArea = DtUUID::nullUUID());
268  virtual double snowAccumulation(const DtVector& geocentricLocation);
269 
270  virtual void setSnowMinimumAltitude(double, const DtUUID& weatherArea = DtUUID::nullUUID());
271  virtual double snowMinimumAltitude(const DtVector& geocentricLocation);
272 
273  virtual void setSnowRoadAccumulation(double, const DtUUID& weatherArea = DtUUID::nullUUID());
274  virtual double snowRoadAccumulation(const DtVector& geocentricLocation);
275 
277  virtual void setRainAccumulation(double, const DtUUID& weatherArea = DtUUID::nullUUID());
278  virtual double rainAccumulation(const DtVector& geocentricLocation);
279 
281 
284 
285  virtual void setThermoclineLayer1Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
286  virtual double thermoclineLayer1Depth(const DtVector& geocentricLocation);
287  virtual void setThermoclineLayer1Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
288  virtual double thermoclineLayer1Permeability(const DtVector& geocentricLocation);
289  virtual void setThermoclineLayer2Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
290  virtual double thermoclineLayer2Depth(const DtVector& geocentricLocation);
291  virtual void setThermoclineLayer2Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
292  virtual double thermoclineLayer2Permeability(const DtVector& geocentricLocation);
293  virtual void setThermoclineLayer3Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
294  virtual double thermoclineLayer3Depth(const DtVector& geocentricLocation);
295  virtual void setThermoclineLayer3Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
296  virtual double thermoclineLayer3Permeability(const DtVector& geocentricLocation);
297  virtual void setThermoclineLayer4Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
298  virtual double thermoclineLayer4Depth(const DtVector& geocentricLocation);
299  virtual void setThermoclineLayer4Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
300  virtual double thermoclineLayer4Permeability(const DtVector& geocentricLocation);
301  virtual void setThermoclineLayer5Depth(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
302  virtual double thermoclineLayer5Depth(const DtVector& geocentricLocation);
303  virtual void setThermoclineLayer5Permeability(double depth, const DtUUID& weatherArea = DtUUID::nullUUID());
304  virtual double thermoclineLayer5Permeability(const DtVector& geocentricLocation);
306 
308  static void environmentProcessAddedCallback(
309  DtReflectedEnvironmentProcess* obj, void* userData);
313  virtual void processEnvironmentProcessAdded(
314  DtReflectedEnvironmentProcess* obj);
315 
317  static void environmentProcessRemovedCallback(
318  DtReflectedEnvironmentProcess* obj, void* userData);
322  virtual void processEnvironmentProcessRemoved(
323  DtReflectedEnvironmentProcess* obj);
324 
326  virtual double dT() const;
327 
329 
330  virtual void addGlobalEnvironmentCreatedCallback(
331  DtGlobalWeatherCreatedCallbackList::DtCallbackFunctionType fcn, void* usr) const;
332  virtual void removeGlobalEnvironmentCreatedCallback(
333  DtGlobalWeatherCreatedCallbackList::DtCallbackFunctionType fcn, void* usr) const;
334  virtual void invokeGlobalWeatherCreatedCallbacks();
336 
337 protected:
338 
340  virtual DtVrfEnvironmentalWeatherStateRecord* weatherObjectFor(const DtVector& geocentricLocation) const;
341 
343  virtual bool inside(const DtVector&, const DtControlObjectRepository::DtCOVertexList&) const;
344 
345 protected:
349  virtual bool updateGlobalEnvironment();
350 
352  virtual bool updateWeatherEnvironment(DtEnvironmentProcessRepository*, DtVrfEnvironmentalWeatherStateRecord*);
353 
355  static void environmentProcessUpdatedCallback(DtReflectedEnvironmentProcess* e, void* usr);
356  virtual void processUpdatedCallback(DtReflectedEnvironmentProcess* e);
357 
358 protected:
359  DtReflectedEnvironmentProcessList* myReflectedEnvironmentProcessList;
360  DtVrfMessageInterface* myMsgIf;
361 
362  typedef std::map<DtControlObjectRepository*, DtVrfEnvironmentalWeatherStateRecord*> WeatherObjects;
363  WeatherObjects myWeatherObjects;
364 
365  DtEnvironmentProcessRepository* myGlobalWeatherSR;
366  DtVrfEnvironmentalWeatherStateRecord* myGlobalWeatherStateRecord;
367  DtVrfSimulationDateTimeStateRecord* mySimulationDateTimeStateRecord;
368 
369  double myLastTimeReceived;
370  int mySessionId;
371 
372  mutable DtGlobalWeatherCreatedCallbackList myGlobalEnvironmentCreated;
373 };
374 
DtUUID
UUID is a unique ID wrapper class.
Definition: rwUUID.h:222
DtVrfWeatherPrecipitationType
DtVrfWeatherPrecipitationType
Definition: vrfWeatherStateEnums.h:13
DtRemoteEnvironmentController::myReflectedEnvironmentProcessList
DtReflectedEnvironmentProcessList * myReflectedEnvironmentProcessList
Definition: remoteEnvironmentController.h:359
DT_DLL_vrfcontrol
#define DT_DLL_vrfcontrol
This file is used to determine how to build.
Definition: vrfcontrolDefines.h:28
DtRemoteEnvironmentController::myGlobalWeatherStateRecord
DtVrfEnvironmentalWeatherStateRecord * myGlobalWeatherStateRecord
Definition: remoteEnvironmentController.h:366
vrfEnvironmentalWeatherStateRecord.h
Contains the DtVrfEnvironmentalWeatherStateRecord class declaration.
vrfSimulationDateTimeStateRecord.h
Contains the DtVrfSimulationDateTimeStateRecord class declaration.
DtWeatherObjectRepository
This class creates a network state repository to aid sending weather area objects.
Definition: weatherObjectRepository.h:17
DtRemoteEnvironmentController::myLastTimeReceived
double myLastTimeReceived
Definition: remoteEnvironmentController.h:369
controlObjectRepository.h
Contains the DtExtEntityStateRepository class.
DtRemoteEnvironmentController::mySimulationDateTimeStateRecord
DtVrfSimulationDateTimeStateRecord * mySimulationDateTimeStateRecord
Definition: remoteEnvironmentController.h:367
DtControlObjectBaseRepository::DtCOVertexList
std::vector< DtVector > DtCOVertexList
Definition: controlObjectBaseRepository.h:130
inside
DT_DLL_vrfutil bool inside(const DtVector &localPoint, const DtLocalVertexList &localVertexList, const Coordinate_System &coordinateSystem)
Returns true if localPoint is inside localVertexList in 2D.
DtRemoteEnvironmentController::myGlobalEnvironmentCreated
DtGlobalWeatherCreatedCallbackList myGlobalEnvironmentCreated
Definition: remoteEnvironmentController.h:372
DtRemoteEnvironmentController::WeatherObjects
std::map< DtControlObjectRepository *, DtVrfEnvironmentalWeatherStateRecord * > WeatherObjects
Definition: remoteEnvironmentController.h:362
DtUUID::nullUUID
static const DtUUID & nullUUID()
DtVrfSimulationDateTimeStateRecord
Definition: vrfSimulationDateTimeStateRecord.h:29
DtVrfEnvironmentalWeatherStateRecord
Definition: vrfEnvironmentalWeatherStateRecord.h:173
DtRemoteEnvironmentController::myGlobalWeatherSR
DtEnvironmentProcessRepository * myGlobalWeatherSR
Definition: remoteEnvironmentController.h:365
DtGlobalWeatherCreatedCallbackList
DtCallbackList< const DtEnvironmentProcessRepository * > DtGlobalWeatherCreatedCallbackList
DtRemoteEnvironmentController allows the user to interrogate the back-end which is simulating the env...
Definition: remoteEnvironmentController.h:34
DtRemoteEnvironmentController::globalEnvironment
DtEnvironmentProcessRepository * globalEnvironment() const
The current global environment.
Definition: remoteEnvironmentController.h:82
init
DT_DLL_DEBUGDRAWRENDERER void init(makVrv::DtDe &de)
Work function for the plugin initialization.
DtRemoteEnvironmentController::myMsgIf
DtVrfMessageInterface * myMsgIf
Definition: remoteEnvironmentController.h:360
DtCallbackList< const DtEnvironmentProcessRepository * >::DtCallbackFunctionType
void(* DtCallbackFunctionType)(const DtEnvironmentProcessRepository *, void *)
The function signature of the callback function.
Definition: noArgumentCallbackList.h:95
DtRemoteEnvironmentController
Definition: remoteEnvironmentController.h:48
DtRemoteEnvironmentController::myWeatherObjects
WeatherObjects myWeatherObjects
Definition: remoteEnvironmentController.h:363
DtRemoteEnvironmentController::mySessionId
int mySessionId
Definition: remoteEnvironmentController.h:370
DtVrfMessageInterface
Definition: vrfMessageInterface.h:46
Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)