VR-Forces 4.8 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 <readerWriter/rwReal.h>
17 #include <readerWriter/rwInt.h>
18 #include <readerWriter/rwBoolean.h>
19 #include <readerWriter/rwString.h>
20 #include "readerWriter/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 
288 
289  virtual void setSnowAccumulation(double snow);
290  virtual double snowAccumulation() const;
291  virtual bool snowAccumulationSpecified() const;
292  virtual void clearSnowAccumulation();
294 
296 
297  virtual void setSnowMinimumAltitude(double snow);
298  virtual double snowMinimumAltitude() const;
299  virtual bool snowMinimumAltitudeSpecified() const;
300  virtual void clearSnowMinimumAltitude();
302 
304 
305  virtual void setSnowRoadAccumulation(double snow);
306  virtual double snowRoadAccumulation() const;
307  virtual bool snowRoadAccumulationSpecified() const;
308  virtual void clearSnowRoadAccumulation();
310 
312 
313  virtual void setRainAccumulation(double rain);
314  virtual double rainAccumulation() const;
315  virtual bool rainAccumulationSpecified() const;
316  virtual void clearRainAccumulation();
318 
321 
322  virtual void setThermoclineLayer1Depth(double depth);
323  virtual double thermoclineLayer1Depth() const;
324  virtual bool thermoclineLayer1DepthSpecified() const;
325  virtual void clearThermoclineLayer1Depth();
326  virtual void setThermoclineLayer1Permeability(double depth);
327  virtual double thermoclineLayer1Permeability() const;
328  virtual bool thermoclineLayer1PermeabilitySpecified() const;
329  virtual void clearThermoclineLayer1Permeability();
330 
331  virtual void setThermoclineLayer2Depth(double depth);
332  virtual double thermoclineLayer2Depth() const;
333  virtual bool thermoclineLayer2DepthSpecified() const;
334  virtual void clearThermoclineLayer2Depth();
335  virtual void setThermoclineLayer2Permeability(double depth);
336  virtual double thermoclineLayer2Permeability() const;
337  virtual bool thermoclineLayer2PermeabilitySpecified() const;
338  virtual void clearThermoclineLayer2Permeability();
339 
340  virtual void setThermoclineLayer3Depth(double depth);
341  virtual double thermoclineLayer3Depth() const;
342  virtual bool thermoclineLayer3DepthSpecified() const;
343  virtual void clearThermoclineLayer3Depth();
344  virtual void setThermoclineLayer3Permeability(double depth);
345  virtual double thermoclineLayer3Permeability() const;
346  virtual bool thermoclineLayer3PermeabilitySpecified() const;
347  virtual void clearThermoclineLayer3Permeability();
348 
349  virtual void setThermoclineLayer4Depth(double depth);
350  virtual double thermoclineLayer4Depth() const;
351  virtual bool thermoclineLayer4DepthSpecified() const;
352  virtual void clearThermoclineLayer4Depth();
353  virtual void setThermoclineLayer4Permeability(double depth);
354  virtual double thermoclineLayer4Permeability() const;
355  virtual bool thermoclineLayer4PermeabilitySpecified() const;
356  virtual void clearThermoclineLayer4Permeability();
357 
358  virtual void setThermoclineLayer5Depth(double depth);
359  virtual double thermoclineLayer5Depth() const;
360  virtual bool thermoclineLayer5DepthSpecified() const;
361  virtual void clearThermoclineLayer5Depth();
362  virtual void setThermoclineLayer5Permeability(double depth);
363  virtual double thermoclineLayer5Permeability() const;
364  virtual bool thermoclineLayer5PermeabilitySpecified() const;
365  virtual void clearThermoclineLayer5Permeability();
367 
373 
374  virtual void setGeneratedByRemoteWeatherSetter(bool value);
375  virtual bool generatedByRemoteWeatherSetter() const;
377 
379  virtual DtString stringRep() const;
380 
381  static DtSimCommand* creator();
382 
384  virtual void setUUID(const DtUUID&);
385  virtual const DtUUID& uuid() const;
386 
388  virtual void setPriority(int p);
389  virtual int priority() const;
390  virtual bool prioritySpecified() const;
391  virtual void clearPriority();
392 
393  virtual bool operator==(const DtChangeWeatherCommand&) const;
394  virtual bool operator!=(const DtChangeWeatherCommand& rhs) const
395  {
396  return !(*this == rhs);
397  }
398 
400  virtual void setAllValuesSpecified(bool);
401 
403  virtual bool fromXml(const DtString& s);
404  virtual bool fromXmlFile(const DtFilename& s);
405 
406 protected:
407  DtRwReal myAirTurbidity;
408  DtRwReal myAmbientAirTemperature;
409  DtRwInt myCloudState;
410  DtRwReal myPrecipitationIntensity;
411  DtRwInt myPrecipitationType;
412  DtRwReal myWindDirection;
413  DtRwReal myWindSpeed;
414  DtRwReal myVisibility;
415  DtRwReal myUnderwaterVisibility;
416  DtRwReal mySurfaceTransparency;
417  DtRwReal myWaterCurrentSpeed;
418  DtRwReal myWaterCurrentDirection;
419  DtRwReal myAmbientWaterTemperature;
420  DtRwReal myTidalOffset;
421  DtRwBoolean myTidalDirection;
422  DtRwInt mySwellState;
423  DtRwReal mySwellStateDirection;
424  DtRwInt mySeaState;
425  DtRwReal mySeaStateDirection;
426  DtRwBoolean myWindDrivenSeaStateEnabled;
427  DtRwReal myChoppiness;
428  DtRwReal mySurgeDepth;
429  DtRwReal myThermoclineLayer1Depth;
430  DtRwReal myThermoclineLayer1Permeability;
431  DtRwReal myThermoclineLayer2Depth;
432  DtRwReal myThermoclineLayer2Permeability;
433  DtRwReal myThermoclineLayer3Depth;
434  DtRwReal myThermoclineLayer3Permeability;
435  DtRwReal myThermoclineLayer4Depth;
436  DtRwReal myThermoclineLayer4Permeability;
437  DtRwReal myThermoclineLayer5Depth;
438  DtRwReal myThermoclineLayer5Permeability;
439  DtRwInt myPriority;
440 
441  DtRwReal myFogHeight;
442  DtRwVector myFogColor;
443 
444  DtRwReal mySnowAccumulation;
445  DtRwReal mySnowMinimumAltitude;
446  DtRwReal mySnowRoadAccumulation;
447 
448  DtRwReal myRainAccumulation;
449 
450  DtRwBoolean myGeneratedByRemoteWeatherSetter;
451 
452  DtRwUUID myUUID;
453 };
454 
DtReaderWriter::operator==
bool operator==(const DtReaderWriter &) const
Equivalence operator.
DtUUID
UUID is a unique ID wrapper class.
Definition: rwUUID.h:222
DtVrfWeatherPrecipitationType
DtVrfWeatherPrecipitationType
Definition: vrfWeatherStateEnums.h:18
DtChangeWeatherCommand::myThermoclineLayer1Depth
DtRwReal myThermoclineLayer1Depth
Definition: changeWeatherCommand.h:429
DtChangeWeatherCommand::myWindSpeed
DtRwReal myWindSpeed
Definition: changeWeatherCommand.h:413
DtChangeWeatherCommand::myUUID
DtRwUUID myUUID
Definition: changeWeatherCommand.h:452
DtChangeWeatherCommand::myThermoclineLayer3Permeability
DtRwReal myThermoclineLayer3Permeability
Definition: changeWeatherCommand.h:434
DtChangeWeatherCommand::myTidalDirection
DtRwBoolean myTidalDirection
Definition: changeWeatherCommand.h:421
DtChangeWeatherCommand::mySurfaceTransparency
DtRwReal mySurfaceTransparency
Definition: changeWeatherCommand.h:416
DtReaderWriter::fromXmlFile
virtual bool fromXmlFile(const DtFilename &)
Restores object from given xml file.
DtChangeWeatherCommand::myRainAccumulation
DtRwReal myRainAccumulation
Definition: changeWeatherCommand.h:448
DtChangeWeatherCommand::myThermoclineLayer2Depth
DtRwReal myThermoclineLayer2Depth
Definition: changeWeatherCommand.h:431
DtSimCommand::setToNet
virtual bool setToNet()
Calls netRep() to create the network buffer.
DtChangeWeatherCommand::myThermoclineLayer4Permeability
DtRwReal myThermoclineLayer4Permeability
Definition: changeWeatherCommand.h:436
DtChangeWeatherCommand::myThermoclineLayer2Permeability
DtRwReal myThermoclineLayer2Permeability
Definition: changeWeatherCommand.h:432
DtChangeWeatherCommand::myThermoclineLayer5Depth
DtRwReal myThermoclineLayer5Depth
Definition: changeWeatherCommand.h:437
DtChangeWeatherCommand::myThermoclineLayer4Depth
DtRwReal myThermoclineLayer4Depth
Definition: changeWeatherCommand.h:435
DtChangeWeatherCommand::myTidalOffset
DtRwReal myTidalOffset
Definition: changeWeatherCommand.h:420
DtSimCommand::stringRep
virtual DtString stringRep() const =0
Returns a human-readable string representation of the command.
DtReaderWriterRegistry
Definition: readerWriterRegistry.h:39
DtChangeWeatherCommand::myWaterCurrentDirection
DtRwReal myWaterCurrentDirection
Definition: changeWeatherCommand.h:418
DtChangeWeatherCommand::mySnowAccumulation
DtRwReal mySnowAccumulation
Definition: changeWeatherCommand.h:444
DtChangeWeatherCommand::myCloudState
DtRwInt myCloudState
Definition: changeWeatherCommand.h:409
DtChangeWeatherCommand::myPriority
DtRwInt myPriority
Definition: changeWeatherCommand.h:439
DtChangeWeatherCommand::mySurgeDepth
DtRwReal mySurgeDepth
Definition: changeWeatherCommand.h:428
DtChangeWeatherCommand::myAirTurbidity
DtRwReal myAirTurbidity
Definition: changeWeatherCommand.h:407
DtReaderWriter::fromXml
virtual bool fromXml(const DtString &)
Restores object from given xml string. Returns true if valid.
DtRwUUID
Description: Readable, Writable uuid string.
Definition: rwUUID.h:419
DtChangeWeatherCommand::myWaterCurrentSpeed
DtRwReal myWaterCurrentSpeed
Definition: changeWeatherCommand.h:417
DtChangeWeatherCommand::myPrecipitationIntensity
DtRwReal myPrecipitationIntensity
Definition: changeWeatherCommand.h:410
DtChangeWeatherCommand::myVisibility
DtRwReal myVisibility
Definition: changeWeatherCommand.h:414
DtChangeWeatherCommand::myThermoclineLayer3Depth
DtRwReal myThermoclineLayer3Depth
Definition: changeWeatherCommand.h:433
DtRwVector
Definition: rwVector.h:23
DtChangeWeatherCommand::mySeaStateDirection
DtRwReal mySeaStateDirection
Definition: changeWeatherCommand.h:425
makVrv::vrvTacticalGraphicUtilities::distance
DT_DLL_VRVCORE double distance(const makVrv::DtCoordinateSystem &, const DtVector &from, const DtVector &to)
Returns the distance from the two points.
DtChangeWeatherCommand::myThermoclineLayer1Permeability
DtRwReal myThermoclineLayer1Permeability
Definition: changeWeatherCommand.h:430
DtChangeWeatherCommand::myFogColor
DtRwVector myFogColor
Definition: changeWeatherCommand.h:442
DtSimCommand::netRepSize
virtual int netRepSize() const
Returns the size in bytes of the network representation of the class.
DtChangeWeatherCommand::mySnowRoadAccumulation
DtRwReal mySnowRoadAccumulation
Definition: changeWeatherCommand.h:446
DtSimCommand::setFromNet
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).
DtRwInt
Description: Readable, Writable int.
Definition: rwInt.h:25
DtChangeWeatherCommand::myAmbientAirTemperature
DtRwReal myAmbientAirTemperature
Definition: changeWeatherCommand.h:408
DtSimCommand::operator=
const DtSimCommand & operator=(const DtSimCommand &orig)
assignment operator; same as copy constructor
DtChangeWeatherCommand::mySnowMinimumAltitude
DtRwReal mySnowMinimumAltitude
Definition: changeWeatherCommand.h:445
DtSimCommand
DtSimCommand is an abstract base class from which commands can derive.
Definition: simCommand.h:32
DtChangeWeatherCommand
A DtSimCommand subclass which specifies a change to the weather settings for the specified weather ar...
Definition: changeWeatherCommand.h:28
DtChangeWeatherCommand::myUnderwaterVisibility
DtRwReal myUnderwaterVisibility
Definition: changeWeatherCommand.h:415
DtChangeWeatherCommand::myFogHeight
DtRwReal myFogHeight
Definition: changeWeatherCommand.h:441
DtChangeWeatherCommand::myThermoclineLayer5Permeability
DtRwReal myThermoclineLayer5Permeability
Definition: changeWeatherCommand.h:438
DtChangeWeatherCommand::myPrecipitationType
DtRwInt myPrecipitationType
Definition: changeWeatherCommand.h:411
DtRwReal
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
DtVrfWeatherCloudState
DtVrfWeatherCloudState
Definition: vrfWeatherStateEnums.h:28
DtChangeWeatherCommand::myChoppiness
DtRwReal myChoppiness
Definition: changeWeatherCommand.h:427
DtSimCommand::clone
virtual DtSimCommand * clone() const
Version of clone that preserves the existing name, and assigns a null parent registry.
DtChangeWeatherCommand::myWindDirection
DtRwReal myWindDirection
Definition: changeWeatherCommand.h:412
DtChangeWeatherCommand::myGeneratedByRemoteWeatherSetter
DtRwBoolean myGeneratedByRemoteWeatherSetter
Definition: changeWeatherCommand.h:450
DtRwBoolean
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DtChangeWeatherCommand::mySwellStateDirection
DtRwReal mySwellStateDirection
Definition: changeWeatherCommand.h:423
DtSimCommand::type
virtual const DtSimCommandMessageType & type() const =0
DT_DLL_vrfplan
#define DT_DLL_vrfplan
This file is used to determine how to build.
Definition: vrfplanDefines.h:28
DtChangeWeatherCommand::operator!=
virtual bool operator!=(const DtChangeWeatherCommand &rhs) const
Definition: changeWeatherCommand.h:394
DtChangeWeatherCommand::mySwellState
DtRwInt mySwellState
Definition: changeWeatherCommand.h:422
DtChangeWeatherCommand::myWindDrivenSeaStateEnabled
DtRwBoolean myWindDrivenSeaStateEnabled
Definition: changeWeatherCommand.h:426
DtChangeWeatherCommand::myAmbientWaterTemperature
DtRwReal myAmbientWaterTemperature
Definition: changeWeatherCommand.h:419
DtChangeWeatherCommand::mySeaState
DtRwInt mySeaState
Definition: changeWeatherCommand.h:424
rwVector.h
File: rwVector.h.
Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)