SampleBuffer.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
 **
 ** 2009, 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_CORE_SAMPLEBUFFER_H
#define NIDAS_CORE_SAMPLEBUFFER_H

#include <iostream>
#include <deque>

#include "SampleThread.h"
#include "SampleSourceSupport.h"

namespace nidas { namespace core {

class SampleBuffer : public SampleThread
{
public:

    SampleBuffer(const std::string& name,bool raw);

    virtual ~SampleBuffer();

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

    bool getKeepStats() const
    {
        return _source.getKeepStats();
    }

    SampleSource* getRawSampleSource()
    {
        return _source.getRawSampleSource();
    }

    SampleSource* getProcessedSampleSource()
    {
        return _source.getProcessedSampleSource();
    }

    void addSampleTag(const SampleTag* tag) throw()
    {
        _source.addSampleTag(tag);
    }

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

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

    SampleTagIterator getSampleTagIterator() const
    {
        return _source.getSampleTagIterator();
    }

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

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

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

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

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

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

    void flush() throw();

    void interrupt();

    bool receive(const Sample *s) throw();

    size_t size() const;

    void setLengthSecs(float)
    {
    }

    float getLengthSecs() const
    {
        return 0.0;
    }

    void setHeapMax(size_t val) { _heapMax = val; }

    size_t getHeapMax() const { return _heapMax; }

    size_t getHeapSize() const { return _heapSize; }

    void setHeapBlock(bool val) { _heapBlock = val; }

    bool getHeapBlock() const { return _heapBlock; }

    // void setDebug(bool val) { debug = val; }

    size_t getNumDiscardedSamples() const
    {
        return _discardedSamples;
    }

    size_t getNumFutureSamples() const
    {
        return _realTimeFutureSamples;
    }

    void setRealTime(bool val) 
    {
        _realTime = val;
    }

    bool getRealTime() const
    {
        return _realTime;
    }

    void setLateSampleCacheSize(unsigned int)
    {
    }

    unsigned int getLateSampleCacheSize() const
    {
        return 0;
    }

private:

    int run() throw(nidas::util::Exception);

// #define USE_DEQUE
#ifdef USE_DEQUE
    std::deque<const Sample*> _sampleBuf;
#else
    std::vector<const Sample*> _sampleBufs[2];

    std::vector<const Sample*>* _inserterBuf;

    std::vector<const Sample*>* _consumerBuf;
#endif

    SampleSourceSupport _source;

    void heapDecrement(size_t bytes);

    mutable nidas::util::Cond _sampleBufCond;

    nidas::util::Cond _flushCond;

    size_t _heapMax;

    size_t _heapSize;

    bool _heapBlock;

    nidas::util::Cond _heapCond;

    size_t _discardedSamples;

    size_t _realTimeFutureSamples;

    int _discardWarningCount;

    bool _doFlush;

    bool _flushed;

    bool _realTime;

    size_t sizeNoLock() const;

    bool emptyNoLock() const;


    SampleBuffer(const SampleBuffer&);

    SampleBuffer& operator=(const SampleBuffer&);

};

}}  // namespace nidas namespace core

#endif