MeteoIODoc  2.10.0
mio::Meteo1DInterpolator Class Reference

Detailed Description

A class that can resample MeteoData objects.

Author
Thomas Egger
Date
2010-06-24

#include <Meteo1DInterpolator.h>

Public Member Functions

 Meteo1DInterpolator (const Config &in_cfg, const char &rank=1, const IOUtils::OperationMode &mode=IOUtils::STD)
 The default constructor Set up the interpolation algorithm for each parameter Init tasklist: a vector that holds one std::string for each parameter, representing the interpolation algorithm that will be executed for the respective parameter e.g. tasklist for TA: linear taskargs: a vector that holds the respective arguments for the algorithms as a std::vector<std::string>, so there can be multiple arguments. More...
 
 Meteo1DInterpolator (const Meteo1DInterpolator &org)=default
 
 ~Meteo1DInterpolator ()
 
bool resampleData (const Date &date, const std::string &stationHash, const std::vector< MeteoData > &vecM, MeteoData &md)
 A function that executes all the resampling algorithms that have been setup in the constructor. More...
 
void resetResampling ()
 Call each ResamplingAlgorithms to reset its cached data (as might be needed after a rebuffer) More...
 
void getWindowSize (ProcessingProperties &o_properties) const
 
Meteo1DInterpolatoroperator= (const Meteo1DInterpolator &)
 Assignement operator. More...
 
const std::string toString () const
 

Constructor & Destructor Documentation

◆ Meteo1DInterpolator() [1/2]

mio::Meteo1DInterpolator::Meteo1DInterpolator ( const Config in_cfg,
const char &  rank = 1,
const IOUtils::OperationMode mode = IOUtils::STD 
)

The default constructor Set up the interpolation algorithm for each parameter Init tasklist: a vector that holds one std::string for each parameter, representing the interpolation algorithm that will be executed for the respective parameter e.g. tasklist for TA: linear taskargs: a vector that holds the respective arguments for the algorithms as a std::vector<std::string>, so there can be multiple arguments.

Parameters
[in]in_cfgConfig object that holds the MeteoFilter configuration in the [Filters] section
[in]rankin case of multiple TimeSeriesManager, rank in the stack? (default: 1)
[in]modespatial resampling operation mode (see IOUtils::OperationMode), default IOUtils::STD

◆ Meteo1DInterpolator() [2/2]

mio::Meteo1DInterpolator::Meteo1DInterpolator ( const Meteo1DInterpolator org)
default

◆ ~Meteo1DInterpolator()

mio::Meteo1DInterpolator::~Meteo1DInterpolator ( )

Member Function Documentation

◆ getWindowSize()

void mio::Meteo1DInterpolator::getWindowSize ( ProcessingProperties o_properties) const

◆ operator=()

Meteo1DInterpolator & mio::Meteo1DInterpolator::operator= ( const Meteo1DInterpolator source)

Assignement operator.

◆ resampleData()

bool mio::Meteo1DInterpolator::resampleData ( const Date date,
const std::string &  stationHash,
const std::vector< MeteoData > &  vecM,
MeteoData md 
)

A function that executes all the resampling algorithms that have been setup in the constructor.

Parameters
[in]dateThe requested date for a MeteoData object (to be resampled if not present)
[in]stationHashA unique identifier for each timeseries (that could be used as an index for caching)
[in]vecMA vector of MeteoData where the new object will be inserted if not present
[in]mdnew MeteoData element, filled with the resampled values
Returns
true if successfull, false if no resampling was possible (no element created)

◆ resetResampling()

void mio::Meteo1DInterpolator::resetResampling ( )

Call each ResamplingAlgorithms to reset its cached data (as might be needed after a rebuffer)

◆ toString()

const std::string mio::Meteo1DInterpolator::toString ( ) const

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