SamplePipeline.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_SAMPLEPIPELINE_H
#define NIDAS_CORE_SAMPLEPIPELINE_H

#include "SampleThread.h"
#include "NidsIterators.h"

namespace nidas { namespace core {

class DSMConfig;
class DSMSensor;
class SampleTag;

class SamplePipeline: public SampleSource
{
public:
    SamplePipeline();

    virtual ~SamplePipeline();

    std::string getName() const { return _name; }

    SampleSource* getRawSampleSource()
    {
        rawinit();
        return _rawSorter;
    }

    SampleSource* getProcessedSampleSource()
    {
        procinit();
        return this;
    }

    void connect(SampleSource* src) throw();

    void disconnect(SampleSource* src) throw();

    void addSampleTag(const SampleTag* tag) throw()
    {
        return _procSorter->addSampleTag(tag);
    }

    void removeSampleTag(const SampleTag* tag) throw()
    {
        return _procSorter->removeSampleTag(tag);
    }

    std::list<const SampleTag*> getSampleTags() const
    {
        return _procSorter->getSampleTags();
    }

    SampleTagIterator getSampleTagIterator() const
    {
        return _procSorter->getSampleTagIterator();
    }

    void addSampleClient(SampleClient* client) throw();

    void removeSampleClient(SampleClient* client) throw();

    void addSampleClientForTag(SampleClient*,const SampleTag*) throw();

    void removeSampleClientForTag(SampleClient*,const SampleTag*) throw();

    int getClientCount() const throw()
    {
        return _procSorter->getClientCount();
    }

    void flush() throw()
    {
        if (_rawSorter) _rawSorter->flush();
        if (_procSorter) _procSorter->flush();
    }

    void interrupt();

    void join() throw();

    void setRealTime(bool val) 
    {
        _realTime = val;
        // If running in real-time, don't block threads when heap is maxed.
        setHeapBlock(!val);
    }

    bool getRealTime() const
    {
        return _realTime;
    }

    const SampleStats& getSampleStats() const
    {
        return _procSorter->getSampleStats();
    }

    size_t getSorterNumRawSamples() const
    {
        return _rawSorter->size();
    }

    size_t getSorterNumProcSamples() const
    {
        return _procSorter->size();
    }

    size_t getSorterNumRawBytes() const
    {
        return _rawSorter->getHeapSize();
    }

    size_t getSorterNumProcBytes() const
    {
        return _procSorter->getHeapSize();
    }

    size_t getSorterNumRawBytesMax() const
    {
        return _rawSorter->getHeapMax();
    }

    size_t getSorterNumProcBytesMax() const
    {
        return _procSorter->getHeapMax();
    }

    size_t getNumDiscardedRawSamples() const
    {
        return _rawSorter->getNumDiscardedSamples();
    }

    size_t getNumDiscardedProcSamples() const
    {
        return _procSorter->getNumDiscardedSamples();
    }

    size_t getNumFutureRawSamples() const
    {
        return _rawSorter->getNumFutureSamples();
    }

    size_t getNumFutureProcSamples() const
    {
        return _procSorter->getNumFutureSamples();
    }

    void setRawSorterLength(float val)
    {
        _rawSorterLength = val;
    }

    float getRawSorterLength() const
    {
        return _rawSorterLength;
    }

    void setProcSorterLength(float val)
    {
        _procSorterLength = val;
    }

    float getProcSorterLength() const
    {
        return _procSorterLength;
    }

    void setRawHeapMax(size_t val) { _rawHeapMax = val; }

    size_t getRawHeapMax() const { return _rawHeapMax; }

    void setProcHeapMax(size_t val) { _procHeapMax = val; }

    size_t getProcHeapMax() const { return _procHeapMax; }

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

    bool getHeapBlock() const { return _heapBlock; }

    void setKeepStats(bool val)
    {
        _keepStats = val;
    }

    void setRawLateSampleCacheSize(unsigned int val)
    {
        _rawLateSampleCacheSize = val;
    }

    unsigned int getRawLateSampleCacheSize() const
    {
        return _rawLateSampleCacheSize;
    }

    void setProcLateSampleCacheSize(unsigned int val)
    {
        _procLateSampleCacheSize = val;
    }

    unsigned int getProcLateSampleCacheSize() const
    {
        return _procLateSampleCacheSize;
    }

private:

    void rawinit();

    void procinit();

    std::string _name;

    nidas::util::Mutex _rawMutex;

    SampleThread* _rawSorter;

    nidas::util::Mutex _procMutex;

    SampleThread* _procSorter;

    std::list<const SampleTag*> _sampleTags;

    std::list<const DSMConfig*> _dsmConfigs;

    bool _realTime;

    float _rawSorterLength;

    float _procSorterLength;

    size_t _rawHeapMax;

    size_t _procHeapMax;

    bool _heapBlock;

    bool _keepStats;

    unsigned int _rawLateSampleCacheSize;

    unsigned int _procLateSampleCacheSize;

    SamplePipeline(const SamplePipeline& x);

    SamplePipeline& operator = (const SamplePipeline& x);

};

}}  // namespace nidas namespace core

#endif