CigiBaseWeatherCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_WEATHER_CTRL_INCLUDED_)
#define _CIGI_BASE_WEATHER_CTRL_INCLUDED_

#include "CigiBasePacket.h"

// ====================================================================
// preprocessor definitions
// ====================================================================

#define CIGI_WEATHER_CTRL_PACKET_ID_V1 7
#define CIGI_WEATHER_CTRL_PACKET_SIZE_V1 44

#define CIGI_WEATHER_CTRL_PACKET_ID_V2 7
#define CIGI_WEATHER_CTRL_PACKET_SIZE_V2 44

#define CIGI_WEATHER_CTRL_PACKET_ID_V3 12
#define CIGI_WEATHER_CTRL_PACKET_SIZE_V3 56


class CigiWeatherCtrlV1;
class CigiWeatherCtrlV2;
class CigiWeatherCtrlV3;


class CIGI_SPEC CigiBaseWeatherCtrl : public CigiBasePacket
{

friend class CigiWeatherCtrlV1;
friend class CigiWeatherCtrlV2;
friend class CigiWeatherCtrlV3;

public:

   //=========================================================
   enum CloudTypeGrp
   {
      None=0,
      Altocumulus=1,
      Altostratus=2,
      Cirrocumulus=3,
      Cirrostratus=4,
      Cirrus=5,
      Cumulonimbus=6,
      Cumulus=7,
      Nimbostratus=8,
      Stratocumulus=9,
      Stratus=10,
      DefA=11,
      DefB=12,
      DefC=13,
      DefD=14,
      DefE=15
   };

   //=========================================================
   enum ScopeGrp
   {
      Global=0,
      Regional=1,
      Entity=2
   };




   //==> Management

   //=========================================================
   CigiBaseWeatherCtrl();

   //=========================================================
   virtual ~CigiBaseWeatherCtrl();


   //==> Buffer Packing/Unpacking

   //=========================================================
   virtual int Pack(CigiBasePacket * Base, Cigi_uint8 * Buff, void *Spec) const=0;

   //=========================================================
   virtual int Unpack(Cigi_uint8 * Buff, bool Swap, void *Spec) =0;

   //=========================================================
        virtual int GetCnvt(CigiVersionID &CnvtVersion,
                       CigiCnvtInfoType::Type &CnvtInfo);



   //==> Accessing Member Variable Values functions

   //+> EntityID

   //=========================================================
   int SetEntityID(const Cigi_uint16 EntityIDIn, bool bndchk=true)
   {
      EntityID = EntityIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetEntityID(void) const { return(EntityID); }


   //+> WeatherEn

   //=========================================================
   int SetWeatherEn(const bool WeatherEnIn, bool bndchk=true)
   {
      WeatherEn = WeatherEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetWeatherEn(void) const { return(WeatherEn); }


   //+> ScudEn

   //=========================================================
   int SetScudEn(const bool ScudEnIn, bool bndchk=true)
   {
      ScudEn = ScudEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetScudEn(void) const { return(ScudEn); }


   //+> RandomWindsEn

   //=========================================================
   int SetRandomWindsEn(const bool RandomWindsEnIn, bool bndchk=true)
   {
      RandomWindsEn = RandomWindsEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetRandomWindsEn(void) const { return(RandomWindsEn); }


   //+> Severity

   //=========================================================
   int SetSeverity(const Cigi_uint8 SeverityIn, bool bndchk=true);

   //=========================================================
   Cigi_uint8 GetSeverity(void) const { return(Severity); }


   //+> AirTemp

   //=========================================================
   int SetAirTemp(const float AirTempIn, bool bndchk=true)
   {
      AirTemp = AirTempIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetAirTemp(void) const { return(AirTemp); }


   //+> VisibilityRng

   //=========================================================
   int SetVisibilityRng(const float VisibilityRngIn, bool bndchk=true);

   //=========================================================
   float GetVisibilityRng(void) const { return(VisibilityRng); }


   //+> ScudFreq

   //=========================================================
   int SetScudFreq(const float ScudFreqIn, bool bndchk=true);

   //=========================================================
   float GetScudFreq(void) const { return(ScudFreq); }


   //+> Coverage

   //=========================================================
   int SetCoverage(const float CoverageIn, bool bndchk=true);

   //=========================================================
   float GetCoverage(void) const { return(Coverage); }


   //+> BaseElev

   //=========================================================
   int SetBaseElev(const float BaseElevIn, bool bndchk=true)
   {
      BaseElev = BaseElevIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetBaseElev(void) const { return(BaseElev); }


   //+> Thickness

   //=========================================================
   int SetThickness(const float ThicknessIn, bool bndchk=true)
   {
      Thickness = ThicknessIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetThickness(void) const { return(Thickness); }


   //+> Transition

   //=========================================================
   int SetTransition(const float TransitionIn, bool bndchk=true)
   {
      Transition = TransitionIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetTransition(void) const { return(Transition); }


   //+> HorizWindSp

   //=========================================================
   int SetHorizWindSp(const float HorizWindSpIn, bool bndchk=true)
   {
      HorizWindSp = HorizWindSpIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetHorizWindSp(void) const { return(HorizWindSp); }



protected:

   //==> Member variables

   //=========================================================
   Cigi_uint16 EntityID;

   //=========================================================
   Cigi_uint16 RegionID;

   //=========================================================
   Cigi_uint8 LayerID;

   //=========================================================
   Cigi_uint8 Humidity;

   //=========================================================
   Cigi_uint16 PhenomenonType;

   //=========================================================
   bool WeatherEn;

   //=========================================================
   bool ScudEn;

   //=========================================================
   bool RandomWindsEn;

   //=========================================================
   bool RandomLightningEn;

   //=========================================================
   CloudTypeGrp CloudType;

   //=========================================================
   ScopeGrp Scope;

   //=========================================================
   Cigi_uint8 Severity;

   //=========================================================
   float AirTemp;

   //=========================================================
   float VisibilityRng;

   //=========================================================
   float Opacity;

   //=========================================================
   float ScudFreq;

   //=========================================================
   float Coverage;

   //=========================================================
   float BaseElev;

   //=========================================================
   float Thickness;

   //=========================================================
   float Transition;

   //=========================================================
   float HorizWindSp;

   //=========================================================
   float VertWindSp;

   //=========================================================
   float WindDir;

   //=========================================================
   float BaroPress;

   //=========================================================
   float Aerosol;


};

#endif // #if !defined(_CIGI_BASE_WEATHER_CTRL_INCLUDED_)

---