CigiBaseMaritimeSurfaceCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_MARITIME_SURFACE_CTRL_INCLUDED_)
#define _CIGI_BASE_MARITIME_SURFACE_CTRL_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_MARITIME_SURFACE_CTRL_PACKET_ID_V3 13
#define CIGI_MARITIME_SURFACE_CTRL_PACKET_SIZE_V3 24


class CigiMaritimeSurfaceCtrlV3;


class CIGI_SPEC CigiBaseMaritimeSurfaceCtrl : public CigiBasePacket
{

friend class CigiMaritimeSurfaceCtrlV3;

public:

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




   //==> Management

   //=========================================================
   CigiBaseMaritimeSurfaceCtrl();

   //=========================================================
   virtual ~CigiBaseMaritimeSurfaceCtrl();


   //==> 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); }


   //+> SurfaceCondEn

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

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


   //+> WhitecapEn

   //=========================================================
   int SetWhitecapEn(const bool WhitecapEnIn, bool bndchk=true)
   {
      WhitecapEn = WhitecapEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetWhitecapEn(void) const { return(WhitecapEn); }


   //+> Scope

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

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


   //+> SurfaceHeight

   //=========================================================
   int SetSurfaceHeight(const float SurfaceHeightIn, bool bndchk=true)
   {
      SurfaceHeight = SurfaceHeightIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetSurfaceHeight(void) const { return(SurfaceHeight); }


   //+> WaterTemp

   //=========================================================
   int SetWaterTemp(const float WaterTempIn, bool bndchk=true)
   {
      WaterTemp = WaterTempIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetWaterTemp(void) const { return(WaterTemp); }


   //+> Clarity

   //=========================================================
   int SetClarity(const float ClarityIn, bool bndchk=true);

   //=========================================================
   float GetClarity(void) const { return(Clarity); }



protected:

   //==> Member variables

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

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

   //=========================================================
   bool WhitecapEn;

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

   //=========================================================
   float SurfaceHeight;

   //=========================================================
   float WaterTemp;

   //=========================================================
   float Clarity;


};

#endif // #if !defined(_CIGI_BASE_MARITIME_SURFACE_CTRL_INCLUDED_)

---