VR-Forces 4.0.4 Class Documentation: include/vrfplan/changeGlobalWeatherCommand.h Source File

Go to the documentation of this file.
00001 /*******************************************************************************
00002 ** Copyright (c) 2008 MAK Technologies, Inc.
00003 ** All rights reserved.
00004 *******************************************************************************/
00005 /*******************************************************************************
00006 ** $RCSfile: changeGlobalWeatherCommand.h,v $ $Revision: 1.1 $ $State: Exp $
00007 *******************************************************************************/
00008 
00011 
00013 
00014 #ifndef changeGlobalWeatherCommand_h
00015 #define changeGlobalWeatherCommand_h
00016 
00017 #include "vrfplan/simCommand.h"
00018 #include "vrfplan/vrfplanDefines.h"
00019 #include <vrfExtObjects/vrfWeatherStateEnums.h>
00020 #include "vrfutil/rwReal.h"
00021 #include "vrfutil/rwInt.h"
00022 #include "vrfutil/rwBoolean.h"
00023 
00029 class DT_DLL_vrfplan DtChangeGlobalWeatherCommand : public DtSimCommand
00030 {
00031 public:
00032 
00034    DtChangeGlobalWeatherCommand();
00035 
00037    DtChangeGlobalWeatherCommand(const DtString& writeName,
00038       DtReaderWriterRegistry* parentRegistry = NULL);
00039 
00041    DtChangeGlobalWeatherCommand(const DtString & writeName, const DtChangeGlobalWeatherCommand& orig,
00042       DtReaderWriterRegistry* parentRegistry = NULL);
00043 
00045    virtual ~DtChangeGlobalWeatherCommand();
00046 
00048    DtChangeGlobalWeatherCommand& operator=(const DtChangeGlobalWeatherCommand& orig);
00049 
00051    int type() const;
00052 
00054    virtual DtSimCommand * clone(const DtString & name, DtReaderWriterRegistry *
00055       parentRegistry = 0) const;
00056 
00057    virtual int netRepSize() const;
00058    virtual bool setFromNet(const char* contentBuffer, 
00059       unsigned contentSize);
00060    virtual bool setToNet();
00061 
00063 
00064    virtual void setAirTurbidity(double factor);
00065    virtual double airTurbidity() const;
00067    virtual bool airTurbiditySpecified() const;
00069    virtual void clearAirTurbidity();
00071 
00073 
00074    virtual void setCloudState(DtVrfWeatherCloudState type);
00075    virtual DtVrfWeatherCloudState cloudState() const;
00077    virtual bool cloudStateSpecified() const;
00079    virtual void clearCloudState();
00081 
00083 
00084    virtual void setPrecipitationIntensity(double factor);
00085    virtual double precipitationIntensity() const;
00087    virtual bool precipitationIntensitySpecified() const;
00089    virtual void clearPrecipitationIntensity();
00091 
00093 
00094    virtual void setPrecipitationType(DtVrfWeatherPrecipitationType type);
00095    virtual DtVrfWeatherPrecipitationType precipitationType() const;
00097    virtual bool precipitationTypeSpecified() const;
00099    virtual void clearPrecipitationType();
00101 
00103 
00104    virtual void setVisibility(double distance);
00105    virtual double visibility() const;
00107    virtual bool visibilitySpecified() const;
00109    virtual void clearVisibility();
00111 
00113 
00114    virtual void setWindDirection(double radians);
00115    virtual double windDirection() const;
00117    virtual bool windDirectionSpecified() const;
00119    virtual void clearWindDirection();
00121 
00123 
00124    virtual void setWindSpeed(double value);
00125    virtual double windSpeed() const;
00127    virtual bool windSpeedSpecified() const;
00129    virtual void clearWindSpeed();
00131 
00137 
00138    virtual void setGeneratedByRemoteWeatherSetter(bool value);
00139    virtual bool generatedByRemoteWeatherSetter() const;
00141 
00143    virtual DtString stringRep() const;
00144 
00145    static DtSimCommand* creator();
00146 
00147 protected:
00148    DtRwReal myAirTurbidity;
00149    DtRwInt  myCloudState;
00150    DtRwReal myPrecipitationIntensity;
00151    DtRwInt  myPrecipitationType;
00152    DtRwReal myWindDirection;
00153    DtRwReal myWindSpeed;
00154    DtRwReal myVisibility;
00155    DtRwBoolean myGeneratedByRemoteWeatherSetter;
00156 };
00157 
00158 #endif