CigiBaseSensorCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_SENSOR_CTRL_INCLUDED_)
#define _CIGI_BASE_SENSOR_CTRL_INCLUDED_

#include "CigiBasePacket.h"


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

#define CIGI_SENSOR_CTRL_PACKET_ID_V1 9
#define CIGI_SENSOR_CTRL_PACKET_SIZE_V1 24

#define CIGI_SENSOR_CTRL_PACKET_ID_V2 9
#define CIGI_SENSOR_CTRL_PACKET_SIZE_V2 24

#define CIGI_SENSOR_CTRL_PACKET_ID_V3 17
#define CIGI_SENSOR_CTRL_PACKET_SIZE_V3 24


class CigiSensorCtrlV1;
class CigiSensorCtrlV2;
class CigiSensorCtrlV3;


class CIGI_SPEC CigiBaseSensorCtrl : public CigiBasePacket
{

friend class CigiSensorCtrlV1;
friend class CigiSensorCtrlV2;
friend class CigiSensorCtrlV3;

public:

   //=========================================================
   enum PolarityGrp
   {
      WhiteHot=0,
      BlackHot=1
   };

   //=========================================================
   enum TrackModeGrp
   {
      TrackOff=0,
      ForceCorrelate=1,
      Scene=2,
      Target=3,
      Ship=4,
      TMDefA=5,
      TMDefB=6,
      TMDefC=7
   };

   //=========================================================
   enum TrackPolarityGrp
   {
      TrackWhite=0,
      TrackBlack=1
   };

   //=========================================================
   enum ResponseTypeGrp
   {
      GatePos=0,
      GateAndTargetPos=1
   };




   //==> Management

   //=========================================================
   CigiBaseSensorCtrl();

   //=========================================================
   virtual ~CigiBaseSensorCtrl();


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

   //+> SensorID

   //=========================================================
   int SetSensorID(const Cigi_uint8 SensorIDIn, bool bndchk=true)
   {
      SensorID = SensorIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetSensorID(void) const { return(SensorID); }


   //+> SensorOn

   //=========================================================
   int SetSensorOn(const bool SensorOnIn, bool bndchk=true)
   {
      SensorOn = SensorOnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetSensorOn(void) const { return(SensorOn); }


   //+> Polarity

   //=========================================================
   int SetPolarity(const PolarityGrp PolarityIn, bool bndchk=true);

   //=========================================================
   PolarityGrp GetPolarity(void) const { return(Polarity); }


   //+> LineDropEn

   //=========================================================
   int SetLineDropEn(const bool LineDropEnIn, bool bndchk=true)
   {
      LineDropEn = LineDropEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetLineDropEn(void) const { return(LineDropEn); }


   //+> TrackMode

   //=========================================================
   int SetTrackMode(const TrackModeGrp TrackModeIn, bool bndchk=true);

   //=========================================================
   TrackModeGrp GetTrackMode(void) const { return(TrackMode); }


   //+> AutoGainEn

   //=========================================================
   int SetAutoGainEn(const bool AutoGainEnIn, bool bndchk=true)
   {
      AutoGainEn = AutoGainEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetAutoGainEn(void) const { return(AutoGainEn); }


   //+> TrackPolarity

   //=========================================================
   int SetTrackPolarity(const TrackPolarityGrp TrackPolarityIn, bool bndchk=true);

   //=========================================================
   TrackPolarityGrp GetTrackPolarity(void) const { return(TrackPolarity); }


   //+> Level

   //=========================================================
   int SetLevel(const float LevelIn, bool bndchk=true);

   //=========================================================
   float GetLevel(void) const { return(Level); }


   //+> ACCoupling

   //=========================================================
   int SetACCoupling(const float ACCouplingIn, bool bndchk=true);

   //=========================================================
   float GetACCoupling(void) const { return(ACCoupling); }


   //+> Noise

   //=========================================================
   int SetNoise(const float NoiseIn, bool bndchk=true);

   //=========================================================
   float GetNoise(void) const { return(Noise); }



protected:

   //==> Member variables

   //=========================================================
   Cigi_uint16 ViewID;

   //=========================================================
   Cigi_uint8 SensorID;

   //=========================================================
   bool SensorOn;

   //=========================================================
   PolarityGrp Polarity;

   //=========================================================
   bool LineDropEn;

   //=========================================================
   TrackModeGrp TrackMode;

   //=========================================================
   bool AutoGainEn;

   //=========================================================
   TrackPolarityGrp TrackPolarity;

   //=========================================================
   ResponseTypeGrp ResponseType;

   //=========================================================
   float Gain;

   //=========================================================
   float Level;

   //=========================================================
   float ACCoupling;

   //=========================================================
   float Noise;


};

#endif // #if !defined(_CIGI_BASE_SENSOR_CTRL_INCLUDED_)

---