GenericADCElectronicsParameters.h

Go to the documentation of this file.

#ifndef GenericADCElectronicsParameters_h
#define GenericADCElectronicsParameters_h 1

//C++
#include <iostream>
#include <string>
#include <utility>

//LCIO
#include "lcio.h"
#include "UTIL/LCFixedObject.h"

                                 // DAQ channel number and readout module ID here called channelID and readoutGroup
#define GenericADCElectronicsParametersNINTVals 5
                                 // GenericADCElectronicsParameters Value and GenericADCElectronicsParameters Width
#define GenericADCElectronicsParametersNFLOATVals 1
#define GenericADCElectronicsParametersNDOUBLEVals 0

namespace tpcconddata
{

    class GenericADCElectronicsParameters;

    typedef GenericADCElectronicsParameters LCGenericADCElectronicsParameters;

    class GenericADCElectronicsParameters : public UTIL::LCFixedObject<GenericADCElectronicsParametersNINTVals,GenericADCElectronicsParametersNFLOATVals,GenericADCElectronicsParametersNDOUBLEVals>
    {

        public:

            GenericADCElectronicsParameters(int readoutGroupID, int polarity, int maxADCvalue, float frequency, bool isPedestalSubtracted, bool isZeroSupressed);

            GenericADCElectronicsParameters(EVENT::LCObject* obj):UTIL::LCFixedObject<GenericADCElectronicsParametersNINTVals,
                GenericADCElectronicsParametersNFLOATVals,
                GenericADCElectronicsParametersNDOUBLEVals>(obj) { }

            virtual ~GenericADCElectronicsParameters();

            // the class interface:

            // set the module number
            void setReadoutGroup(int readoutGroupID);
            // set the polarity value, should be -1 or +1
            void setPolarity(int polarity);
            // set the precision value of the electronics (maximum possible ADC value)
            void setMaxADCValue(int maxADCValue);
            // set the read out frequency of the read-out electronics (in MHz)
            void setFrequency(float frequency);
            // set to true, if readout electronics is automatically subtracting pedestals
            void setPedestalSubtracted(bool onoff);
            // set to true, if readout electronics does zero suppression
            void setZeroSupressed(bool onoff);
            
            
            // get the module number
            int getReadoutGroup() const;
            // get the polarity value, should be -1 or +1
            int getPolarity() const;
            // get the precision value of the electronics (maximum possible ADC value)
            int getMaxADCValue() const;
            // get the read out frequency of the read-out electronics (in MHz)
            float getFrequency() const;
            // returns true, if readout electronics is automatically subtracting pedestals
            bool isPedestalSubtracted() const;
            // returns true, if readout electronics does zero suppression
            bool isZeroSupressed() const;

            static std::string getRevision();
            static std::string getDefaultColName();

            void print(  std::ostream& os = std::cout ) const;

            // -------- need to implement abstract methods from LCGenericObject
            const std::string getTypeName() const
            {
                return std::string("GenericADCElectronicsParameters");
            }
            const std::string getDataDescription() const
            {
                return std::string("i:ReadoutGroup,Polarity,MaxADCValue,f:Frequency(MHz)");
            }

                        #ifdef USE_LCCD
            // add some helper functions for using the native LCCD conditions map
                        typedef int key_type;

                        key_type conditions_key() const;
                        #endif

        protected:

    };                           // end of class

    std::ostream &operator<<(std::ostream &os, const GenericADCElectronicsParameters &p);

}                                //end namespace tpcconddata
#endif