DSMConfig.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_DSMCONFIG_H
#define NIDAS_CORE_DSMCONFIG_H

#include "Sample.h"
#include "DOMable.h"
#include "NidsIterators.h"
#include "Dictionary.h"

#include <nidas/util/SocketAddress.h>
#include <nidas/util/IOException.h>

#include <list>

namespace nidas { namespace core {

class Project;
class Site;
class DSMSensor;
class FileSet;
class SensorHandler;
class SampleOutput;

class DSMConfig : public DOMable {
public:
    DSMConfig();
    virtual ~DSMConfig();

    void setSite(const Site* val) { _site = val; }
    const Site* getSite() const { return _site; }

    const Project* getProject() const;

    const std::string& getName() const { return _name; }
    void setName(const std::string& val) { _name = val; }

    const std::string& getLocation() const { return _location; }
    void setLocation(const std::string& val) { _location = val; }

    dsm_sample_id_t getId() const { return _id; }
    void setId(dsm_sample_id_t val) { _id = val; }

    void addSensor(DSMSensor* sensor);
    void removeSensor(DSMSensor* sensor);

    const std::list<DSMSensor*>& getSensors() const
    {
    return _allSensors;
    }

    void initSensors() throw(nidas::util::IOException);

    void openSensors(SensorHandler*);

    void addOutput(SampleOutput* output) { _outputs.push_back(output); }

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

    std::list<nidas::core::FileSet*> findSampleOutputStreamFileSets() const;

    unsigned short getRemoteSerialSocketPort() const { return _remoteSerialSocketPort; }

    void setRemoteSerialSocketPort(unsigned short val) { _remoteSerialSocketPort = val; }

    SensorIterator getSensorIterator() const;

    SampleTagIterator getSampleTagIterator() const;

    VariableIterator getVariableIterator() const;

    float getRawSorterLength() const
    {
        return _rawSorterLength;
    }

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

    float getProcSorterLength() const
    {
        return _procSorterLength;
    }

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

    size_t getRawHeapMax() const
    {
        return _rawHeapMax;
    }

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

    size_t getProcHeapMax() const
    {
        return _procHeapMax;
    }

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

    unsigned int getRawLateSampleCacheSize() const
    {
        return _rawLateSampleCacheSize;
    }

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

    unsigned int getProcLateSampleCacheSize() const
    {
        return _procLateSampleCacheSize;
    }

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

    DSMSensor* sensorFromDOMElement(const xercesc::DOMElement* node)
        throw(nidas::util::InvalidParameterException);

    void validate()
    throw(nidas::util::InvalidParameterException);

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

    xercesc::DOMElement*
        toDOMParent(xercesc::DOMElement* parent,bool complete) const
                throw(xercesc::DOMException);

    xercesc::DOMElement*
        toDOMElement(xercesc::DOMElement* node,bool complete) const
                throw(xercesc::DOMException);

    std::string expandString(const std::string& input) const
    {
        return _dictionary.expandString(input);
    }

    bool getTokenValue(const std::string& token,std::string& value) const
    {
        return _dictionary.getTokenValue(token,value);
    }

    const Dictionary& getDictionary() const
    {
        return _dictionary;
    }

    void setDerivedDataSocketAddr(const nidas::util::SocketAddress& val)
    {
        delete _derivedDataSocketAddr;
        _derivedDataSocketAddr = val.clone();
    }

    const nidas::util::SocketAddress& getDerivedDataSocketAddr() const
    {
        return *_derivedDataSocketAddr;
    }

    void setStatusSocketAddr(const nidas::util::SocketAddress& val)
    {
        delete _statusSocketAddr;
        _statusSocketAddr = val.clone();
    }

    const nidas::util::SocketAddress& getStatusSocketAddr() const
    {
        return *_statusSocketAddr;
    }

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

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

    ProcessorIterator getProcessorIterator() const;

private:

    void validateSensorAndSampleIds()
    throw(nidas::util::InvalidParameterException);

    const Site* _site;

    std::string _name;

    std::string _suffix;

    std::string _location;

    class MyDictionary : public Dictionary {
    public:
        MyDictionary(DSMConfig* dsm): _dsm(dsm) {}
        MyDictionary(const MyDictionary& x): Dictionary(),_dsm(x._dsm) {}
        MyDictionary& operator=(const MyDictionary& rhs)
        {
            if (&rhs != this) {
                *(Dictionary*) this = rhs;
                _dsm = rhs._dsm;
            }
            return *this;
        }
        bool getTokenValue(const std::string& token, std::string& value) const;
    private:
        DSMConfig* _dsm;
    } _dictionary;

    unsigned int _id;

    std::list<DSMSensor*> _ownedSensors;

    std::list<DSMSensor*> _allSensors;

    std::list<SampleOutput*> _outputs;

    unsigned short _remoteSerialSocketPort;

    float _rawSorterLength;

    float _procSorterLength;

    size_t _rawHeapMax;

    size_t _procHeapMax;

    unsigned int _rawLateSampleCacheSize;

    unsigned int _procLateSampleCacheSize;

    nidas::util::SocketAddress* _derivedDataSocketAddr;

    std::list<SampleIOProcessor*> _processors;

    nidas::util::SocketAddress* _statusSocketAddr;

private:
    // no copying
    DSMConfig(const DSMConfig& x);

    // no assignment
    DSMConfig& operator=(const DSMConfig& x);
};

}}  // namespace nidas namespace core

#endif