VR-Forces Development_Version 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) 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/rwUUID.h"
21 
27 class DT_DLL_vrfplan DtChangeWeatherCommand : public DtSimCommand
28 {
29 public:
30 
32  DtChangeWeatherCommand();
33 
35  DtChangeWeatherCommand(const DtString& writeName,
36  DtReaderWriterRegistry* parentRegistry = NULL);
37 
39  DtChangeWeatherCommand(const DtString & writeName, const DtChangeWeatherCommand& orig,
40  DtReaderWriterRegistry* parentRegistry = NULL);
41 
43  virtual ~DtChangeWeatherCommand();
44 
46  DtChangeWeatherCommand& operator=(const DtChangeWeatherCommand& orig);
47 
49  virtual const DtSimCommandMessageType& type() const;
50 
52  virtual DtSimCommand * clone(const DtString & name, DtReaderWriterRegistry *
53  parentRegistry = 0) const;
54 
55  virtual int netRepSize() const;
56  virtual bool setFromNet(const char* contentBuffer,
57  unsigned contentSize);
58  virtual bool setToNet();
59 
61 
62  virtual void setAirTurbidity(double factor);
63  virtual double airTurbidity() const;
65  virtual bool airTurbiditySpecified() const;
67  virtual void clearAirTurbidity();
69 
71 
72  virtual void setAmbientAirTemperature(double factor);
73  virtual double ambientAirTemperature() const;
75  virtual bool ambientAirTemperatureSpecified() const;
77  virtual void clearAmbientAirTemperature();
79 
81 
82  virtual void setCloudState(DtVrfWeatherCloudState type);
83  virtual DtVrfWeatherCloudState cloudState() const;
85  virtual bool cloudStateSpecified() const;
87  virtual void clearCloudState();
89 
91 
92  virtual void setPrecipitationIntensity(double factor);
93  virtual double precipitationIntensity() const;
95  virtual bool precipitationIntensitySpecified() const;
97  virtual void clearPrecipitationIntensity();
99 
101 
102  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType type);
103  virtual DtVrfWeatherPrecipitationType precipitationType() const;
105  virtual bool precipitationTypeSpecified() const;
107  virtual void clearPrecipitationType();
109 
111 
112  virtual void setVisibility(double distance);
113  virtual double visibility() const;
115  virtual bool visibilitySpecified() const;
117  virtual void clearVisibility();
119 
121 
122  virtual void setWindDirection(double radians);
123  virtual double windDirection() const;
125  virtual bool windDirectionSpecified() const;
127  virtual void clearWindDirection();
129 
131 
132  virtual void setWindSpeed(double value);
133  virtual double windSpeed() const;
135  virtual bool windSpeedSpecified() const;
137  virtual void clearWindSpeed();
139 
141 
142  virtual void setUnderwaterVisibility(double underwaterVisibility);
143  virtual double underwaterVisibility() const;
146  virtual bool underwaterVisibilitySpecified() const;
148  virtual void clearUnderwaterVisibility();
150 
152 
153  virtual void setSurfaceTransparency(double transparency);
154  virtual double surfaceTransparency() const;
157  virtual bool surfaceTransparencySpecified() const;
159  virtual void clearSurfaceTransparency();
161 
163 
164  virtual void setWaterCurrentSpeed(double waterCurrentSpeed);
165  virtual double waterCurrentSpeed() const;
167  virtual bool waterCurrentSpeedSpecified() const;
169  virtual void clearWaterCurrentSpeed();
171 
173 
174  virtual void setWaterCurrentDirection(double waterCurrentDirection);
175  virtual double waterCurrentDirection() const;
177  virtual bool waterCurrentDirectionSpecified() const;
179  virtual void clearWaterCurrentDirection();
181 
183 
184  virtual void setAmbientWaterTemperature(double waterTemperature);
185  virtual double ambientWaterTemperature() const;
188  virtual bool ambientWaterTemperatureSpecified() const;
190  virtual void clearAmbientWaterTemperature();
192 
194 
195  virtual void setTidalOffset(double tidalOffset);
196  virtual double tidalOffset() const;
198  virtual bool tidalOffsetSpecified() const;
200  virtual void clearTidalOffset();
202 
205 
206  virtual void setTidalDirection(bool tidalDirection);
207  virtual bool tidalDirection() const;
209  virtual bool tidalDirectionSpecified() const;
211  virtual void clearTidalDirection();
213 
215 
216  virtual void setSwellState(unsigned int state);
217  virtual unsigned int swellState() const;
218  virtual bool swellStateSpecified() const;
219  virtual void clearSwellState();
221 
223 
224  virtual void setSwellStateDirection(double direction);
225  virtual double swellStateDirection() const;
226  virtual bool swellStateDirectionSpecified() const;
227  virtual void clearSwellStateDirection();
229 
231 
232  virtual void setSeaState(unsigned int state);
233  virtual unsigned int seaState() const;
234  virtual bool seaStateSpecified() const;
235  virtual void clearSeaState();
237 
239 
240  virtual void setSeaStateDirection(double direction);
241  virtual double seaStateDirection() const;
242  virtual bool seaStateDirectionSpecified() const;
243  virtual void clearSeaStateDirection();
245 
248  virtual void setWindDrivenSeaStateEnabled(bool enabled);
249  virtual bool windDrivenSeaStateEnabled() const;
250  virtual bool windDrivenSeaStateEnabledSpecified() const;
251  virtual void clearWindDrivenSeaStateEnabled();
253 
255 
256  virtual void setChoppiness(double choppiness);
257  virtual double choppiness() const;
258  virtual bool choppinessSpecified() const;
259  virtual void clearChoppiness();
261 
263 
264  virtual void setSurgeDepth(double depth);
265  virtual double surgeDepth() const;
266  virtual bool surgeDepthSpecified() const;
267  virtual void clearSurgeDepth();
269 
272 
273  virtual void setThermoclineLayer1Depth(double depth);
274  virtual double thermoclineLayer1Depth() const;
275  virtual bool thermoclineLayer1DepthSpecified() const;
276  virtual void clearThermoclineLayer1Depth();
277  virtual void setThermoclineLayer1Permeability(double depth);
278  virtual double thermoclineLayer1Permeability() const;
279  virtual bool thermoclineLayer1PermeabilitySpecified() const;
280  virtual void clearThermoclineLayer1Permeability();
281 
282  virtual void setThermoclineLayer2Depth(double depth);
283  virtual double thermoclineLayer2Depth() const;
284  virtual bool thermoclineLayer2DepthSpecified() const;
285  virtual void clearThermoclineLayer2Depth();
286  virtual void setThermoclineLayer2Permeability(double depth);
287  virtual double thermoclineLayer2Permeability() const;
288  virtual bool thermoclineLayer2PermeabilitySpecified() const;
289  virtual void clearThermoclineLayer2Permeability();
290 
291  virtual void setThermoclineLayer3Depth(double depth);
292  virtual double thermoclineLayer3Depth() const;
293  virtual bool thermoclineLayer3DepthSpecified() const;
294  virtual void clearThermoclineLayer3Depth();
295  virtual void setThermoclineLayer3Permeability(double depth);
296  virtual double thermoclineLayer3Permeability() const;
297  virtual bool thermoclineLayer3PermeabilitySpecified() const;
298  virtual void clearThermoclineLayer3Permeability();
299 
300  virtual void setThermoclineLayer4Depth(double depth);
301  virtual double thermoclineLayer4Depth() const;
302  virtual bool thermoclineLayer4DepthSpecified() const;
303  virtual void clearThermoclineLayer4Depth();
304  virtual void setThermoclineLayer4Permeability(double depth);
305  virtual double thermoclineLayer4Permeability() const;
306  virtual bool thermoclineLayer4PermeabilitySpecified() const;
307  virtual void clearThermoclineLayer4Permeability();
308 
309  virtual void setThermoclineLayer5Depth(double depth);
310  virtual double thermoclineLayer5Depth() const;
311  virtual bool thermoclineLayer5DepthSpecified() const;
312  virtual void clearThermoclineLayer5Depth();
313  virtual void setThermoclineLayer5Permeability(double depth);
314  virtual double thermoclineLayer5Permeability() const;
315  virtual bool thermoclineLayer5PermeabilitySpecified() const;
316  virtual void clearThermoclineLayer5Permeability();
318 
324 
325  virtual void setGeneratedByRemoteWeatherSetter(bool value);
326  virtual bool generatedByRemoteWeatherSetter() const;
328 
330  virtual DtString stringRep() const;
331 
332  static DtSimCommand* creator();
333 
335  virtual void setUUID(const DtUUID&);
336  virtual const DtUUID& uuid() const;
337 
339  virtual void setPriority(int p);
340  virtual int priority() const;
341  virtual bool prioritySpecified() const;
342  virtual void clearPriority();
343 
344  virtual bool operator==(const DtChangeWeatherCommand&) const;
345  virtual bool operator!=(const DtChangeWeatherCommand& rhs) const
346  {
347  return !(*this == rhs);
348  }
349 
351  virtual void setAllValuesSpecified(bool);
352 
354  virtual bool fromXml(const DtString& s);
355  virtual bool fromXmlFile(const DtFilename& s);
356 
357 protected:
358  DtRwReal myAirTurbidity;
359  DtRwReal myAmbientAirTemperature;
360  DtRwInt myCloudState;
361  DtRwReal myPrecipitationIntensity;
362  DtRwInt myPrecipitationType;
363  DtRwReal myWindDirection;
364  DtRwReal myWindSpeed;
365  DtRwReal myVisibility;
366  DtRwReal myUnderwaterVisibility;
367  DtRwReal mySurfaceTransparency;
368  DtRwReal myWaterCurrentSpeed;
369  DtRwReal myWaterCurrentDirection;
370  DtRwReal myAmbientWaterTemperature;
371  DtRwReal myTidalOffset;
372  DtRwBoolean myTidalDirection;
373  DtRwInt mySwellState;
374  DtRwReal mySwellStateDirection;
375  DtRwInt mySeaState;
376  DtRwReal mySeaStateDirection;
377  DtRwBoolean myWindDrivenSeaStateEnabled;
378  DtRwReal myChoppiness;
379  DtRwReal mySurgeDepth;
380  DtRwReal myThermoclineLayer1Depth;
381  DtRwReal myThermoclineLayer1Permeability;
382  DtRwReal myThermoclineLayer2Depth;
383  DtRwReal myThermoclineLayer2Permeability;
384  DtRwReal myThermoclineLayer3Depth;
385  DtRwReal myThermoclineLayer3Permeability;
386  DtRwReal myThermoclineLayer4Depth;
387  DtRwReal myThermoclineLayer4Permeability;
388  DtRwReal myThermoclineLayer5Depth;
389  DtRwReal myThermoclineLayer5Permeability;
390  DtRwInt myPriority;
391 
392  DtRwBoolean myGeneratedByRemoteWeatherSetter;
393 
394  DtRwUUID myUUID;
395 };
396 
Document ID: Generated on Mon Jul 4 01:00:18 EDT 2016 from SVN revision 166489
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)