VR-Forces 4.2 Class Documentation
changeGlobalWeatherCommand.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2008 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
10 
11 #pragma once
12 
13 #include "vrfplan/simCommand.h"
14 #include "vrfplan/vrfplanDefines.h"
15 #include <vrfExtObjects/vrfWeatherStateEnums.h>
16 #include "vrfutil/rwReal.h"
17 #include "vrfutil/rwInt.h"
18 #include "vrfutil/rwBoolean.h"
19 
25 class DT_DLL_vrfplan DtChangeGlobalWeatherCommand : public DtSimCommand
26 {
27 public:
28 
30  DtChangeGlobalWeatherCommand();
31 
33  DtChangeGlobalWeatherCommand(const DtString& writeName,
34  DtReaderWriterRegistry* parentRegistry = NULL);
35 
37  DtChangeGlobalWeatherCommand(const DtString & writeName, const DtChangeGlobalWeatherCommand& orig,
38  DtReaderWriterRegistry* parentRegistry = NULL);
39 
41  virtual ~DtChangeGlobalWeatherCommand();
42 
44  DtChangeGlobalWeatherCommand& operator=(const DtChangeGlobalWeatherCommand& orig);
45 
47  virtual const DtSimCommandMessageType& type() const;
48 
50  virtual DtSimCommand * clone(const DtString & name, DtReaderWriterRegistry *
51  parentRegistry = 0) const;
52 
53  virtual int netRepSize() const;
54  virtual bool setFromNet(const char* contentBuffer,
55  unsigned contentSize);
56  virtual bool setToNet();
57 
59 
60  virtual void setAirTurbidity(double factor);
61  virtual double airTurbidity() const;
63  virtual bool airTurbiditySpecified() const;
65  virtual void clearAirTurbidity();
67 
69 
70  virtual void setAmbientAirTemperature(double factor);
71  virtual double ambientAirTemperature() const;
73  virtual bool ambientAirTemperatureSpecified() const;
75  virtual void clearAmbientAirTemperature();
77 
79 
80  virtual void setCloudState(DtVrfWeatherCloudState type);
81  virtual DtVrfWeatherCloudState cloudState() const;
83  virtual bool cloudStateSpecified() const;
85  virtual void clearCloudState();
87 
89 
90  virtual void setPrecipitationIntensity(double factor);
91  virtual double precipitationIntensity() const;
93  virtual bool precipitationIntensitySpecified() const;
95  virtual void clearPrecipitationIntensity();
97 
99 
100  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType type);
101  virtual DtVrfWeatherPrecipitationType precipitationType() const;
103  virtual bool precipitationTypeSpecified() const;
105  virtual void clearPrecipitationType();
107 
109 
110  virtual void setVisibility(double distance);
111  virtual double visibility() const;
113  virtual bool visibilitySpecified() const;
115  virtual void clearVisibility();
117 
119 
120  virtual void setWindDirection(double radians);
121  virtual double windDirection() const;
123  virtual bool windDirectionSpecified() const;
125  virtual void clearWindDirection();
127 
129 
130  virtual void setWindSpeed(double value);
131  virtual double windSpeed() const;
133  virtual bool windSpeedSpecified() const;
135  virtual void clearWindSpeed();
137 
139 
140  virtual void setUnderwaterVisibility(double underwaterVisibility);
141  virtual double underwaterVisibility() const;
144  virtual bool underwaterVisibilitySpecified() const;
146  virtual void clearUnderwaterVisibility();
148 
150 
151  virtual void setSurfaceTransparency(double transparency);
152  virtual double surfaceTransparency() const;
155  virtual bool surfaceTransparencySpecified() const;
157  virtual void clearSurfaceTransparency();
159 
161 
162  virtual void setWaterCurrentSpeed(double waterCurrentSpeed);
163  virtual double waterCurrentSpeed() const;
165  virtual bool waterCurrentSpeedSpecified() const;
167  virtual void clearWaterCurrentSpeed();
169 
171 
172  virtual void setWaterCurrentDirection(double waterCurrentDirection);
173  virtual double waterCurrentDirection() const;
175  virtual bool waterCurrentDirectionSpecified() const;
177  virtual void clearWaterCurrentDirection();
179 
181 
182  virtual void setAmbientWaterTemperature(double waterTemperature);
183  virtual double ambientWaterTemperature() const;
186  virtual bool ambientWaterTemperatureSpecified() const;
188  virtual void clearAmbientWaterTemperature();
190 
192 
193  virtual void setTidalOffset(double tidalOffset);
194  virtual double tidalOffset() const;
196  virtual bool tidalOffsetSpecified() const;
198  virtual void clearTidalOffset();
200 
203 
204  virtual void setTidalDirection(bool tidalDirection);
205  virtual bool tidalDirection() const;
207  virtual bool tidalDirectionSpecified() const;
209  virtual void clearTidalDirection();
211 
213 
214  virtual void setSwellState(unsigned int state);
215  virtual unsigned int swellState() const;
216  virtual bool swellStateSpecified() const;
217  virtual void clearSwellState();
219 
221 
222  virtual void setSwellStateDirection(double direction);
223  virtual double swellStateDirection() const;
224  virtual bool swellStateDirectionSpecified() const;
225  virtual void clearSwellStateDirection();
227 
229 
230  virtual void setSeaState(unsigned int state);
231  virtual unsigned int seaState() const;
232  virtual bool seaStateSpecified() const;
233  virtual void clearSeaState();
235 
237 
238  virtual void setSeaStateDirection(double direction);
239  virtual double seaStateDirection() const;
240  virtual bool seaStateDirectionSpecified() const;
241  virtual void clearSeaStateDirection();
243 
246  virtual void setWindDrivenSeaStateEnabled(bool enabled);
247  virtual bool windDrivenSeaStateEnabled() const;
248  virtual bool windDrivenSeaStateEnabledSpecified() const;
249  virtual void clearWindDrivenSeaStateEnabled();
251 
253 
254  virtual void setChoppiness(double choppiness);
255  virtual double choppiness() const;
256  virtual bool choppinessSpecified() const;
257  virtual void clearChoppiness();
259 
261 
262  virtual void setSurgeDepth(double depth);
263  virtual double surgeDepth() const;
264  virtual bool surgeDepthSpecified() const;
265  virtual void clearSurgeDepth();
267 
270 
271  virtual void setThermoclineLayer1Depth(double depth);
272  virtual double thermoclineLayer1Depth() const;
273  virtual bool thermoclineLayer1DepthSpecified() const;
274  virtual void clearThermoclineLayer1Depth();
275  virtual void setThermoclineLayer1Permeability(double depth);
276  virtual double thermoclineLayer1Permeability() const;
277  virtual bool thermoclineLayer1PermeabilitySpecified() const;
278  virtual void clearThermoclineLayer1Permeability();
279 
280  virtual void setThermoclineLayer2Depth(double depth);
281  virtual double thermoclineLayer2Depth() const;
282  virtual bool thermoclineLayer2DepthSpecified() const;
283  virtual void clearThermoclineLayer2Depth();
284  virtual void setThermoclineLayer2Permeability(double depth);
285  virtual double thermoclineLayer2Permeability() const;
286  virtual bool thermoclineLayer2PermeabilitySpecified() const;
287  virtual void clearThermoclineLayer2Permeability();
288 
289  virtual void setThermoclineLayer3Depth(double depth);
290  virtual double thermoclineLayer3Depth() const;
291  virtual bool thermoclineLayer3DepthSpecified() const;
292  virtual void clearThermoclineLayer3Depth();
293  virtual void setThermoclineLayer3Permeability(double depth);
294  virtual double thermoclineLayer3Permeability() const;
295  virtual bool thermoclineLayer3PermeabilitySpecified() const;
296  virtual void clearThermoclineLayer3Permeability();
297 
298  virtual void setThermoclineLayer4Depth(double depth);
299  virtual double thermoclineLayer4Depth() const;
300  virtual bool thermoclineLayer4DepthSpecified() const;
301  virtual void clearThermoclineLayer4Depth();
302  virtual void setThermoclineLayer4Permeability(double depth);
303  virtual double thermoclineLayer4Permeability() const;
304  virtual bool thermoclineLayer4PermeabilitySpecified() const;
305  virtual void clearThermoclineLayer4Permeability();
306 
307  virtual void setThermoclineLayer5Depth(double depth);
308  virtual double thermoclineLayer5Depth() const;
309  virtual bool thermoclineLayer5DepthSpecified() const;
310  virtual void clearThermoclineLayer5Depth();
311  virtual void setThermoclineLayer5Permeability(double depth);
312  virtual double thermoclineLayer5Permeability() const;
313  virtual bool thermoclineLayer5PermeabilitySpecified() const;
314  virtual void clearThermoclineLayer5Permeability();
316 
322 
323  virtual void setGeneratedByRemoteWeatherSetter(bool value);
324  virtual bool generatedByRemoteWeatherSetter() const;
326 
328  virtual DtString stringRep() const;
329 
330  static DtSimCommand* creator();
331 
332 protected:
333  DtRwReal myAirTurbidity;
334  DtRwReal myAmbientAirTemperature;
335  DtRwInt myCloudState;
336  DtRwReal myPrecipitationIntensity;
337  DtRwInt myPrecipitationType;
338  DtRwReal myWindDirection;
339  DtRwReal myWindSpeed;
340  DtRwReal myVisibility;
341  DtRwReal myUnderwaterVisibility;
342  DtRwReal mySurfaceTransparency;
343  DtRwReal myWaterCurrentSpeed;
344  DtRwReal myWaterCurrentDirection;
345  DtRwReal myAmbientWaterTemperature;
346  DtRwReal myTidalOffset;
347  DtRwBoolean myTidalDirection;
348  DtRwInt mySwellState;
349  DtRwReal mySwellStateDirection;
350  DtRwInt mySeaState;
351  DtRwReal mySeaStateDirection;
352  DtRwBoolean myWindDrivenSeaStateEnabled;
353  DtRwReal myChoppiness;
354  DtRwReal mySurgeDepth;
355  DtRwReal myThermoclineLayer1Depth;
356  DtRwReal myThermoclineLayer1Permeability;
357  DtRwReal myThermoclineLayer2Depth;
358  DtRwReal myThermoclineLayer2Permeability;
359  DtRwReal myThermoclineLayer3Depth;
360  DtRwReal myThermoclineLayer3Permeability;
361  DtRwReal myThermoclineLayer4Depth;
362  DtRwReal myThermoclineLayer4Permeability;
363  DtRwReal myThermoclineLayer5Depth;
364  DtRwReal myThermoclineLayer5Permeability;
365 
366  DtRwBoolean myGeneratedByRemoteWeatherSetter;
367 };
368 
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)