CigiMessageBuffer.h

Go to the documentation of this file.

#if !defined(_CIGI_MESSAGE_BUFFER_INCLUDED_)
#define _CIGI_MESSAGE_BUFFER_INCLUDED_

#include <string.h> // for memset

#include "CigiTypes.h"
#include "CigiVersionID.h"



class CigiOutgoingMsg;
class CigiIncomingMsg;
class CigiBaseIGCtrl;
class CigiBaseSOF;


//=========================================================
class CIGI_SPEC CigiMessageBuffer
{
public:

   friend class CigiOutgoingMsg;
   friend class CigiIncomingMsg;


   //==> Management

   //=========================================================
   CigiMessageBuffer(const int BufLen = 16384)
      : Buffer(NULL)
      , BufferSize(0)
      , FillBufferPos(NULL)
      , BufferFillCnt(0)
      , Active(false)
      , Locked(false)
      , ValidIGCtrlSOF(false)
      , DataPresent(false)
      , PackIGCtrl(NULL)
      , PackSOF(NULL)
   {
      // This creates a buffer that is double word aligned and
      //  has double word aligned size

      // Determine the number of bytes with a safety buffer
      BufferSize = BufLen +                          // Requested buffer length
                   (BufLen % sizeof(Cigi_uint64)) +  // make double word aligned
                   sizeof(Cigi_uint64);              // add a safety buffer

      // Allocate the message buffer
      Buffer = new Cigi_uint8[BufferSize];

      // Initialize empty buffer
      memset( Buffer, 0, BufferSize );

   }

   //=========================================================
   virtual ~CigiMessageBuffer(void)
   {
      if(Buffer != NULL)
      {
         delete [] Buffer;
         Buffer = NULL;
      }
   }


   //==> Public Accessor functions

   //=========================================================
   CigiVersionID GetCigiVersion(void) { return(CigiVersion); }

   //=========================================================
   int GetCigiMajorVersion(void) { return(CigiVersion.CigiMajorVersion); }

   //=========================================================
   int GetCigiMinorVersion(void) { return(CigiVersion.CigiMinorVersion); }

   //=========================================================
   int GetBufferSize(void) { return(BufferSize); }

   //=========================================================
   bool IsActive(void) { return(Active); }

   //=========================================================
   bool IsLocked(void) { return(Locked); }

   //=========================================================
   bool IsValidIGCtrlSOF(void) { return(ValidIGCtrlSOF); }

   //=========================================================
   bool IsDataPresent(void) { return(DataPresent); }




protected:

   //==> Member variables

   //=========================================================
   Cigi_uint8 *Buffer;

   //=========================================================
   CigiVersionID CigiVersion;

   //=========================================================
   int BufferSize;

   //=========================================================
   Cigi_uint8 *FillBufferPos;

   //=========================================================
   int BufferFillCnt;

   //=========================================================
   bool Active;

   //=========================================================
   bool Locked;

   //=========================================================
   bool ValidIGCtrlSOF;

   //=========================================================
   bool DataPresent;

   //=========================================================
   CigiBaseIGCtrl *PackIGCtrl;

   //=========================================================
   CigiBaseSOF *PackSOF;

};


#endif   //  _CIGI_MESSAGE_BUFFER_INCLUDED_

---