CigiBaseMaritimeSurfaceResp.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_MARITIME_SURFACE_RESP_INCLUDED_)
#define _CIGI_BASE_MARITIME_SURFACE_RESP_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_MARITIME_SURFACE_RESP_PACKET_ID_V3 111
#define CIGI_MARITIME_SURFACE_RESP_PACKET_SIZE_V3 16


class CigiMaritimeSurfaceRespV3;


class CIGI_SPEC CigiBaseMaritimeSurfaceResp : public CigiBasePacket
{

friend class CigiMaritimeSurfaceRespV3;

public:

   //==> Management

   //=========================================================
   CigiBaseMaritimeSurfaceResp();

   //=========================================================
   virtual ~CigiBaseMaritimeSurfaceResp();


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

   //+> RequestID

   //=========================================================
   int SetRequestID(const Cigi_uint8 RequestIDIn, bool bndchk=true)
   {
      RequestID = RequestIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetRequestID(void) const { return(RequestID); }


   //+> 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_uint8 RequestID;

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

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

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


};

#endif // #if !defined(_CIGI_BASE_MARITIME_SURFACE_RESP_INCLUDED_)

---