VR-Forces 4.10 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) 2021 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"
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/rwWindLevels.h"
22 #include "vrfutil/rwUUID.h"
23 
30 {
31 public:
32 
35 
37  DtChangeWeatherCommand(const DtString& writeName,
38  DtReaderWriterRegistry* parentRegistry = NULL);
39 
41  DtChangeWeatherCommand(const DtString & writeName, const DtChangeWeatherCommand& orig,
42  DtReaderWriterRegistry* parentRegistry = NULL);
43 
45  virtual ~DtChangeWeatherCommand();
46 
49 
51  virtual const DtSimCommandMessageType& type() const;
52 
54  virtual DtSimCommand * clone(const DtString & name, DtReaderWriterRegistry *
55  parentRegistry = 0) const;
56 
57  virtual int netRepSize() const;
58  virtual bool setFromNet(const char* contentBuffer,
59  unsigned contentSize);
60  virtual bool setToNet();
61 
63 
64  virtual void setAirTurbidity(double factor);
65  virtual double airTurbidity() const;
67  virtual bool airTurbiditySpecified() const;
69  virtual void clearAirTurbidity();
71 
73 
74  virtual void setAmbientAirTemperature(double celsius);
75  virtual double ambientAirTemperature() const;
77  virtual bool ambientAirTemperatureSpecified() const;
79  virtual void clearAmbientAirTemperature();
81 
83 
84  virtual void setAmbientAirPressure(double factor);
85  virtual double ambientAirPressure() const;
87  virtual bool ambientAirPressureSpecified() const;
89  virtual void clearAmbientAirPressure();
91 
93 
94  virtual void setAirPressureAltitude(double factor);
95  virtual double airPressureAltitude() const;
97  virtual bool airPressureAltitudeSpecified() const;
99  virtual void clearAirPressureAltitude();
101 
103 
104  virtual void setAirTemperatureAltitude(double factor);
105  virtual double airTemperatureAltitude() const;
107  virtual bool airTemperatureAltitudeSpecified() const;
109  virtual void clearAirTemperatureAltitude();
111 
113 
114  virtual void setAirPressureAltitudeIsSeaLevel(bool seaLevel);
115  virtual bool airPressureAltitudeIsSeaLevel() const;
117  virtual bool airPressureAltitudeIsSeaLevelSpecified() const;
119  virtual void clearAirPressureAltitudeIsSeaLevel();
121 
123 
124  virtual void setAirTemperatureAltitudeIsSeaLevel(bool seaLevel);
125  virtual bool airTemperatureAltitudeIsSeaLevel() const;
127  virtual bool airTemperatureAltitudeIsSeaLevelSpecified() const;
129  virtual void clearAirTemperatureAltitudeIsSeaLevel();
131 
133 
134  virtual void setSeaLevelWaterConcentration(double factor);
135  virtual double seaLevelWaterConcentration() const;
137  virtual bool seaLevelWaterConcentrationSpecified() const;
139  virtual void clearSeaLevelWaterConcentration();
141 
143 
144  virtual void setPrecipitationIntensity(double factor);
145  virtual double precipitationIntensity() const;
147  virtual bool precipitationIntensitySpecified() const;
149  virtual void clearPrecipitationIntensity();
151 
153 
154  virtual void setPrecipitationType(DtVrfWeatherPrecipitationType type);
155  virtual DtVrfWeatherPrecipitationType precipitationType() const;
157  virtual bool precipitationTypeSpecified() const;
159  virtual void clearPrecipitationType();
161 
163 
164  virtual void setVisibility(double distance);
165  virtual double visibility() const;
167 
169 
170  virtual void setWindDirection(double radians);
171  virtual double windDirection() const;
173 
175 
176  virtual void setWindSpeed(double value);
177  virtual double windSpeed() const;
179 
181 
182  virtual void setAirTurbulence(int value);
183  virtual int airTurbulence() const;
185  virtual bool airTurbulenceSpecified() const;
187  virtual void clearAirTurbulence();
189 
190 
191 
193 
194  virtual void setUnderwaterVisibility(double underwaterVisibility);
195  virtual double underwaterVisibility() const;
198  virtual bool underwaterVisibilitySpecified() const;
200  virtual void clearUnderwaterVisibility();
202 
204 
205  virtual void setSurfaceTransparency(double transparency);
206  virtual double surfaceTransparency() const;
209  virtual bool surfaceTransparencySpecified() const;
211  virtual void clearSurfaceTransparency();
213 
215 
216  virtual void setWaterCurrentSpeed(double waterCurrentSpeed);
217  virtual double waterCurrentSpeed() const;
219  virtual bool waterCurrentSpeedSpecified() const;
221  virtual void clearWaterCurrentSpeed();
223 
225 
226  virtual void setWaterCurrentDirection(double waterCurrentDirection);
227  virtual double waterCurrentDirection() const;
229  virtual bool waterCurrentDirectionSpecified() const;
231  virtual void clearWaterCurrentDirection();
233 
235 
236  virtual void setAmbientWaterTemperature(double waterTemperature);
237  virtual double ambientWaterTemperature() const;
240  virtual bool ambientWaterTemperatureSpecified() const;
242  virtual void clearAmbientWaterTemperature();
244 
246 
247  virtual void setTidalOffset(double tidalOffset);
248  virtual double tidalOffset() const;
250  virtual bool tidalOffsetSpecified() const;
252  virtual void clearTidalOffset();
254 
257 
258  virtual void setTidalDirection(bool tidalDirection);
259  virtual bool tidalDirection() const;
261  virtual bool tidalDirectionSpecified() const;
263  virtual void clearTidalDirection();
265 
267 
268  virtual void setSwellState(unsigned int state);
269  virtual unsigned int swellState() const;
270  virtual bool swellStateSpecified() const;
271  virtual void clearSwellState();
273 
275 
276  virtual void setSwellStateDirection(double direction);
277  virtual double swellStateDirection() const;
278  virtual bool swellStateDirectionSpecified() const;
279  virtual void clearSwellStateDirection();
281 
283 
284  virtual void setSeaState(unsigned int state);
285  virtual unsigned int seaState() const;
286  virtual bool seaStateSpecified() const;
287  virtual void clearSeaState();
289 
291 
292  virtual void setSeaStateDirection(double direction);
293  virtual double seaStateDirection() const;
294  virtual bool seaStateDirectionSpecified() const;
295  virtual void clearSeaStateDirection();
297 
300  virtual void setWindDrivenSeaStateEnabled(bool enabled);
301  virtual bool windDrivenSeaStateEnabled() const;
302  virtual bool windDrivenSeaStateEnabledSpecified() const;
303  virtual void clearWindDrivenSeaStateEnabled();
305 
307 
308  virtual void setChoppiness(double choppiness);
309  virtual double choppiness() const;
310  virtual bool choppinessSpecified() const;
311  virtual void clearChoppiness();
313 
315 
316  virtual void setSurgeDepth(double depth);
317  virtual double surgeDepth() const;
318  virtual bool surgeDepthSpecified() const;
319  virtual void clearSurgeDepth();
321 
323 
324  virtual void setFogHeight(double depth);
325  virtual double fogHeight() const;
326  virtual bool fogHeightSpecified() const;
327  virtual void clearFogHeight();
329 
331 
332  virtual void setFogColor(const DtVector&);
333  virtual const DtVector& fogColor() const;
334  virtual bool fogColorSpecified() const;
335  virtual void clearFogColor();
337 
339 
340  virtual void setSnowAccumulation(double snow);
341  virtual double snowAccumulation() const;
342  virtual bool snowAccumulationSpecified() const;
343  virtual void clearSnowAccumulation();
345 
347 
348  virtual void setSnowMinimumAltitude(double snow);
349  virtual double snowMinimumAltitude() const;
350  virtual bool snowMinimumAltitudeSpecified() const;
351  virtual void clearSnowMinimumAltitude();
353 
355 
356  virtual void setSnowRoadAccumulation(double snow);
357  virtual double snowRoadAccumulation() const;
358  virtual bool snowRoadAccumulationSpecified() const;
359  virtual void clearSnowRoadAccumulation();
361 
363 
364  virtual void setRainAccumulation(double rain);
365  virtual double rainAccumulation() const;
366  virtual bool rainAccumulationSpecified() const;
367  virtual void clearRainAccumulation();
369 
372 
373  virtual void setThermoclineLayer1Depth(double depth);
374  virtual double thermoclineLayer1Depth() const;
375  virtual bool thermoclineLayer1DepthSpecified() const;
376  virtual void clearThermoclineLayer1Depth();
377  virtual void setThermoclineLayer1Permeability(double depth);
378  virtual double thermoclineLayer1Permeability() const;
379  virtual bool thermoclineLayer1PermeabilitySpecified() const;
380  virtual void clearThermoclineLayer1Permeability();
381 
382  virtual void setThermoclineLayer2Depth(double depth);
383  virtual double thermoclineLayer2Depth() const;
384  virtual bool thermoclineLayer2DepthSpecified() const;
385  virtual void clearThermoclineLayer2Depth();
386  virtual void setThermoclineLayer2Permeability(double depth);
387  virtual double thermoclineLayer2Permeability() const;
388  virtual bool thermoclineLayer2PermeabilitySpecified() const;
389  virtual void clearThermoclineLayer2Permeability();
390 
391  virtual void setThermoclineLayer3Depth(double depth);
392  virtual double thermoclineLayer3Depth() const;
393  virtual bool thermoclineLayer3DepthSpecified() const;
394  virtual void clearThermoclineLayer3Depth();
395  virtual void setThermoclineLayer3Permeability(double depth);
396  virtual double thermoclineLayer3Permeability() const;
397  virtual bool thermoclineLayer3PermeabilitySpecified() const;
398  virtual void clearThermoclineLayer3Permeability();
399 
400  virtual void setThermoclineLayer4Depth(double depth);
401  virtual double thermoclineLayer4Depth() const;
402  virtual bool thermoclineLayer4DepthSpecified() const;
403  virtual void clearThermoclineLayer4Depth();
404  virtual void setThermoclineLayer4Permeability(double depth);
405  virtual double thermoclineLayer4Permeability() const;
406  virtual bool thermoclineLayer4PermeabilitySpecified() const;
407  virtual void clearThermoclineLayer4Permeability();
408 
409  virtual void setThermoclineLayer5Depth(double depth);
410  virtual double thermoclineLayer5Depth() const;
411  virtual bool thermoclineLayer5DepthSpecified() const;
412  virtual void clearThermoclineLayer5Depth();
413  virtual void setThermoclineLayer5Permeability(double depth);
414  virtual double thermoclineLayer5Permeability() const;
415  virtual bool thermoclineLayer5PermeabilitySpecified() const;
416  virtual void clearThermoclineLayer5Permeability();
418 
420 
421  virtual void setLightningPresent(bool isPresent);
422  virtual bool lightningPresent() const;
423  virtual bool lightningPresentSpecified() const;
424  virtual void clearLightningPresent();
426 
432 
433  virtual void setGeneratedByRemoteWeatherSetter(bool value);
434  virtual bool generatedByRemoteWeatherSetter() const;
436 
438  virtual DtString stringRep() const;
439 
440  static DtSimCommand* creator();
441 
443  virtual void setUUID(const DtUUID&);
444  virtual const DtUUID& uuid() const;
445 
447  virtual void setPriority(int p);
448  virtual int priority() const;
449  virtual bool prioritySpecified() const;
450  virtual void clearPriority();
451 
456  virtual void clearWindLevels();
457  virtual bool windLevelsSpecified() const;
458  virtual void clearWindLevelsSpecified();
459 
461  virtual void setWindLevels(const DtRwWindLevels&);
462 
463  virtual const DtRwWindLevels& windLevels() const;
464  virtual DtRwWindLevels& windLevels();
466 
467  virtual bool operator==(const DtChangeWeatherCommand&) const;
468  virtual bool operator!=(const DtChangeWeatherCommand& rhs) const
469  {
470  return !(*this == rhs);
471  }
472 
474  virtual void setAllValuesSpecified(bool);
475 
477  virtual bool fromXml(const DtString& s);
478  virtual bool fromXmlFile(const DtFilename& s);
479 
481  virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
482  const DtVariableBindingsList& variableBindings);
483 
484 protected:
521 
524 
528 
530 
532 
534 
536 
538 };
539 
bool operator==(const DtReaderWriter &) const
Equivalence operator.
DtRwInt myAirTurbulence
Definition: changeWeatherCommand.h:495
UUID is a unique ID wrapper class.
Definition: rwUUID.h:222
DtVrfWeatherPrecipitationType
Definition: vrfWeatherStateEnums.h:13
DtRwReal myThermoclineLayer1Depth
Definition: changeWeatherCommand.h:510
DtRwBoolean myLightningPresent
Definition: changeWeatherCommand.h:537
DtRwReal mySeaLevelWaterConcentration
Definition: changeWeatherCommand.h:492
DtRwReal myAmbientAirPressure
Definition: changeWeatherCommand.h:487
DtRwUUID myUUID
Definition: changeWeatherCommand.h:533
DtRwReal myThermoclineLayer3Permeability
Definition: changeWeatherCommand.h:515
DtRwBoolean myTidalDirection
Definition: changeWeatherCommand.h:502
DtRwReal mySurfaceTransparency
Definition: changeWeatherCommand.h:497
virtual bool fromXmlFile(const DtFilename &)
Restores object from given xml file.
DtRwReal myRainAccumulation
Definition: changeWeatherCommand.h:529
DtRwReal myThermoclineLayer2Depth
Definition: changeWeatherCommand.h:512
virtual bool setToNet()
Calls netRep() to create the network buffer.
DtRwReal myThermoclineLayer4Permeability
Definition: changeWeatherCommand.h:517
DtRwReal myThermoclineLayer2Permeability
Definition: changeWeatherCommand.h:513
DtRwReal myThermoclineLayer5Depth
Definition: changeWeatherCommand.h:518
DtRwReal myThermoclineLayer4Depth
Definition: changeWeatherCommand.h:516
DtRwReal myTidalOffset
Definition: changeWeatherCommand.h:501
virtual DtString stringRep() const =0
Returns a human-readable string representation of the command.
Definition: readerWriterRegistry.h:39
DtRwReal myWaterCurrentDirection
Definition: changeWeatherCommand.h:499
DtRwReal mySnowAccumulation
Definition: changeWeatherCommand.h:525
DtRwInt myPriority
Definition: changeWeatherCommand.h:520
DtRwReal mySurgeDepth
Definition: changeWeatherCommand.h:509
DtRwReal myAirTurbidity
Definition: changeWeatherCommand.h:485
virtual bool fromXml(const DtString &)
Restores object from given xml string. Returns true if valid.
Description: Readable, Writable uuid string.
Definition: rwUUID.h:419
DtRwReal myWaterCurrentSpeed
Definition: changeWeatherCommand.h:498
DtRwReal myPrecipitationIntensity
Definition: changeWeatherCommand.h:493
DtRwReal myThermoclineLayer3Depth
Definition: changeWeatherCommand.h:514
Definition: rwVector.h:23
DtRwReal mySeaStateDirection
Definition: changeWeatherCommand.h:506
DT_DLL_VRVCORE double distance(const makVrv::DtCoordinateSystem &, const DtVector &from, const DtVector &to)
Returns the distance from the two points.
DtRwReal myThermoclineLayer1Permeability
Definition: changeWeatherCommand.h:511
DtRwVector myFogColor
Definition: changeWeatherCommand.h:523
virtual int netRepSize() const
Returns the size in bytes of the network representation of the class.
DtRwReal mySnowRoadAccumulation
Definition: changeWeatherCommand.h:527
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).
Description: Readable, Writable int.
Definition: rwInt.h:25
std::vector< DtFilename > SearchPaths
Definition: readerWriter.h:92
DtRwReal myAmbientAirTemperature
Definition: changeWeatherCommand.h:486
const DtSimCommand & operator=(const DtSimCommand &orig)
assignment operator; same as copy constructor
DtRwReal mySnowMinimumAltitude
Definition: changeWeatherCommand.h:526
DtRwReal myAirTemperatureAltitude
Definition: changeWeatherCommand.h:488
DtSimCommand is an abstract base class from which commands can derive.
Definition: simCommand.h:32
A DtSimCommand subclass which specifies a change to the weather settings for the specified weather ar...
Definition: changeWeatherCommand.h:29
DtRwReal myUnderwaterVisibility
Definition: changeWeatherCommand.h:496
virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
Top level to read itself from an input stream.
DtRwReal myFogHeight
Definition: changeWeatherCommand.h:522
DtRwReal myThermoclineLayer5Permeability
Definition: changeWeatherCommand.h:519
DtRwInt myPrecipitationType
Definition: changeWeatherCommand.h:494
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
DtRwReal myChoppiness
Definition: changeWeatherCommand.h:508
DtRwReal myAirPressureAltitude
Definition: changeWeatherCommand.h:489
virtual DtSimCommand * clone() const
Version of clone that preserves the existing name, and assigns a null parent registry.
DtRwBoolean myGeneratedByRemoteWeatherSetter
Definition: changeWeatherCommand.h:531
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DtRwReal mySwellStateDirection
Definition: changeWeatherCommand.h:504
virtual const DtSimCommandMessageType & type() const =0
#define DT_DLL_vrfplan
This file is used to determine how to build.
Definition: vrfplanDefines.h:28
virtual bool operator!=(const DtChangeWeatherCommand &rhs) const
Definition: changeWeatherCommand.h:468
DtRwInt mySwellState
Definition: changeWeatherCommand.h:503
Definition: rwWindLevels.h:17
DtRwBoolean myAirPressureAltitudeIsSeaLevel
Definition: changeWeatherCommand.h:491
DtRwBoolean myWindDrivenSeaStateEnabled
Definition: changeWeatherCommand.h:507
DtRwBoolean myAirTemperatureAltitudeIsSeaLevel
Definition: changeWeatherCommand.h:490
DtRwReal myAmbientWaterTemperature
Definition: changeWeatherCommand.h:500
DtRwInt mySeaState
Definition: changeWeatherCommand.h:505
DtRwWindLevels myWindLevels
Definition: changeWeatherCommand.h:535
File: rwVector.h.

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)