SampleOutput.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
 **
 ** 2006, 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_SAMPLEOUTPUT_H
#define NIDAS_CORE_SAMPLEOUTPUT_H
 
#include "Sample.h"
#include "SampleClient.h"
#include "Parameter.h"
#include "IOStream.h"
#include "HeaderSource.h"
#include "ConnectionRequester.h"
 
#include <nidas/util/UTime.h>
// #include <nidas/util/McSocket.h>
 
namespace nidas { namespace core {
 
class DSMConfig;
class SampleTag;
 
class SampleOutput: public SampleClient, public IOChannelRequester, public DOMable
{
public:
 
    virtual ~SampleOutput() {}
 
    virtual SampleOutput* getOriginal() const = 0;
 
    virtual void setName(const std::string& val) = 0;
 
    virtual const std::string& getName() const = 0;
 
    virtual bool isRaw() const = 0;
 
    virtual void addRequestedSampleTag(SampleTag* tag) = 0;
 
    virtual std::list<const SampleTag*> getRequestedSampleTags() const = 0;
 
    virtual void addSourceSampleTag(const SampleTag* tag) = 0;
 
    virtual void addSourceSampleTags(const std::list<const SampleTag*>& tags) = 0;
 
    virtual std::list<const SampleTag*> getSourceSampleTags() const = 0;
 
    virtual void requestConnection(SampleConnectionRequester*) = 0;
 
    virtual int getReconnectDelaySecs() const = 0;
 
    virtual void setReconnectDelaySecs(int val) = 0;
 
    virtual int getFd() const = 0;
 
    virtual IOChannel* getIOChannel() const = 0;
 
    virtual size_t write(const void* buf, size_t len) = 0;
 
    virtual void close() = 0;
 
    virtual void setHeaderSource(HeaderSource* val) = 0;
 
    virtual void setDSMConfig(const DSMConfig* val) = 0;
 
    virtual const DSMConfig* getDSMConfig() const = 0;
 
    virtual void setLatency(float val) = 0;
 
    virtual float getLatency() const = 0;
 
protected:
 
    virtual SampleOutput* clone(IOChannel* iochannel) = 0;
 
};
 
class SampleOutputBase: public SampleOutput
{
public:
 
    SampleOutputBase();
 
    SampleOutputBase(IOChannel* iochan,SampleConnectionRequester* rqstr=0);
 
    ~SampleOutputBase();
 
    virtual void setIOChannel(IOChannel* val);
 
    SampleOutput* getOriginal() const
    {
        return _original;
    }
 
    void setName(const std::string& val) { _name = val; }
 
    const std::string& getName() const { return _name; }
 
    bool isRaw() const { return false; }
 
    void addRequestedSampleTag(SampleTag* tag);
 
    std::list<const SampleTag*> getRequestedSampleTags() const;
 
    void addSourceSampleTag(const SampleTag* tag);
 
    void addSourceSampleTags(const std::list<const SampleTag*>& tags);
 
    std::list<const SampleTag*> getSourceSampleTags() const;
 
    void requestConnection(SampleConnectionRequester*);
 
    SampleOutput* connected(IOChannel* ochan);
 
    int getReconnectDelaySecs() const;
 
    void setReconnectDelaySecs(int val);
 
    int getFd() const;
 
    void close();
 
    dsm_time_t getNextFileTime() const { return _nextFileTime; }
 
    void createNextFile(dsm_time_t);
 
    size_t write(const void* buf, size_t len);
 
    void fromDOMElement(const xercesc::DOMElement* node);
 
    IOChannel* getIOChannel() const { return _iochan; }
 
    void setHeaderSource(HeaderSource* val)
    {
        _headerSource = val;
    }
 
    void setDSMConfig(const DSMConfig* val)
    {
        _dsm = val;
    }
 
    const DSMConfig* getDSMConfig() const
    {
        return _dsm;
    }
 
    size_t getNumDiscardedSamples() const { return _nsamplesDiscarded; }
 
    void addParameter(Parameter* val);
 
    const std::list<const Parameter*>& getParameters() const
    {
    return _constParameters;
    }
 
    const Parameter* getParameter(const std::string& name) const;
 
    void setLatency(float val)
    {
        _latency = val;
    }
 
    float getLatency() const { return _latency; }
 
    void
    setTimeClippingWindow(const nidas::util::UTime& startTime,
                          const nidas::util::UTime& endTime);
 
    bool receive(const Sample *s);
 
protected:
    SampleOutputBase(SampleOutputBase&,IOChannel*);
 
    size_t incrementDiscardedSamples() { return _nsamplesDiscarded++; }
 
    SampleConnectionRequester* getSampleConnectionRequester()
    {
        return _connectionRequester;
    }
 
    std::string _name;
 
    void disconnect();
 
private:
 
    mutable nidas::util::Mutex _tagsMutex;
 
    std::list<SampleTag*> _requestedTags;
 
    std::list<const SampleTag*> _constRequestedTags;
 
    IOChannel* _iochan;
 
    SampleConnectionRequester* _connectionRequester;
 
    dsm_time_t _nextFileTime;
 
    HeaderSource* _headerSource;
 
    const DSMConfig* _dsm;
 
    size_t _nsamplesDiscarded;
 
    std::map<std::string,Parameter*> _parameters;
 
    std::list<const Parameter*> _constParameters;
 
    std::list<const SampleTag*> _sourceTags;
 
    SampleOutput* _original;
 
    float _latency;
 
    int _reconnectDelaySecs;
 
    dsm_time_t _startTime;
    dsm_time_t _endTime;
 
    SampleOutputBase(const SampleOutputBase&);
 
    SampleOutputBase& operator=(const SampleOutputBase&);
 
};
 
}}  // namespace nidas namespace core
 
#endif