VR-Forces 4.2 Class Documentation
globalEnvironmentSR.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2011 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
10 
11 #pragma once
12 
13 #include "vrfobjcore/vrfobjcoreDefines.h"
14 #include "vrfobjcore/vrfObjSR.h"
15 #include <vrfExtObjects/vrfWeatherStateEnums.h>
16 
17 class DtGlobalEnvironmentParameters;
18 
21 class DT_DLL_vrfobjcore DtGlobalEnvironmentStateRepository : public DtVrfObjectStateRepository
22 {
23 public:
24 
26  DtGlobalEnvironmentStateRepository (DtVrfObject* vrfObject,
27  const DtObjectType& objectType, DtVrfObjectParameters* parameters,
28  const DtString& rwName = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = 0);
29 
31  DtGlobalEnvironmentStateRepository(const DtGlobalEnvironmentStateRepository& orig,
32  const DtString& rwName = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = 0);
33 
35  DtGlobalEnvironmentStateRepository& operator=(const DtGlobalEnvironmentStateRepository& orig);
36 
38  virtual ~DtGlobalEnvironmentStateRepository();
39 
44  virtual void resetToDefaults();
45 
46  static DtVrfObjectStateRepository* creator(const DtString& name,
47  DtVrfObject* vrfObject, const DtObjectType& objectType,
48  DtVrfObjectParameters* parameters, DtReaderWriterRegistry* parentRegistry);
49 
50  static DtGlobalEnvironmentStateRepository*
51  isGlobalEnvironmentStateRepository(DtSimObjectStateRepository* repository);
52 
54  virtual DtSimObjectStateRepository* clone(const DtString& rwName = DtString::nullString(),
55  DtReaderWriterRegistry* parentRegistry = 0) const;
56 
57  virtual DtString type() const;
58 
59  virtual bool createParameters();
60  virtual void initializeFromParameters();
61  virtual const DtGlobalEnvironmentParameters* globalEnvironmentParameters() const;
62 
64 
65  virtual void setAirTurbidity(double value);
66  virtual double airTurbidity() const;
68 
70 
71  virtual void setAmbientAirTemperature(double value);
72  virtual double ambientAirTemperature() const;
74 
76 
77  virtual void setCloudState(DtVrfWeatherCloudState current);
78  virtual DtVrfWeatherCloudState cloudState() const;
80 
82 
83  virtual void setPrecipitationIntensity(double value);
84  virtual double precipitationIntensity() const;
86 
88 
89  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType value);
90  virtual DtVrfWeatherPrecipitationType precipitationType() const;
92 
94 
95  virtual void setWindSpeed(double value);
96  virtual double windSpeed() const;
98 
100 
101  virtual void setWindDirection(double value);
102  virtual double windDirection() const;
104 
106 
107  virtual void setVisibility(double value);
108  virtual double visibility() const;
110 
112 
113  virtual void setIllumination(double value);
114  virtual double illumination() const;
116 
118 
119 
120  virtual void setTimeOfDay(double value);
121  virtual double timeOfDay() const;
123  virtual DtString timeOfDayString() const;
125 
127 
128  virtual void setTimeOfDayAdvancementSpeed(double value);
129  virtual double timeOfDayAdvancementSpeed() const;
131 
133 
134  virtual void setUnderwaterVisibility(double underwaterVisibility);
135  virtual double underwaterVisibility() const;
137 
139 
140  virtual void setSurfaceTransparency(double transparency);
141  virtual double surfaceTransparency() const;
143 
145 
146  virtual void setWaterCurrentSpeed(double waterCurrentSpeed);
147  virtual double waterCurrentSpeed() const;
149 
151 
152  virtual void setWaterCurrentDirection(double waterCurrentDirection);
153  virtual double waterCurrentDirection() const;
155 
157 
158  virtual void setAmbientWaterTemperature(double waterTemperature);
159  virtual double ambientWaterTemperature() const;
161 
163 
164  virtual void setTidalOffset(double tidalOffset);
165  virtual double tidalOffset() const;
167 
170 
171  virtual void setTidalDirection(bool tidalDirection);
172  virtual bool tidalDirection() const;
174 
176 
177  virtual void setSwellState(unsigned int state);
178  virtual unsigned int swellState() const;
180 
182 
183  virtual void setSwellStateDirection(double direction);
184  virtual double swellStateDirection() const;
186 
188 
189  virtual void setSeaState(unsigned int state);
190  virtual unsigned int seaState() const;
192 
194 
195  virtual void setSeaStateDirection(double direction);
196  virtual double seaStateDirection() const;
198 
200 
201  virtual void setWindDrivenSeaStateEnabled(bool b);
202  virtual bool windDrivenSeaStateEnabled() const;
204 
206 
207  virtual void setChoppiness(double choppiness);
208  virtual double choppiness() const;
210 
212 
213  virtual void setSurgeDepth(double depth);
214  virtual double surgeDepth() const;
216 
219 
220  virtual void setThermoclineLayer1Depth(double depth);
221  virtual double thermoclineLayer1Depth() const;
222  virtual void setThermoclineLayer1Permeability(double depth);
223  virtual double thermoclineLayer1Permeability() const;
224  virtual void setThermoclineLayer2Depth(double depth);
225  virtual double thermoclineLayer2Depth() const;
226  virtual void setThermoclineLayer2Permeability(double depth);
227  virtual double thermoclineLayer2Permeability() const;
228  virtual void setThermoclineLayer3Depth(double depth);
229  virtual double thermoclineLayer3Depth() const;
230  virtual void setThermoclineLayer3Permeability(double depth);
231  virtual double thermoclineLayer3Permeability() const;
232  virtual void setThermoclineLayer4Depth(double depth);
233  virtual double thermoclineLayer4Depth() const;
234  virtual void setThermoclineLayer4Permeability(double depth);
235  virtual double thermoclineLayer4Permeability() const;
236  virtual void setThermoclineLayer5Depth(double depth);
237  virtual double thermoclineLayer5Depth() const;
238  virtual void setThermoclineLayer5Permeability(double depth);
239  virtual double thermoclineLayer5Permeability() const;
241 
242 private:
244  DtGlobalEnvironmentStateRepository();
245 
246 protected:
249 
250 
254  DtRwReal myAirTurbidity;
255 
259  DtRwReal myAmbientAirTemperature;
260 
265  DtRwInt myCloudState;
266 
270  DtRwReal myPrecipitationIntensity;
271 
276  DtRwInt myPrecipitationType;
277 
282  DtRwReal myWindSpeed;
283 
288  DtRwReal myWindDirection;
289 
293  DtRwReal myIlluminationPercentage;
294 
296  DtRwReal myTimeOfDay;
297 
302  DtRwReal myTimeOfDayAdvancementSpeed;
303 
308  DtRwReal myVisibility;
309 
315  DtRwReal myUnderwaterVisibility;
316 
321  DtRwReal mySurfaceTransparency;
322 
327  DtRwReal myWaterCurrentSpeed;
328 
333  DtRwReal myWaterCurrentDirection;
334 
339  DtRwReal myAmbientWaterTemperature;
340 
346  DtRwReal myTidalOffset;
347 
352  DtRwBoolean myTidalDirection;
353 
358  DtRwInt mySwellState;
359 
364  DtRwReal mySwellStateDirection;
365 
370  DtRwInt mySeaState;
371 
376  DtRwReal mySeaStateDirection;
377 
383  DtRwBoolean myWindDrivenSeaStateEnabled;
384 
389  DtRwReal myChoppiness;
390 
395  DtRwReal mySurgeDepth;
396 
402  DtRwReal myThermoclineLayer1Depth;
403 
409  DtRwReal myThermoclineLayer1Permeability;
410 
416  DtRwReal myThermoclineLayer2Depth;
417  DtRwReal myThermoclineLayer2Permeability;
418 
424  DtRwReal myThermoclineLayer3Depth;
425  DtRwReal myThermoclineLayer3Permeability;
426 
432  DtRwReal myThermoclineLayer4Depth;
433  DtRwReal myThermoclineLayer4Permeability;
434 
440  DtRwReal myThermoclineLayer5Depth;
441  DtRwReal myThermoclineLayer5Permeability;
443 };
444 
Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)