SppSerial.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_RAF_SPPSERIAL_H
#define NIDAS_DYNLD_RAF_SPPSERIAL_H

#include <nidas/dynld/DSMSerialSensor.h>
#include <nidas/core/VariableConverter.h>

//
// Add a bogus zeroth bin to the data to match historical behavior.
// Remove all traces of this after the netCDF file refactor.
//
#define ZERO_BIN_HACK

namespace nidas { namespace dynld { namespace raf {

typedef unsigned char DMT_UShort[2];

inline unsigned short UnpackDMT_UShort(DMT_UShort dmtval)
{
    unsigned short val = (dmtval[1] << 8) | dmtval[0];
    return val;
}

inline void PackDMT_UShort(DMT_UShort dmtval, unsigned short val)
{
    dmtval[0] = val & 0xff;
    dmtval[1] = (val >> 8) & 0xff;
}


typedef unsigned char DMT_ULong[4];

inline unsigned long UnpackDMT_ULong(DMT_ULong dmtval)
{
    unsigned long val = dmtval[1] << 24 | dmtval[0] << 16 |
        dmtval[3] << 8 | dmtval[2]; // DMT byte order is 2301
    return val;
}

inline void PackDMT_ULong(DMT_ULong dmtval, unsigned long val)
{
    dmtval[0] = (val >> 16) & 0xff; // 2
    dmtval[1] = (val >> 24) & 0xff; // 3
    dmtval[2] = val & 0xff;         // 0
    dmtval[3] = (val >> 8) & 0xff;  // 1
}


class SppSerial : public DSMSerialSensor
{
public:
    enum DataTermination
    {
        FixedLength,    // CheckSum
        Delimited
    };

    SppSerial(const std::string & probe);
    ~SppSerial();

    unsigned short computeCheckSum(const unsigned char *pkt, int len);

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

    static const int MAX_CHANNELS = 40;

protected:
    virtual int packetLen() const = 0;

    virtual void
        sendInitPacketAndCheckAck(void * packet, int len, int return_len = 2) throw(nidas::util::IOException);

    virtual int appendDataAndFindGood(const Sample* sample);

    double convert(dsm_time_t tt,double val,unsigned int ivar)
    {
        if (_converters.empty()) return val;
        assert(ivar < _converters.size());
        if (!_converters[ivar]) return val;
        return _converters[ivar]->convert(tt,val);
    }

    unsigned short _model;

    int _nChannels;

    int _nHskp;

    std::string _probeName;

    unsigned short _range;

    unsigned short _triggerThreshold;

    unsigned short _opcThreshold[MAX_CHANNELS];

    int _noutValues;

    DataTermination _dataType;
    unsigned short _recDelimiter;  // only used if _dataType == Delimited

    size_t _checkSumErrorCnt;

    unsigned char* _waitingData;  // size will be 2 * packetLen()
    unsigned short _nWaitingData;
    int _skippedBytes;      // how much skipped looking for a good record?
    size_t _skippedRecordCount;
    size_t _totalRecordCount;

    struct reqPckt
    {
        char esc;       // 0x1b
        char id;        // 0x02
        DMT_UShort cksum;   // 0x001d
    };

    // unsigned int _sampleRate;


    bool _outputDeltaT;
    dsm_time_t _prevTime;

    std::vector<nidas::core::VariableConverter*> _converters;

private:

    SppSerial(const SppSerial&);

    SppSerial& operator=(const SppSerial&);

};

}}} // namespace nidas namespace dynld raf

#endif