SampleIOProcessor.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_CORE_SAMPLEIOPROCESSOR_H
#define NIDAS_CORE_SAMPLEIOPROCESSOR_H


#include "ConnectionRequester.h"
#include "SampleSource.h"
#include "SampleSourceSupport.h"
#include "DOMable.h"
#include "Sample.h"  // dsm_sample_id_t

namespace nidas { namespace core {

class DSMService;
class SampleOutput;
class SampleTag;
class Parameter;

class SampleIOProcessor: public SampleSource, public SampleConnectionRequester,  public DOMable
{
public:

    SampleIOProcessor(bool raw);

    virtual ~SampleIOProcessor();

    virtual const std::string& getName() const;

    virtual void setName(const std::string& val);

    virtual void setOptional(bool val) 
    {
        _optional = val;
    }

    virtual bool isOptional() const
    {
        return _optional;
    }

    virtual const DSMService* getService() const
    {
        return _service;
    }

    virtual void setService(const DSMService* val)
    {
        _service = val;
    }

    virtual const DSMConfig* getDSMConfig() const
    {
        return _dsm;
    }

    virtual void setDSMConfig(const DSMConfig* val)
    {
        _dsm = val;
    }

    dsm_sample_id_t  getId()      const { return GET_FULL_ID(_id); }

    void setSampleId(int val) { _id = SET_SPS_ID(_id,val); }

    unsigned int getSampleId()      const { return GET_SPS_ID(_id); }

    virtual void connectSource(SampleSource*) = 0;

    virtual void disconnectSource(SampleSource*) throw() = 0;


    SampleSource* getRawSampleSource()
    {
        return 0;
    }

    SampleSource* getProcessedSampleSource()
    {
        return &_source;
    }

    virtual void addRequestedSampleTag(SampleTag* tag)
    throw(nidas::util::InvalidParameterException);

    virtual std::list<const SampleTag*> getRequestedSampleTags() const;

    void addSampleTag(const SampleTag* tag) throw();

    void removeSampleTag(const SampleTag* tag) throw();

    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();
    }

    virtual void addOutput(SampleOutput* val)
    {
    _origOutputs.push_back(val);
    }

    virtual const std::list<SampleOutput*>& getOutputs() const 
    {
        return _origOutputs;
    }

    void addParameter(Parameter* val)
    throw(nidas::util::InvalidParameterException);

    const std::list<const Parameter*>& getParameters() const
    {
    return _constParameters;
    }

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

    virtual void printStatus(std::ostream&,float,int&) throw() {}

    virtual void init(dsm_time_t) throw()
    {
    }

protected:

    void removeRequestedSampleTag(SampleTag* tag);

    SampleSourceSupport _source;

    mutable nidas::util::Mutex _tagsMutex;

    std::list<SampleTag*> _requestedTags;

private:

    std::string _name;

    dsm_sample_id_t  _id;


    std::list<const SampleTag*> _constRequestedTags;

    std::list<SampleOutput*> _origOutputs;

    bool _optional;

    const DSMService* _service;

    const DSMConfig* _dsm;

    std::list<Parameter*> _parameters;

    std::list<const Parameter*> _constParameters;


    SampleIOProcessor(const SampleIOProcessor&);

    SampleIOProcessor& operator=(const SampleIOProcessor&);

};

}}  // namespace nidas namespace core

#endif