libacdd.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2020 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    MeteoIO 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 Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBACDD_H
#define LIBACDD_H
 
#include <meteoio/IOUtils.h>
#include <meteoio/Config.h>
#include <meteoio/dataClasses/MeteoData.h>
#include <meteoio/dataClasses/Grid2DObject.h>
 
#include <string>
#include <vector>
 
namespace mio {
class ACDD {
        public:
                enum Mode {MERGE, REPLACE, APPEND};
                struct ACDD_ATTR; //forward declaration
                struct VARS_ATTR; //forward declaration
                typedef struct ACDD_ATTR acdd_attrs;
                typedef struct VARS_ATTR vars_attr;
                
                ACDD(const bool& set_enable);
                
                //defining some iterators so the callers can loop over all available attributes
                using const_iterator = std::map<std::string, acdd_attrs>::const_iterator;
                const_iterator cbegin() const noexcept { return attributes.cbegin(); }
                const_iterator cend() const noexcept { return attributes.cend(); }
                
                void setEnabled(const bool& i_enable);
                
                void setUserConfig(const mio::Config& cfg, const std::string& section, const bool& allow_multi_line=true);
                
                void addAttribute(const std::string& att_name, const std::string& att_value, const Mode& mode=MERGE);
                void addAttribute(const std::string& att_name, const double& att_value, const Mode& mode=MERGE);
 
                void deleteAttribute(const std::string& att_name) {attributes.erase( att_name );}
 
                bool isEnabled() const {return enabled;}
 
                std::string getAttribute(std::string &att_name) const;
                
                void setGeometry(const mio::Grid2DObject& grid, const bool& isLatLon);
                void setGeometry(const std::vector< std::vector<mio::MeteoData> >& vecMeteo, const bool& isLatLon);
                void setGeometry(const mio::Coords& location, const bool& isLatLon);
                void setGeometry(const std::set< mio::Coords >& vecLocation, const bool& isLatLon);
                
                void setTimeCoverage(const std::vector< std::vector<mio::MeteoData> >& vecMeteo);
                void setTimeCoverage(const std::vector<mio::MeteoData>& vecMeteo);
                void setTimeCoverage(const std::vector<std::string>& vec_timestamp, const double& TZ);
 
                
                //support for NcML
                void setEnableNcML(const bool& i_enable);
                bool enableNcML() const {return enable_ncml;}
                void writeNcML(const std::string& data_filename) const;
                void addDimension( const std::string& var_name, const std::string& var_long_name, const size_t& length);
                void addVariable( const std::string& var_name, const std::string& var_long_name, const std::string& var_units);
                
                std::string toString() const;
                
        private:
                static std::map<std::string, acdd_attrs> initAttributes();
                static std::set< std::pair< std::string, std::set<std::string> > > initLinks();
                static size_t countCommas(const std::string& str);
                void checkLinkedAttributes();
                
                std::map<std::string, acdd_attrs> attributes; //all the ACDD attributes with their properties
                std::set< std::pair< std::string, std::set<std::string> > > linked_attributes; //attribute names that are linked together, ie must have the same number of sub-elements (comma delimited)
                std::set< vars_attr > dimensions, variables;
                bool enabled; //helper boolean for callers to know if this object should be used or not
                bool enable_ncml; //helper boolean for callers to trigger the writing of NcML files together with the data file
};
 
struct ACDD::VARS_ATTR {        //TODO at some point, this should be stored in MeteoData as timeseries metadata
        VARS_ATTR(const std::string& i_name, const std::string& i_standard_name, const std::string& i_units) : name(i_name), standard_name(i_standard_name), units(i_units), length(IOUtils::npos) {}
        VARS_ATTR(const std::string& i_name, const std::string& i_standard_name, const size_t& i_length) : name(i_name), standard_name(i_standard_name), units(), length(i_length) {}
        
        //"units" is ignored here, since with the same name and standard_name, they would have the same units
        bool operator<(const ACDD::VARS_ATTR& other) const {
        return (name < other.name) ||
               (name == other.name && standard_name < other.standard_name) ||
               (name == other.name && standard_name == other.standard_name && length < other.length);
    }
        
        std::string name, standard_name, units;
        size_t length;
};
 
 
struct ACDD::ACDD_ATTR {
        ACDD_ATTR() : name(), value(), cfg_key(), default_value(), Default(true) {}
 
        ACDD_ATTR(const std::string& i_name, const std::string& i_cfg_key, const std::string& i_default_value="") : name(i_name), value(), cfg_key(i_cfg_key), default_value(i_default_value), Default(i_name.empty()) {}
 
        ACDD_ATTR(const std::string& i_name, const std::string& i_value, const std::string& i_cfg_key, const std::string& i_default_value) : name(i_name), value(i_value), cfg_key(i_cfg_key), default_value(i_default_value), Default(false) {}
 
        std::string getValue() const {return value;}
        std::string getName() const {return name;}
        void setUserConfig(const mio::Config& cfg, const std::string& section, const bool& allow_multi_line);
        void setValue(const std::string& i_value, const Mode& mode=MERGE);
        bool isDefault() const {return Default;}
 
private:
        static void readFromFile(std::string& value, const mio::Config& cfg, const std::string& cfg_key, const std::string& section, const bool& allow_multi_line);
 
        std::string name, value, cfg_key, default_value;
        bool Default;
};
 
} //namespace
#endif