Buffer.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2014 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 BUFFER_H
#define BUFFER_H
 
#include <meteoio/dataClasses/Grid2DObject.h>
#include <meteoio/dataClasses/DEMObject.h>
#include <meteoio/dataClasses/Date.h>
#include <meteoio/dataClasses/MeteoData.h>
 
namespace mio {
 
class MeteoBuffer {
        public:
                MeteoBuffer() : ts_buffer(), ts_start(), ts_end() {}
 
                bool get(const Date& date, METEO_SET &vecMeteo) const;
 
                bool get(const Date& date_start, const Date& date_end, std::vector< METEO_SET > &vecMeteo) const;
 
                double getAvgSamplingRate() const;
 
                Date getBufferStart() const;
 
                Date getBufferEnd() const;
                
                Date getDataStart() const;
                
                Date getDataEnd() const;
 
                bool empty() const;
 
                size_t size() const { return ts_buffer.size();}
 
                void clear();
 
                void push(const Date& date_start, const Date& date_end, const std::vector< METEO_SET >& vecMeteo);
 
 
                void push(const Date& date_start, const Date& date_end, const std::vector<MeteoData>& vecMeteo);
 
                const std::string toString() const;
 
                //HACK: these should be removed in order to hide the internals! But this requires a re-write of MeteoProcessor
                std::vector< METEO_SET >& getBuffer();
                void setBufferStart(const Date& date);
                void setBufferEnd(const Date& date);
        private:
                std::vector< METEO_SET > ts_buffer; 
                Date ts_start, ts_end; 
};
 
//TODO: make it a template so it can buffer dems, 2D, 3D grids
class GridBuffer {
        public:
                GridBuffer(const size_t& in_max_grids);
 
                bool empty() const {return IndexBufferedGrids.empty();}
                void clear() {mapBufferedGrids.clear(); mapBufferedInfos.clear(); IndexBufferedGrids.clear();}
                size_t size() const {return IndexBufferedGrids.size();}
 
                void setMaxGrids(const size_t& in_max_grids) {max_grids=in_max_grids;}
 
                bool get(DEMObject& grid, const std::string& grid_hash) const;
                bool get(Grid2DObject& grid, const std::string& grid_hash) const;
                bool get(Grid2DObject& grid, const std::string& grid_hash, std::string& grid_info) const;
                bool get(Grid2DObject& grid, const MeteoGrids::Parameters& parameter, const Date& date) const;
                
                bool has(const std::string& grid_hash) const;
                bool has(const MeteoGrids::Parameters& parameter, const Date& date) const;
 
                void push(const DEMObject& grid, const std::string& grid_hash);
                void push(const Grid2DObject& grid, const std::string& grid_hash);
                void push(const Grid2DObject& grid, const std::string& grid_hash, const std::string& grid_info);
                void push(const Grid2DObject& grid, const MeteoGrids::Parameters& parameter, const Date& date);
 
                const std::string toString() const;
        private:
                std::map<std::string, Grid2DObject> mapBufferedGrids;  
                std::map<std::string, DEMObject> mapBufferedDEMs;  
                std::map<std::string, std::string> mapBufferedInfos; 
                std::vector<std::string> IndexBufferedGrids; // this is required in order to know which grid is the oldest one
                std::vector<std::string> IndexBufferedDEMs; // this is required in order to know which grid is the oldest one
                size_t max_grids; 
};
 
}
#endif