CigiBaseEnvRgnCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_ENV_RGN_CTRL_INCLUDED_)
#define _CIGI_BASE_ENV_RGN_CTRL_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_ENV_RGN_CTRL_PACKET_ID_V3 11
#define CIGI_ENV_RGN_CTRL_PACKET_SIZE_V3 48


class CigiEnvRgnCtrlV3;


class CIGI_SPEC CigiBaseEnvRgnCtrl : public CigiBasePacket
{

friend class CigiEnvRgnCtrlV3;

public:

   //=========================================================
   enum RgnStateGrp
   {
      Inactive=0,
      Active=1,
      Destroyed=2
   };

   //=========================================================
   enum MergeCtrlGrp
   {
      UseLast=0,
      Merge=1
   };




   //==> Management

   //=========================================================
   CigiBaseEnvRgnCtrl();

   //=========================================================
   virtual ~CigiBaseEnvRgnCtrl();


   //==> 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

   //+> RegionID

   //=========================================================
   int SetRegionID(const Cigi_uint16 RegionIDIn, bool bndchk=true)
   {
      RegionID = RegionIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetRegionID(void) const { return(RegionID); }


   //+> RgnState

   //=========================================================
   int SetRgnState(const RgnStateGrp RgnStateIn, bool bndchk=true);

   //=========================================================
   RgnStateGrp GetRgnState(void) const { return(RgnState); }


   //+> WeatherProp

   //=========================================================
   int SetWeatherProp(const MergeCtrlGrp WeatherPropIn, bool bndchk=true);

   //=========================================================
   MergeCtrlGrp GetWeatherProp(void) const { return(WeatherProp); }


   //+> Aerosol

   //=========================================================
   int SetAerosol(const MergeCtrlGrp AerosolIn, bool bndchk=true);

   //=========================================================
   MergeCtrlGrp GetAerosol(void) const { return(Aerosol); }


   //+> MaritimeSurface

   //=========================================================
   int SetMaritimeSurface(const MergeCtrlGrp MaritimeSurfaceIn, bool bndchk=true);

   //=========================================================
   MergeCtrlGrp GetMaritimeSurface(void) const { return(MaritimeSurface); }


   //+> TerrestrialSurface

   //=========================================================
   int SetTerrestrialSurface(const MergeCtrlGrp TerrestrialSurfaceIn, bool bndchk=true);

   //=========================================================
   MergeCtrlGrp GetTerrestrialSurface(void) const { return(TerrestrialSurface); }


   //+> Lat

   //=========================================================
   int SetLat(const double LatIn, bool bndchk=true);

   //=========================================================
   double GetLat(void) const { return(Lat); }


   //+> Lon

   //=========================================================
   int SetLon(const double LonIn, bool bndchk=true);

   //=========================================================
   double GetLon(void) const { return(Lon); }


   //+> XSize

   //=========================================================
   int SetXSize(const float XSizeIn, bool bndchk=true)
   {
      XSize = XSizeIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetXSize(void) const { return(XSize); }


   //+> YSize

   //=========================================================
   int SetYSize(const float YSizeIn, bool bndchk=true)
   {
      YSize = YSizeIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetYSize(void) const { return(YSize); }


   //+> CornerRadius

   //=========================================================
   int SetCornerRadius(const float CornerRadiusIn, bool bndchk=true)
   {
      CornerRadius = CornerRadiusIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetCornerRadius(void) const { return(CornerRadius); }


   //+> Rotation

   //=========================================================
   int SetRotation(const float RotationIn, bool bndchk=true);

   //=========================================================
   float GetRotation(void) const { return(Rotation); }


   //+> Transition

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

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



protected:

   //==> Member variables

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

   //=========================================================
   RgnStateGrp RgnState;

   //=========================================================
   MergeCtrlGrp WeatherProp;

   //=========================================================
   MergeCtrlGrp Aerosol;

   //=========================================================
   MergeCtrlGrp MaritimeSurface;

   //=========================================================
   MergeCtrlGrp TerrestrialSurface;

   //=========================================================
   double Lat;

   //=========================================================
   double Lon;

   //=========================================================
   float XSize;

   //=========================================================
   float YSize;

   //=========================================================
   float CornerRadius;

   //=========================================================
   float Rotation;

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


};

#endif // #if !defined(_CIGI_BASE_ENV_RGN_CTRL_INCLUDED_)

---