A2DSensor.h

Go to the documentation of this file.

// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4; -*-
// vim: set shiftwidth=4 softtabstop=4 expandtab:
/*
 ********************************************************************
 ** NIDAS: NCAR In-situ Data Acquistion Software
 **
 ** 2007, Copyright University Corporation for Atmospheric Research
 **
 ** This program is free software; you can redistribute it and/or modify
 ** it under the terms of the GNU General Public License as published by
 ** the Free Software Foundation; either version 2 of the License, or
 ** (at your option) any later version.
 **
 ** This program is distributed in the hope that it will be useful,
 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ** GNU General Public License for more details.
 **
 ** The LICENSE.txt file accompanying this software contains
 ** a copy of the GNU General Public License. If it is not found,
 ** write to the Free Software Foundation, Inc.,
 ** 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **
 ********************************************************************
*/
#ifndef NIDAS_DYNLD_A2DSENSOR_H
#define NIDAS_DYNLD_A2DSENSOR_H

#include <nidas/core/DSMSensor.h>

#include <nidas/linux/a2d.h>

#include <vector>
#include <map>
#include <set>


namespace nidas { namespace dynld {

using namespace nidas::core;

class A2DSensor : public DSMSensor {

public:

    A2DSensor();
    ~A2DSensor();

    void open(int flags) throw(nidas::util::IOException,
        nidas::util::InvalidParameterException);

    void init() throw(nidas::util::InvalidParameterException);

    /*
     * Close the device connected to the sensor.
     */
    void close() throw(nidas::util::IOException);

    void validate() throw(nidas::util::InvalidParameterException);

    void setScanRate(int val) { _scanRate = val; }

    int getScanRate() const { return _scanRate; }

    bool process(const Sample* insamp,std::list<const Sample*>& results) throw();

    virtual int getMaxNumChannels() const = 0;

    virtual void setA2DParameters(int ichan,int gain,int bipolar)
        throw(nidas::util::InvalidParameterException);

    virtual void getA2DParameters(int ichan,int& gain,int& bipolar) const;

    int getGain(int ichan) const;

    int getBipolar(int ichan) const;

    virtual void getBasicConversion(int ichan,float& intercept, float& slope) const = 0;

    virtual void setConversionCorrection(int ichan,float intercept,
        float slope) throw(nidas::util::InvalidParameterException);


    void getConversion(int ichan,float& intercept, float& slope) const;

    float getSlope(int ichan) const
    {
        if (ichan < 0 || ichan >= _maxNChannels) return floatNAN;
        return _convSlopes[ichan];
    }

    float getIntercept(int ichan) const
    {
        if (ichan < 0 || ichan >= _maxNChannels) return floatNAN;
        return _convIntercepts[ichan];
    }

protected:

    class A2DSampleConfig
    {
    public:
        A2DSampleConfig(): _cfg()  {}
        virtual ~A2DSampleConfig() {}
        virtual nidas_a2d_sample_config& cfg() { return _cfg; }
    private:
        nidas_a2d_sample_config _cfg;
        // No copying or assignment
        A2DSampleConfig(const A2DSampleConfig& x);
        A2DSampleConfig& operator=(const A2DSampleConfig& rhs);
    };

    class A2DBoxcarConfig: public A2DSampleConfig
    {
    public:
        A2DBoxcarConfig(int n): A2DSampleConfig(),npts(n)
        {
            // make sure there is no padding or extra bytes
            // between the end of nidas_a2d_sample_config and npts.
            // The driver C code will interpret npts as filterData[].
            assert((void*)&(cfg().filterData[0]) == (void*)&npts);
            cfg().nFilterData = sizeof(int);
        }
        int npts;
    private:
        // No copying or assignment
        A2DBoxcarConfig(const A2DBoxcarConfig& x);
        A2DBoxcarConfig& operator=(const A2DBoxcarConfig& rhs);
    };

    class A2DTimeAvgConfig: public A2DSampleConfig
    {
    public:
        A2DTimeAvgConfig(int n): A2DSampleConfig(),rate(n)
        {
            // make sure there is no padding or extra bytes
            // between the end of nidas_a2d_sample_config and npts.
            // The driver C code will interpret npts as filterData[].
            assert((void*)&(cfg().filterData[0]) == (void*)&rate);
            cfg().nFilterData = sizeof(int);
        }
        int rate;
    private:
        // No copying or assignment
        A2DTimeAvgConfig(const A2DTimeAvgConfig& x);
        A2DTimeAvgConfig& operator=(const A2DTimeAvgConfig& rhs);
    };

    std::vector<A2DSampleConfig*> _sampleCfgs;

    class A2DSampleInfo
    {
    public:
        A2DSampleInfo(int n)
            : nvars(n),nvalues(0),stag(0),channels(nvars) {}
        A2DSampleInfo(const A2DSampleInfo& x): nvars(x.nvars),nvalues(x.nvalues),
            stag(x.stag),channels(x.channels)
        {
        }
        A2DSampleInfo& operator= (const A2DSampleInfo& rhs)
        {
            if (&rhs != this) {
                nvars = rhs.nvars;
                nvalues = rhs.nvalues;
                stag = rhs.stag;
                channels = rhs.channels;
            }
            return *this;
        }

        ~A2DSampleInfo() { }
        int nvars;
        int nvalues;
        SampleTag* stag;
        std::vector<int> channels;
    };

    std::vector<A2DSampleInfo> _sampleInfos;

    size_t _badRawSamples;

protected:
    void initParameters();

    int _maxNChannels;

    float* _convSlopes;

    float* _convIntercepts;

private:
    int _scanRate;

    int _prevChan;

    int* _gains;

    int* _bipolars;

    A2DSensor(const A2DSensor&);

    A2DSensor& operator=(const A2DSensor&);
};

}}  // namespace nidas namespace dynld

#endif