DSMService.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_DSMSERVICE_H
#define NIDAS_CORE_DSMSERVICE_H

#include <nidas/util/Thread.h>
#include "DOMable.h"
#include "NidsIterators.h"

namespace nidas { namespace core {

class Project;
class DSMServer;
class Site;
class SampleInput;
class SampleIOProcessor;
class IOChannel;

class DSMService: public DOMable
{
public:
    
    DSMService(const std::string& name);

    virtual ~DSMService();

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

    virtual void setDSMServer(DSMServer* val);

    virtual DSMServer* getDSMServer() const { return _server; }

    virtual void connect(SampleInput*) throw() = 0;

    virtual void addProcessor(SampleIOProcessor* proc)
    {
        _processors.push_back(proc);
    }

    virtual const std::list<SampleIOProcessor*>& getProcessors() const
    {
        return _processors;
    }

    const std::list<SampleInput*>& getInputs() const
    {
        return _inputs;
    }

    ProcessorIterator getProcessorIterator() const;

    virtual void schedule(bool optionalProcessing) throw(nidas::util::Exception) = 0;

    virtual int checkSubThreads() throw();

    virtual void cancel() throw();

    virtual void interrupt() throw();

    virtual int join() throw();

    static const std::string getClassName(const xercesc::DOMElement* node,
        const Project*)
    throw(nidas::util::InvalidParameterException);

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

    nidas::util::Thread::SchedPolicy getSchedPolicy() const
    {
        return _threadPolicy;
    }

    int getSchedPriority() const
    {
        return _threadPriority;
    }

    virtual void printClock(std::ostream&) throw() {}

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

protected:

    void addSubThread(nidas::util::Thread*) throw();

    std::string _name;

    DSMServer* _server;

    std::set<nidas::util::Thread*> _subThreads;

    nidas::util::Mutex _subThreadMutex;

    std::list<SampleInput*> _inputs;

    std::list<SampleIOProcessor*> _processors;

    std::list<IOChannel*> _ochans;

    nidas::util::Thread::SchedPolicy _threadPolicy;

    int _threadPriority;

private:
    DSMService(const DSMService& x);

    DSMService& operator = (const DSMService& x);

};

}}  // namespace nidas namespace core

#endif