SampleSource.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
 **
 ** 2004, 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_SAMPLESOURCE_H
#define NIDAS_CORE_SAMPLESOURCE_H

#include "NidsIterators.h"
#include "SampleStats.h"
#include <nidas/util/InvalidParameterException.h>

namespace nidas { namespace core {

class SampleClient;
class SampleTag;
class Sample;

class SampleSource {
public:

    virtual ~SampleSource() {}

    virtual SampleSource* getRawSampleSource() = 0;

    virtual SampleSource* getProcessedSampleSource() = 0;

    virtual void addSampleTag(const SampleTag*)
        throw (nidas::util::InvalidParameterException) = 0;

    virtual void removeSampleTag(const SampleTag*) throw () = 0;

    virtual std::list<const SampleTag*> getSampleTags() const = 0;

    virtual SampleTagIterator getSampleTagIterator() const = 0;

    virtual void addSampleClient(SampleClient* c) throw() = 0;

    virtual void removeSampleClient(SampleClient* c) throw() = 0;

    virtual void addSampleClientForTag(SampleClient* c,const SampleTag*) throw() = 0;
    virtual void removeSampleClientForTag(SampleClient* c,const SampleTag*) throw() = 0;

    virtual int getClientCount() const throw() = 0;

    virtual void flush() throw() = 0;

    virtual const SampleStats& getSampleStats() const = 0;

};

}}  // namespace nidas namespace core


#endif