mio::GridResamplingAlgorithm Class Reference

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_max_gap_size, const std::vector< std::pair< std::string, std::string > > &)
	Facade constructor for a generic grid resampling algorithm.
virtual	~GridResamplingAlgorithm ()=default
void	setMaxGapSize (const double &i_max_gap_size)
	Set this algorithm's max gap size to something other than the default value.
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	max_gap_size

Constructor & Destructor Documentation

GridResamplingAlgorithm()

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

Facade constructor for a generic grid resampling algorithm.

Parameters

[in]	algorithm	The current algorithm's semantic name.
[in]	i_parname	The current meteo parameter's identifier.
[in]	dflt_max_gap_size	The default max gap size that is allowed to be resampled.
[in]	vecArgs	vector 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

Implemented in mio::GridLinearResampling, mio::GridNearestResampling, and mio::GridTimeseriesResampling.

setMaxGapSize()

void mio::GridResamplingAlgorithm::setMaxGapSize

(

const double &

i_max_gap_size

)

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

Parameters

[in]

i_max_gap_size

Desired max gap size in seconds.

toString()

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

pure virtual

Implemented in mio::GridLinearResampling, mio::GridNearestResampling, and mio::GridTimeseriesResampling.

Member Data Documentation

algo

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

protected

max_gap_size

double mio::GridResamplingAlgorithm::max_gap_size

protected

parname

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

protected

---

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

• GridResamplingAlgorithms.h
• GridResamplingAlgorithms.cc