VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
changeWeatherCommand.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2014 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 
26 class DT_DLL_vrfplan DtChangeWeatherCommand : public DtSimCommand
27 {
28 public:
29 
31  DtChangeWeatherCommand();
32 
34  DtChangeWeatherCommand(const DtString& writeName,
35  DtReaderWriterRegistry* parentRegistry = NULL);
36 
38  DtChangeWeatherCommand(const DtString & writeName, const DtChangeWeatherCommand& orig,
39  DtReaderWriterRegistry* parentRegistry = NULL);
40 
42  virtual ~DtChangeWeatherCommand();
43 
45  DtChangeWeatherCommand& operator=(const DtChangeWeatherCommand& orig);
46 
48  virtual const DtSimCommandMessageType& type() const;
49 
51  virtual DtSimCommand * clone(const DtString & name, DtReaderWriterRegistry *
52  parentRegistry = 0) const;
53 
54  virtual int netRepSize() const;
55  virtual bool setFromNet(const char* contentBuffer,
56  unsigned contentSize);
57  virtual bool setToNet();
58 
60 
61  virtual void setAirTurbidity(double factor);
62  virtual double airTurbidity() const;
64  virtual bool airTurbiditySpecified() const;
66  virtual void clearAirTurbidity();
68 
70 
71  virtual void setAmbientAirTemperature(double factor);
72  virtual double ambientAirTemperature() const;
74  virtual bool ambientAirTemperatureSpecified() const;
76  virtual void clearAmbientAirTemperature();
78 
80 
81  virtual void setCloudState(DtVrfWeatherCloudState type);
82  virtual DtVrfWeatherCloudState cloudState() const;
84  virtual bool cloudStateSpecified() const;
86  virtual void clearCloudState();
88 
90 
91  virtual void setPrecipitationIntensity(double factor);
92  virtual double precipitationIntensity() const;
94  virtual bool precipitationIntensitySpecified() const;
96  virtual void clearPrecipitationIntensity();
98 
100 
101  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType type);
102  virtual DtVrfWeatherPrecipitationType precipitationType() const;
104  virtual bool precipitationTypeSpecified() const;
106  virtual void clearPrecipitationType();
108 
110 
111  virtual void setVisibility(double distance);
112  virtual double visibility() const;
114  virtual bool visibilitySpecified() const;
116  virtual void clearVisibility();
118 
120 
121  virtual void setWindDirection(double radians);
122  virtual double windDirection() const;
124  virtual bool windDirectionSpecified() const;
126  virtual void clearWindDirection();
128 
130 
131  virtual void setWindSpeed(double value);
132  virtual double windSpeed() const;
134  virtual bool windSpeedSpecified() const;
136  virtual void clearWindSpeed();
138 
140 
141  virtual void setUnderwaterVisibility(double underwaterVisibility);
142  virtual double underwaterVisibility() const;
145  virtual bool underwaterVisibilitySpecified() const;
147  virtual void clearUnderwaterVisibility();
149 
151 
152  virtual void setSurfaceTransparency(double transparency);
153  virtual double surfaceTransparency() const;
156  virtual bool surfaceTransparencySpecified() const;
158  virtual void clearSurfaceTransparency();
160 
162 
163  virtual void setWaterCurrentSpeed(double waterCurrentSpeed);
164  virtual double waterCurrentSpeed() const;
166  virtual bool waterCurrentSpeedSpecified() const;
168  virtual void clearWaterCurrentSpeed();
170 
172 
173  virtual void setWaterCurrentDirection(double waterCurrentDirection);
174  virtual double waterCurrentDirection() const;
176  virtual bool waterCurrentDirectionSpecified() const;
178  virtual void clearWaterCurrentDirection();
180 
182 
183  virtual void setAmbientWaterTemperature(double waterTemperature);
184  virtual double ambientWaterTemperature() const;
187  virtual bool ambientWaterTemperatureSpecified() const;
189  virtual void clearAmbientWaterTemperature();
191 
193 
194  virtual void setTidalOffset(double tidalOffset);
195  virtual double tidalOffset() const;
197  virtual bool tidalOffsetSpecified() const;
199  virtual void clearTidalOffset();
201 
204 
205  virtual void setTidalDirection(bool tidalDirection);
206  virtual bool tidalDirection() const;
208  virtual bool tidalDirectionSpecified() const;
210  virtual void clearTidalDirection();
212 
214 
215  virtual void setSwellState(unsigned int state);
216  virtual unsigned int swellState() const;
217  virtual bool swellStateSpecified() const;
218  virtual void clearSwellState();
220 
222 
223  virtual void setSwellStateDirection(double direction);
224  virtual double swellStateDirection() const;
225  virtual bool swellStateDirectionSpecified() const;
226  virtual void clearSwellStateDirection();
228 
230 
231  virtual void setSeaState(unsigned int state);
232  virtual unsigned int seaState() const;
233  virtual bool seaStateSpecified() const;
234  virtual void clearSeaState();
236 
238 
239  virtual void setSeaStateDirection(double direction);
240  virtual double seaStateDirection() const;
241  virtual bool seaStateDirectionSpecified() const;
242  virtual void clearSeaStateDirection();
244 
247  virtual void setWindDrivenSeaStateEnabled(bool enabled);
248  virtual bool windDrivenSeaStateEnabled() const;
249  virtual bool windDrivenSeaStateEnabledSpecified() const;
250  virtual void clearWindDrivenSeaStateEnabled();
252 
254 
255  virtual void setChoppiness(double choppiness);
256  virtual double choppiness() const;
257  virtual bool choppinessSpecified() const;
258  virtual void clearChoppiness();
260 
262 
263  virtual void setSurgeDepth(double depth);
264  virtual double surgeDepth() const;
265  virtual bool surgeDepthSpecified() const;
266  virtual void clearSurgeDepth();
268 
271 
272  virtual void setThermoclineLayer1Depth(double depth);
273  virtual double thermoclineLayer1Depth() const;
274  virtual bool thermoclineLayer1DepthSpecified() const;
275  virtual void clearThermoclineLayer1Depth();
276  virtual void setThermoclineLayer1Permeability(double depth);
277  virtual double thermoclineLayer1Permeability() const;
278  virtual bool thermoclineLayer1PermeabilitySpecified() const;
279  virtual void clearThermoclineLayer1Permeability();
280 
281  virtual void setThermoclineLayer2Depth(double depth);
282  virtual double thermoclineLayer2Depth() const;
283  virtual bool thermoclineLayer2DepthSpecified() const;
284  virtual void clearThermoclineLayer2Depth();
285  virtual void setThermoclineLayer2Permeability(double depth);
286  virtual double thermoclineLayer2Permeability() const;
287  virtual bool thermoclineLayer2PermeabilitySpecified() const;
288  virtual void clearThermoclineLayer2Permeability();
289 
290  virtual void setThermoclineLayer3Depth(double depth);
291  virtual double thermoclineLayer3Depth() const;
292  virtual bool thermoclineLayer3DepthSpecified() const;
293  virtual void clearThermoclineLayer3Depth();
294  virtual void setThermoclineLayer3Permeability(double depth);
295  virtual double thermoclineLayer3Permeability() const;
296  virtual bool thermoclineLayer3PermeabilitySpecified() const;
297  virtual void clearThermoclineLayer3Permeability();
298 
299  virtual void setThermoclineLayer4Depth(double depth);
300  virtual double thermoclineLayer4Depth() const;
301  virtual bool thermoclineLayer4DepthSpecified() const;
302  virtual void clearThermoclineLayer4Depth();
303  virtual void setThermoclineLayer4Permeability(double depth);
304  virtual double thermoclineLayer4Permeability() const;
305  virtual bool thermoclineLayer4PermeabilitySpecified() const;
306  virtual void clearThermoclineLayer4Permeability();
307 
308  virtual void setThermoclineLayer5Depth(double depth);
309  virtual double thermoclineLayer5Depth() const;
310  virtual bool thermoclineLayer5DepthSpecified() const;
311  virtual void clearThermoclineLayer5Depth();
312  virtual void setThermoclineLayer5Permeability(double depth);
313  virtual double thermoclineLayer5Permeability() const;
314  virtual bool thermoclineLayer5PermeabilitySpecified() const;
315  virtual void clearThermoclineLayer5Permeability();
317 
323 
324  virtual void setGeneratedByRemoteWeatherSetter(bool value);
325  virtual bool generatedByRemoteWeatherSetter() const;
327 
329  virtual DtString stringRep() const;
330 
331  static DtSimCommand* creator();
332 
334  virtual void setObjectName(const DtString&);
335  virtual const DtString& objectName() const;
336 
338  virtual void setPriority(int p);
339  virtual int priority() const;
340  virtual bool prioritySpecified() const;
341  virtual void clearPriority();
342 
343  virtual bool operator==(const DtChangeWeatherCommand&) const;
344  virtual bool operator!=(const DtChangeWeatherCommand& rhs) const
345  {
346  return !(*this == rhs);
347  }
348 
350  virtual void setAllValuesSpecified(bool);
351 
353  virtual bool fromXml(const DtString& s);
354  virtual bool fromXmlFile(const DtFilename& s);
355 
356 protected:
357  DtRwReal myAirTurbidity;
358  DtRwReal myAmbientAirTemperature;
359  DtRwInt myCloudState;
360  DtRwReal myPrecipitationIntensity;
361  DtRwInt myPrecipitationType;
362  DtRwReal myWindDirection;
363  DtRwReal myWindSpeed;
364  DtRwReal myVisibility;
365  DtRwReal myUnderwaterVisibility;
366  DtRwReal mySurfaceTransparency;
367  DtRwReal myWaterCurrentSpeed;
368  DtRwReal myWaterCurrentDirection;
369  DtRwReal myAmbientWaterTemperature;
370  DtRwReal myTidalOffset;
371  DtRwBoolean myTidalDirection;
372  DtRwInt mySwellState;
373  DtRwReal mySwellStateDirection;
374  DtRwInt mySeaState;
375  DtRwReal mySeaStateDirection;
376  DtRwBoolean myWindDrivenSeaStateEnabled;
377  DtRwReal myChoppiness;
378  DtRwReal mySurgeDepth;
379  DtRwReal myThermoclineLayer1Depth;
380  DtRwReal myThermoclineLayer1Permeability;
381  DtRwReal myThermoclineLayer2Depth;
382  DtRwReal myThermoclineLayer2Permeability;
383  DtRwReal myThermoclineLayer3Depth;
384  DtRwReal myThermoclineLayer3Permeability;
385  DtRwReal myThermoclineLayer4Depth;
386  DtRwReal myThermoclineLayer4Permeability;
387  DtRwReal myThermoclineLayer5Depth;
388  DtRwReal myThermoclineLayer5Permeability;
389  DtRwInt myPriority;
390 
391  DtRwBoolean myGeneratedByRemoteWeatherSetter;
392 
393  DtRwString myObjectName;
394 };
395 
Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)