CigiBaseWaveCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_WAVE_CTRL_INCLUDED_)
#define _CIGI_BASE_WAVE_CTRL_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_WAVE_CTRL_PACKET_ID_V3 14
#define CIGI_WAVE_CTRL_PACKET_SIZE_V3 32


class CigiWaveCtrlV3;


class CIGI_SPEC CigiBaseWaveCtrl : public CigiBasePacket
{

friend class CigiWaveCtrlV3;

public:

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

   //=========================================================
   enum BreakerGrp
   {
      Plunging=0,
      Spilling=1,
      Surging=2
   };




   //==> Management

   //=========================================================
   CigiBaseWaveCtrl();

   //=========================================================
   virtual ~CigiBaseWaveCtrl();


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


   //+> WaveID

   //=========================================================
   int SetWaveID(const Cigi_uint8 WaveIDIn, bool bndchk=true)
   {
      WaveID = WaveIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetWaveID(void) const { return(WaveID); }


   //+> WaveEn

   //=========================================================
   int SetWaveEn(const bool WaveEnIn, bool bndchk=true)
   {
      WaveEn = WaveEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetWaveEn(void) const { return(WaveEn); }


   //+> Scope

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

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


   //+> Breaker

   //=========================================================
   int SetBreaker(const BreakerGrp BreakerIn, bool bndchk=true);

   //=========================================================
   BreakerGrp GetBreaker(void) const { return(Breaker); }


   //+> WaveHt

   //=========================================================
   int SetWaveHt(const float WaveHtIn, bool bndchk=true);

   //=========================================================
   float GetWaveHt(void) const { return(WaveHt); }


   //+> WaveLen

   //=========================================================
   int SetWaveLen(const float WaveLenIn, bool bndchk=true);

   //=========================================================
   float GetWaveLen(void) const { return(WaveLen); }


   //+> Period

   //=========================================================
   int SetPeriod(const float PeriodIn, bool bndchk=true);

   //=========================================================
   float GetPeriod(void) const { return(Period); }


   //+> Direction

   //=========================================================
   int SetDirection(const float DirectionIn, bool bndchk=true);

   //=========================================================
   float GetDirection(void) const { return(Direction); }


   //+> PhaseOff

   //=========================================================
   int SetPhaseOff(const float PhaseOffIn, bool bndchk=true);

   //=========================================================
   float GetPhaseOff(void) const { return(PhaseOff); }


   //+> Leading

   //=========================================================
   int SetLeading(const float LeadingIn, bool bndchk=true);

   //=========================================================
   float GetLeading(void) const { return(Leading); }



protected:

   //==> Member variables

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

   //=========================================================
   Cigi_uint8 WaveID;

   //=========================================================
   bool WaveEn;

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

   //=========================================================
   BreakerGrp Breaker;

   //=========================================================
   float WaveHt;

   //=========================================================
   float WaveLen;

   //=========================================================
   float Period;

   //=========================================================
   float Direction;

   //=========================================================
   float PhaseOff;

   //=========================================================
   float Leading;


};

#endif // #if !defined(_CIGI_BASE_WAVE_CTRL_INCLUDED_)

---