MeteoIODoc 20240227.fb5b3765
mio::GridResamplingAlgorithm Class Referenceabstract

Detailed Description

Interface class for grid resampling algorithms.

This class provides generic functionality to temporal grid resampling algorithms (which will inherit from this class).

#include <GridResamplingAlgorithms.h>

Public Member Functions

 GridResamplingAlgorithm (const std::string &algorithm, const std::string &i_parname, const double &dflt_window_size, const std::vector< std::pair< std::string, std::string > > &)
 Facade constructor for a generic grid resampling algorithm. More...
 
virtual ~GridResamplingAlgorithm ()=default
 
void setWindowSize (const double &window_size)
 Set this algorithm's window size to something other than the default value. More...
 
virtual void resample (const Date &date, const std::map< Date, Grid2DObject > &all_grids, Grid2DObject &resampled_grid)=0
 
virtual std::string toString () const =0
 

Protected Attributes

const std::string algo
 
const std::string parname
 
double grid_window_size
 

Constructor & Destructor Documentation

◆ GridResamplingAlgorithm()

mio::GridResamplingAlgorithm::GridResamplingAlgorithm ( const std::string &  algorithm,
const std::string &  i_parname,
const double &  dflt_window_size,
const std::vector< std::pair< std::string, std::string > > &  vecArgs 
)

Facade constructor for a generic grid resampling algorithm.

Parameters
[in]algorithmThe current algorithm's semantic name.
[in]i_parnameThe current meteo parameter's identifier.
[in]dflt_window_sizeThe default grid resampling window size.
[in]vecArgsvector of arguments (user settings) for this algorithm.

◆ ~GridResamplingAlgorithm()

virtual mio::GridResamplingAlgorithm::~GridResamplingAlgorithm ( )
virtualdefault

Member Function Documentation

◆ resample()

virtual void mio::GridResamplingAlgorithm::resample ( const Date date,
const std::map< Date, Grid2DObject > &  all_grids,
Grid2DObject resampled_grid 
)
pure virtual

◆ setWindowSize()

void mio::GridResamplingAlgorithm::setWindowSize ( const double &  window_size)

Set this algorithm's window size to something other than the default value.

Parameters
[in]window_sizeDesired window size in seconds.

◆ toString()

virtual std::string mio::GridResamplingAlgorithm::toString ( ) const
pure virtual

Member Data Documentation

◆ algo

const std::string mio::GridResamplingAlgorithm::algo
protected

◆ grid_window_size

double mio::GridResamplingAlgorithm::grid_window_size
protected

◆ parname

const std::string mio::GridResamplingAlgorithm::parname
protected

The documentation for this class was generated from the following files: