CigiBaseTerrestrialSurfaceCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_TERRESTRIAL_SURFACE_CTRL_INCLUDED_)
#define _CIGI_BASE_TERRESTRIAL_SURFACE_CTRL_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_TERRESTRIAL_SURFACE_CTRL_PACKET_ID_V3 15
#define CIGI_TERRESTRIAL_SURFACE_CTRL_PACKET_SIZE_V3 8


class CigiTerrestrialSurfaceCtrlV3;


class CIGI_SPEC CigiBaseTerrestrialSurfaceCtrl : public CigiBasePacket
{

friend class CigiTerrestrialSurfaceCtrlV3;

public:

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




   //==> Management

   //=========================================================
   CigiBaseTerrestrialSurfaceCtrl();

   //=========================================================
   virtual ~CigiBaseTerrestrialSurfaceCtrl();


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

   //+> EntityRgnID

   //=========================================================
   int SetEntityRgnID(const Cigi_uint16 EntityRgnIDIn, bool bndchk=true)
   {
      EntityRgnID = EntityRgnIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetEntityRgnID(void) const { return(EntityRgnID); }


   //+> SurfaceCondID

   //=========================================================
   int SetSurfaceCondID(const Cigi_uint16 SurfaceCondIDIn, bool bndchk=true)
   {
      SurfaceCondID = SurfaceCondIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetSurfaceCondID(void) const { return(SurfaceCondID); }


   //+> SurfaceCondEn

   //=========================================================
   int SetSurfaceCondEn(const bool SurfaceCondEnIn, bool bndchk=true)
   {
      SurfaceCondEn = SurfaceCondEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetSurfaceCondEn(void) const { return(SurfaceCondEn); }


   //+> Scope

   //=========================================================
   int SetScope(const ScopeGrp ScopeIn, bool bndchk=true);

   //=========================================================
   ScopeGrp GetScope(void) const { return(Scope); }


   //+> Severity

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

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


   //+> Coverage

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

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



protected:

   //==> Member variables

   //=========================================================
   Cigi_uint16 EntityRgnID;

   //=========================================================
   Cigi_uint16 SurfaceCondID;

   //=========================================================
   bool SurfaceCondEn;

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

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

   //=========================================================
   Cigi_uint8 Coverage;


};

#endif // #if !defined(_CIGI_BASE_TERRESTRIAL_SURFACE_CTRL_INCLUDED_)

---