te::st::NearestValueAtTimeInterp Class Reference

It is an interpolation function the estimates the nearest value at a given non-observed time of a time series. More...

#include <NearestValueAtTimeInterp.h>

Inheritance diagram for te::st::NearestValueAtTimeInterp:
te::st::AbstractTimeSeriesInterp te::common::Singleton< NearestValueAtTimeInterp >

Public Member Functions

std::unique_ptr< te::dt::AbstractDataestimate (const TimeSeries &ts, te::dt::DateTime *time) const
 It estimates a value at a given non-observed time of a time series. More...
 
te::common::AbstractParametersgetParams ()
 It gets the parameters associated to the interpolator. More...
 
void setParams (te::common::AbstractParameters *p)
 It sets the parameters associated to the interpolator. More...
 
virtual ~NearestValueAtTimeInterp ()
 Virtual destructor. More...
 

Static Public Member Functions

static NearestValueAtTimeInterpgetInstance ()
 It returns a reference to the singleton instance. More...
 

Protected Member Functions

 NearestValueAtTimeInterp ()
 Constructor. More...
 

Friends

class te::common::Singleton< NearestValueAtTimeInterp >
 

Detailed Description

It is an interpolation function the estimates the nearest value at a given non-observed time of a time series.

See also
AbstractTimeSeriesInterp

Definition at line 49 of file NearestValueAtTimeInterp.h.

Constructor & Destructor Documentation

◆ ~NearestValueAtTimeInterp()

virtual te::st::NearestValueAtTimeInterp::~NearestValueAtTimeInterp ( )
virtual

Virtual destructor.

◆ NearestValueAtTimeInterp()

te::st::NearestValueAtTimeInterp::NearestValueAtTimeInterp ( )
protected

Constructor.

Member Function Documentation

◆ estimate()

std::unique_ptr<te::dt::AbstractData> te::st::NearestValueAtTimeInterp::estimate ( const TimeSeries ts,
te::dt::DateTime time 
) const
virtual

It estimates a value at a given non-observed time of a time series.

Parameters
tsA time series used in the estimation.
timeThe given non-observed time.
Returns
The estimated value.
Note
It will NOT take the ownership of the given pointer.
The caller will take the ownership of the output pointer.

Implements te::st::AbstractTimeSeriesInterp.

◆ getInstance()

NearestValueAtTimeInterp & te::common::Singleton< NearestValueAtTimeInterp >::getInstance ( )
inlinestaticinherited

It returns a reference to the singleton instance.

Returns
A reference to the singleton instance.

Definition at line 126 of file Singleton.h.

◆ getParams()

te::common::AbstractParameters* te::st::NearestValueAtTimeInterp::getParams ( )
inlinevirtual

It gets the parameters associated to the interpolator.

Returns
It returns the parameters associated to the interpolator.
Note
The caller will not take the ownership of the returned pointer.

Implements te::st::AbstractTimeSeriesInterp.

Definition at line 55 of file NearestValueAtTimeInterp.h.

◆ setParams()

void te::st::NearestValueAtTimeInterp::setParams ( te::common::AbstractParameters p)
inlinevirtual

It sets the parameters associated to the interpolator.

Parameters
pThe parameters to be associated to the interpolator.
Note
It will take the ownership of the given pointer.

Implements te::st::AbstractTimeSeriesInterp.

Definition at line 57 of file NearestValueAtTimeInterp.h.

Friends And Related Function Documentation

◆ te::common::Singleton< NearestValueAtTimeInterp >

Definition at line 51 of file NearestValueAtTimeInterp.h.


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