SampleInputStream.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
 **
 ** 2005, 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_SAMPLEINPUTSTREAM_H
#define NIDAS_DYNLD_SAMPLEINPUTSTREAM_H

#include <nidas/core/SampleInput.h>
#include <nidas/core/SampleInputHeader.h>
#include <nidas/core/SampleSourceSupport.h>
#include <nidas/core/SampleStats.h>
#include <nidas/core/Sample.h>
#include <nidas/core/NidsIterators.h>
#include <nidas/core/NidasApp.h>
#include <nidas/util/UTime.h>
#include <nidas/core/BadSampleFilter.h>

namespace nidas {

namespace core {
class DSMService;
class DSMConfig;
class SampleTag;
class SampleStats;
class SampleClient;
class SampleSource;
class Sample;
class IOChannel;
class IOStream;
}

namespace dynld {

struct BlockStats {

    typedef nidas::core::dsm_time_t dsm_time_t;

    BlockStats(bool goodblock=true, size_t startblock=0);

    bool
    addGoodSample(nidas::core::Sample* samp, long long offset);

    void
    addBadSample(long long offset, unsigned int nbadbytes);

    void
    startBadBlock(long long offset);

    void
    endBadBlock(nidas::core::Sample* samp, long long offset);

    inline size_t
    blockEnd() const
    {
        return block_start + nbytes;
    }

    dsm_time_t start_time;
    dsm_time_t end_time;

    bool good;

    size_t nsamples;

    /*
     * File position of start of this block.
     */
    size_t block_start;

    size_t nbytes;

    unsigned int last_good_sample_size;
};

class SampleInputStream: public nidas::core::SampleInput
{
public:
    typedef nidas::core::dsm_time_t dsm_time_t;

    SampleInputStream(bool raw=false);

    SampleInputStream(nidas::core::IOChannel* iochannel,bool raw=false);

    virtual SampleInputStream* clone(nidas::core::IOChannel* iochannel);

    virtual ~SampleInputStream();

    std::string getName() const;

    int getFd() const;

    virtual void setIOChannel(nidas::core::IOChannel* val);

    void readInputHeader() throw(nidas::util::IOException);

    bool parseInputHeader() throw(nidas::util::IOException);

    const nidas::core::SampleInputHeader& getInputHeader() const
    {
        return _inputHeader;
    }

    void requestConnection(nidas::core::DSMService*) throw(nidas::util::IOException);

    virtual nidas::core::SampleInput* getOriginal() const
    {
        return _original;
    }

    nidas::core::SampleInput* connected(nidas::core::IOChannel* iochan) throw();

    void setNonBlocking(bool val) throw(nidas::util::IOException);

    bool isNonBlocking() const throw(nidas::util::IOException);

    const nidas::core::DSMConfig* getDSMConfig() const;

    // void init() throw();

    void setKeepStats(bool val)
    {
        _source.setKeepStats(val);
    }

    void addSampleTag(const nidas::core::SampleTag* tag) throw()
    {
        return _source.addSampleTag(tag);
    }

    void removeSampleTag(const nidas::core::SampleTag* tag) throw()
    {
        _source.removeSampleTag(tag);
    }

    nidas::core::SampleSource* getRawSampleSource()
    {
        return _source.getRawSampleSource();
    }

    nidas::core::SampleSource* getProcessedSampleSource()
    {
        return _source.getProcessedSampleSource();
    }

    std::list<const nidas::core::SampleTag*> getSampleTags() const
    {
        return _source.getSampleTags();
    }

    nidas::core::SampleTagIterator getSampleTagIterator() const
    {
        return _source.getSampleTagIterator();
    }

    void addSampleClient(nidas::core::SampleClient* client) throw()
    {
        _source.addSampleClient(client);
    }

    void removeSampleClient(nidas::core::SampleClient* client) throw()
    {
        _source.removeSampleClient(client);
    }

    void addSampleClientForTag(nidas::core::SampleClient* client,const nidas::core::SampleTag* tag) throw()
    {
        _source.addSampleClientForTag(client,tag);
    }

    void removeSampleClientForTag(nidas::core::SampleClient* client,const nidas::core::SampleTag* tag) throw()
    {
        _source.removeSampleClientForTag(client,tag);
    }

    int getClientCount() const throw()
    {
        return _source.getClientCount();
    }

    void flush() throw();

    const nidas::core::SampleStats& getSampleStats() const
    {
        return _source.getSampleStats();
    }

    bool readSamples() throw(nidas::util::IOException);

    void search(const nidas::util::UTime& tt) throw(nidas::util::IOException);

    nidas::core::Sample* readSample() throw(nidas::util::IOException);


    void distribute(const nidas::core::Sample* s) throw()
    {
        return _source.distribute(s);
    }

    size_t getBadSamples() const { return _badSamples; }

    void close() throw(nidas::util::IOException);

    void setBadSampleFilter(const nidas::core::BadSampleFilter& bsf)
    {
        _bsf = bsf;
    }

    void setFilterBadSamples(bool val)
    {
        _bsf.setFilterBadSamples(val);
    }

    void setMinDsmId(int val)
    {
        _bsf.setMinDsmId(val);
    }

    void setMaxDsmId(int val)
    {
        _bsf.setMaxDsmId(val);
    }

    void setMinSampleLength(unsigned int val)
    {
        _bsf.setMinSampleLength(val);
    }

    void setMaxSampleLength(unsigned int val)
    {
        _bsf.setMaxSampleLength(val);
    }

    void setMinSampleTime(const nidas::util::UTime& val)
    {
        _bsf.setMinSampleTime(val);
    }

    void setMaxSampleTime(const nidas::util::UTime& val)
    {
        _bsf.setMaxSampleTime(val);
    }

    void fromDOMElement(const xercesc::DOMElement* node)
    throw(nidas::util::InvalidParameterException);

    void setExpectHeader(bool val) { _expectHeader = val; }

    bool getExpectHeader() const { return _expectHeader; }

protected:

    SampleInputStream(SampleInputStream& x,nidas::core::IOChannel* iochannel);

    nidas::core::IOChannel* _iochan;

    nidas::core::SampleSourceSupport _source;

private:

    nidas::core::Sample* nextSample() throw();

    nidas::core::Sample* nextSample(bool keepreading,
                                    bool searching=false,
                                    dsm_time_t search_time=LONG_LONG_MIN)
        throw(nidas::util::IOException);

    void checkUnexpectedEOF();

    struct ReadResult
    {
    public:
        ReadResult(size_t ilen=0, bool inewinput=false, bool ieof=false):
            len(ilen), newinput(inewinput), eof(ieof)
        {}
        size_t len;
        bool newinput;
        bool eof;
    };

    ReadResult
    readBlock(bool keepreading, char* &ptr, size_t& lentoread);

    ReadResult
    read(bool keepreading, char* ptr, size_t lentoread);

    void
    handleNewInput();

    nidas::core::Sample*
    handleEOF(bool keepreading);

    void closeBlocks();

    nidas::core::Sample* sampleFromHeader() throw();

    nidas::core::DSMService* _service;

    nidas::core::IOStream* _iostream;

    /* mutable */ const nidas::core::DSMConfig* _dsm;

    bool _expectHeader;

    bool _inputHeaderParsed;

    nidas::core::SampleHeader _sheader;

    size_t _headerToRead;

    char* _hptr;

    nidas::core::Sample* _samp;

    nidas::core::Sample* _sampPending;

    size_t _dataToRead;

    char* _dptr;

    bool _skipSample;

    BlockStats _block;

    size_t _badSamples;

    size_t _goodSamples;

    nidas::core::SampleInputHeader _inputHeader;

    nidas::core::BadSampleFilter _bsf;

    SampleInputStream* _original;

    // XXX This is no longer used and is deprecated.  Someday it will be
    // removed from here and from the constructor signatures. XXX
    bool _raw;

    std::string _last_name;

    nidas::util::EOFException _eofx;
    bool _ateof;

    SampleInputStream(const SampleInputStream& x);

    SampleInputStream& operator =(const SampleInputStream& x);

};

}}  // namespace nidas namespace dynld

#endif