CigiBaseCollDetVolResp.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_COLL_DET_VOL_RESP_INCLUDED_)
#define _CIGI_BASE_COLL_DET_VOL_RESP_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_COLL_DET_VOL_RESP_PACKET_ID_V2 107
#define CIGI_COLL_DET_VOL_RESP_PACKET_SIZE_V2 8

#define CIGI_COLL_DET_VOL_RESP_PACKET_ID_V3 114
#define CIGI_COLL_DET_VOL_RESP_PACKET_SIZE_V3 16


class CigiCollDetVolRespV2;
class CigiCollDetVolRespV3;


class CIGI_SPEC CigiBaseCollDetVolResp : public CigiBasePacket
{

friend class CigiCollDetVolRespV2;
friend class CigiCollDetVolRespV3;

public:

   //=========================================================
   enum CollTypeGrp
   {
      NonEntity=0,
      Entity=1
   };




   //==> Management

   //=========================================================
   CigiBaseCollDetVolResp();

   //=========================================================
   virtual ~CigiBaseCollDetVolResp();


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

   //+> EntityID

   //=========================================================
   int SetEntityID(const Cigi_uint16 EntityIDIn, bool bndchk=true)
   {
      EntityID = EntityIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetEntityID(void) const { return(EntityID); }


   //+> CollType

   //=========================================================
   int SetCollType(const CollTypeGrp CollTypeIn, bool bndchk=true);

   //=========================================================
   CollTypeGrp GetCollType(void) const { return(CollType); }


   //+> CollEntityID

   //=========================================================
   int SetCollEntityID(const Cigi_uint16 CollEntityIDIn, bool bndchk=true)
   {
      CollEntityID = CollEntityIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetCollEntityID(void) const { return(CollEntityID); }



protected:

   //==> Member variables

   //=========================================================
   Cigi_uint16 EntityID;

   //=========================================================
   Cigi_uint8 VolID;

   //=========================================================
   CollTypeGrp CollType;

   //=========================================================
   Cigi_uint16 CollEntityID;

   //=========================================================
   Cigi_uint8 CollVolID;


};

#endif // #if !defined(_CIGI_BASE_COLL_DET_VOL_RESP_INCLUDED_)

---