Datasets.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
 **
 ** 2014, 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_DATASETS_H
#define NIDAS_CORE_DATASETS_H

#include <nidas/util/InvalidParameterException.h>
#include "XMLException.h"
#include "XMLParser.h"

#include <xercesc/dom/DOMElement.hpp>
#include <xercesc/dom/DOMException.hpp>

#include <list>

namespace nidas { namespace core {

class Dataset 
{
public:

    Dataset();

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

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

    const std::string& getDescription() const { return _desc; }

    void setDescription(const std::string& val) { _desc = val; }

    float getResolutionSecs() const { return _resSecs; }

    void setResolutionSecs(float val) { _resSecs = val; }

    void addEnvironmentVariable(const std::string& name, const std::string& value);

    std::map<std::string,std::string> getEnvironmentVariables() const
    {
        return _envVars;
    }

    void putenv() const;

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

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

private:

    std::string _name;

    std::string _desc;

    float _resSecs;

    std::map<std::string,std::string> _envVars;

};

class Datasets {
public:
    Datasets();

    const Dataset& getDataset(const std::string& name) const
        throw(nidas::util::InvalidParameterException);

    std::list<Dataset> getDatasets() const;

    void addDataset(const Dataset& val)
        throw(nidas::util::InvalidParameterException);

    void removeDataset(const Dataset& val);

    void parseXML(const std::string& xmlFileName,bool verbose=true)
        throw(nidas::core::XMLException,
        nidas::util::InvalidParameterException);

    void writeXML(const std::string& xmlFileName)
        throw(nidas::core::XMLException,nidas::util::IOException);

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

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


private:

    std::string _xmlName;

    std::map<std::string, Dataset> _datasetsByName;

};

}}  // namespace nidas namespace core

#endif