VR-Forces 4.6.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
changeWeatherCommand.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2015 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 #include "vrfutil/rwString.h"
20 #include "vrfutil/rwVector.h"
21 #include "vrfutil/rwUUID.h"
22 
28 class DT_DLL_vrfplan DtChangeWeatherCommand : public DtSimCommand
29 {
30 public:
31 
33  DtChangeWeatherCommand();
34 
36  DtChangeWeatherCommand(const DtString& writeName,
37  DtReaderWriterRegistry* parentRegistry = NULL);
38 
40  DtChangeWeatherCommand(const DtString & writeName, const DtChangeWeatherCommand& orig,
41  DtReaderWriterRegistry* parentRegistry = NULL);
42 
44  virtual ~DtChangeWeatherCommand();
45 
47  DtChangeWeatherCommand& operator=(const DtChangeWeatherCommand& orig);
48 
50  virtual const DtSimCommandMessageType& type() const;
51 
53  virtual DtSimCommand * clone(const DtString & name, DtReaderWriterRegistry *
54  parentRegistry = 0) const;
55 
56  virtual int netRepSize() const;
57  virtual bool setFromNet(const char* contentBuffer,
58  unsigned contentSize);
59  virtual bool setToNet();
60 
62 
63  virtual void setAirTurbidity(double factor);
64  virtual double airTurbidity() const;
66  virtual bool airTurbiditySpecified() const;
68  virtual void clearAirTurbidity();
70 
72 
73  virtual void setAmbientAirTemperature(double factor);
74  virtual double ambientAirTemperature() const;
76  virtual bool ambientAirTemperatureSpecified() const;
78  virtual void clearAmbientAirTemperature();
80 
82 
83  virtual void setCloudState(DtVrfWeatherCloudState type);
84  virtual DtVrfWeatherCloudState cloudState() const;
86  virtual bool cloudStateSpecified() const;
88  virtual void clearCloudState();
90 
92 
93  virtual void setPrecipitationIntensity(double factor);
94  virtual double precipitationIntensity() const;
96  virtual bool precipitationIntensitySpecified() const;
98  virtual void clearPrecipitationIntensity();
100 
102 
103  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType type);
104  virtual DtVrfWeatherPrecipitationType precipitationType() const;
106  virtual bool precipitationTypeSpecified() const;
108  virtual void clearPrecipitationType();
110 
112 
113  virtual void setVisibility(double distance);
114  virtual double visibility() const;
116  virtual bool visibilitySpecified() const;
118  virtual void clearVisibility();
120 
122 
123  virtual void setWindDirection(double radians);
124  virtual double windDirection() const;
126  virtual bool windDirectionSpecified() const;
128  virtual void clearWindDirection();
130 
132 
133  virtual void setWindSpeed(double value);
134  virtual double windSpeed() const;
136  virtual bool windSpeedSpecified() const;
138  virtual void clearWindSpeed();
140 
142 
143  virtual void setUnderwaterVisibility(double underwaterVisibility);
144  virtual double underwaterVisibility() const;
147  virtual bool underwaterVisibilitySpecified() const;
149  virtual void clearUnderwaterVisibility();
151 
153 
154  virtual void setSurfaceTransparency(double transparency);
155  virtual double surfaceTransparency() const;
158  virtual bool surfaceTransparencySpecified() const;
160  virtual void clearSurfaceTransparency();
162 
164 
165  virtual void setWaterCurrentSpeed(double waterCurrentSpeed);
166  virtual double waterCurrentSpeed() const;
168  virtual bool waterCurrentSpeedSpecified() const;
170  virtual void clearWaterCurrentSpeed();
172 
174 
175  virtual void setWaterCurrentDirection(double waterCurrentDirection);
176  virtual double waterCurrentDirection() const;
178  virtual bool waterCurrentDirectionSpecified() const;
180  virtual void clearWaterCurrentDirection();
182 
184 
185  virtual void setAmbientWaterTemperature(double waterTemperature);
186  virtual double ambientWaterTemperature() const;
189  virtual bool ambientWaterTemperatureSpecified() const;
191  virtual void clearAmbientWaterTemperature();
193 
195 
196  virtual void setTidalOffset(double tidalOffset);
197  virtual double tidalOffset() const;
199  virtual bool tidalOffsetSpecified() const;
201  virtual void clearTidalOffset();
203 
206 
207  virtual void setTidalDirection(bool tidalDirection);
208  virtual bool tidalDirection() const;
210  virtual bool tidalDirectionSpecified() const;
212  virtual void clearTidalDirection();
214 
216 
217  virtual void setSwellState(unsigned int state);
218  virtual unsigned int swellState() const;
219  virtual bool swellStateSpecified() const;
220  virtual void clearSwellState();
222 
224 
225  virtual void setSwellStateDirection(double direction);
226  virtual double swellStateDirection() const;
227  virtual bool swellStateDirectionSpecified() const;
228  virtual void clearSwellStateDirection();
230 
232 
233  virtual void setSeaState(unsigned int state);
234  virtual unsigned int seaState() const;
235  virtual bool seaStateSpecified() const;
236  virtual void clearSeaState();
238 
240 
241  virtual void setSeaStateDirection(double direction);
242  virtual double seaStateDirection() const;
243  virtual bool seaStateDirectionSpecified() const;
244  virtual void clearSeaStateDirection();
246 
249  virtual void setWindDrivenSeaStateEnabled(bool enabled);
250  virtual bool windDrivenSeaStateEnabled() const;
251  virtual bool windDrivenSeaStateEnabledSpecified() const;
252  virtual void clearWindDrivenSeaStateEnabled();
254 
256 
257  virtual void setChoppiness(double choppiness);
258  virtual double choppiness() const;
259  virtual bool choppinessSpecified() const;
260  virtual void clearChoppiness();
262 
264 
265  virtual void setSurgeDepth(double depth);
266  virtual double surgeDepth() const;
267  virtual bool surgeDepthSpecified() const;
268  virtual void clearSurgeDepth();
270 
272 
273  virtual void setFogHeight(double depth);
274  virtual double fogHeight() const;
275  virtual bool fogHeightSpecified() const;
276  virtual void clearFogHeight();
278 
280 
281  virtual void setFogColor(const DtVector&);
282  virtual const DtVector& fogColor() const;
283  virtual bool fogColorSpecified() const;
284  virtual void clearFogColor();
286 
289 
290  virtual void setThermoclineLayer1Depth(double depth);
291  virtual double thermoclineLayer1Depth() const;
292  virtual bool thermoclineLayer1DepthSpecified() const;
293  virtual void clearThermoclineLayer1Depth();
294  virtual void setThermoclineLayer1Permeability(double depth);
295  virtual double thermoclineLayer1Permeability() const;
296  virtual bool thermoclineLayer1PermeabilitySpecified() const;
297  virtual void clearThermoclineLayer1Permeability();
298 
299  virtual void setThermoclineLayer2Depth(double depth);
300  virtual double thermoclineLayer2Depth() const;
301  virtual bool thermoclineLayer2DepthSpecified() const;
302  virtual void clearThermoclineLayer2Depth();
303  virtual void setThermoclineLayer2Permeability(double depth);
304  virtual double thermoclineLayer2Permeability() const;
305  virtual bool thermoclineLayer2PermeabilitySpecified() const;
306  virtual void clearThermoclineLayer2Permeability();
307 
308  virtual void setThermoclineLayer3Depth(double depth);
309  virtual double thermoclineLayer3Depth() const;
310  virtual bool thermoclineLayer3DepthSpecified() const;
311  virtual void clearThermoclineLayer3Depth();
312  virtual void setThermoclineLayer3Permeability(double depth);
313  virtual double thermoclineLayer3Permeability() const;
314  virtual bool thermoclineLayer3PermeabilitySpecified() const;
315  virtual void clearThermoclineLayer3Permeability();
316 
317  virtual void setThermoclineLayer4Depth(double depth);
318  virtual double thermoclineLayer4Depth() const;
319  virtual bool thermoclineLayer4DepthSpecified() const;
320  virtual void clearThermoclineLayer4Depth();
321  virtual void setThermoclineLayer4Permeability(double depth);
322  virtual double thermoclineLayer4Permeability() const;
323  virtual bool thermoclineLayer4PermeabilitySpecified() const;
324  virtual void clearThermoclineLayer4Permeability();
325 
326  virtual void setThermoclineLayer5Depth(double depth);
327  virtual double thermoclineLayer5Depth() const;
328  virtual bool thermoclineLayer5DepthSpecified() const;
329  virtual void clearThermoclineLayer5Depth();
330  virtual void setThermoclineLayer5Permeability(double depth);
331  virtual double thermoclineLayer5Permeability() const;
332  virtual bool thermoclineLayer5PermeabilitySpecified() const;
333  virtual void clearThermoclineLayer5Permeability();
335 
341 
342  virtual void setGeneratedByRemoteWeatherSetter(bool value);
343  virtual bool generatedByRemoteWeatherSetter() const;
345 
347  virtual DtString stringRep() const;
348 
349  static DtSimCommand* creator();
350 
352  virtual void setUUID(const DtUUID&);
353  virtual const DtUUID& uuid() const;
354 
356  virtual void setPriority(int p);
357  virtual int priority() const;
358  virtual bool prioritySpecified() const;
359  virtual void clearPriority();
360 
361  virtual bool operator==(const DtChangeWeatherCommand&) const;
362  virtual bool operator!=(const DtChangeWeatherCommand& rhs) const
363  {
364  return !(*this == rhs);
365  }
366 
368  virtual void setAllValuesSpecified(bool);
369 
371  virtual bool fromXml(const DtString& s);
372  virtual bool fromXmlFile(const DtFilename& s);
373 
374 protected:
375  DtRwReal myAirTurbidity;
376  DtRwReal myAmbientAirTemperature;
377  DtRwInt myCloudState;
378  DtRwReal myPrecipitationIntensity;
379  DtRwInt myPrecipitationType;
380  DtRwReal myWindDirection;
381  DtRwReal myWindSpeed;
382  DtRwReal myVisibility;
383  DtRwReal myUnderwaterVisibility;
384  DtRwReal mySurfaceTransparency;
385  DtRwReal myWaterCurrentSpeed;
386  DtRwReal myWaterCurrentDirection;
387  DtRwReal myAmbientWaterTemperature;
388  DtRwReal myTidalOffset;
389  DtRwBoolean myTidalDirection;
390  DtRwInt mySwellState;
391  DtRwReal mySwellStateDirection;
392  DtRwInt mySeaState;
393  DtRwReal mySeaStateDirection;
394  DtRwBoolean myWindDrivenSeaStateEnabled;
395  DtRwReal myChoppiness;
396  DtRwReal mySurgeDepth;
397  DtRwReal myThermoclineLayer1Depth;
398  DtRwReal myThermoclineLayer1Permeability;
399  DtRwReal myThermoclineLayer2Depth;
400  DtRwReal myThermoclineLayer2Permeability;
401  DtRwReal myThermoclineLayer3Depth;
402  DtRwReal myThermoclineLayer3Permeability;
403  DtRwReal myThermoclineLayer4Depth;
404  DtRwReal myThermoclineLayer4Permeability;
405  DtRwReal myThermoclineLayer5Depth;
406  DtRwReal myThermoclineLayer5Permeability;
407  DtRwInt myPriority;
408 
409  DtRwReal myFogHeight;
410  DtRwVector myFogColor;
411 
412  DtRwBoolean myGeneratedByRemoteWeatherSetter;
413 
414  DtRwUUID myUUID;
415 };
416 
Document ID: Generated on Wed Jul 25 16:57:45 EDT 2018 from SVN revision 190790
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)