te::st::NearestCoverageAtTimeInterp Class Reference

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

#include <NearestCoverageAtTimeInterp.h>

Inheritance diagram for te::st::NearestCoverageAtTimeInterp:
te::st::AbstractCoverageSeriesInterp te::common::Singleton< NearestCoverageAtTimeInterp >

Public Member Functions

std::auto_ptr< Coverageestimate (const CoverageSeries &cvs, te::dt::DateTime *time) const
 It estimates a coverage of a coverage series at a given non-observed time . 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 ~NearestCoverageAtTimeInterp ()
 Virtual destructor. More...
 

Static Public Member Functions

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

Protected Member Functions

 NearestCoverageAtTimeInterp ()
 Constructor. More...
 

Friends

class te::common::Singleton< NearestCoverageAtTimeInterp >
 

Detailed Description

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

See also
AbstractCoverageSeriesInterp

Definition at line 49 of file NearestCoverageAtTimeInterp.h.

Constructor & Destructor Documentation

virtual te::st::NearestCoverageAtTimeInterp::~NearestCoverageAtTimeInterp ( )
virtual

Virtual destructor.

te::st::NearestCoverageAtTimeInterp::NearestCoverageAtTimeInterp ( )
protected

Constructor.

Member Function Documentation

std::auto_ptr<Coverage> te::st::NearestCoverageAtTimeInterp::estimate ( const CoverageSeries cvs,
te::dt::DateTime time 
) const
virtual

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

Parameters
cvsA coverage series.
timeThe given non-observed time.
Returns
The estimated coverage.
Note
It will NOT take the ownership of the given pointer.
The caller will take the ownership of the output Geometry pointer.

Implements te::st::AbstractCoverageSeriesInterp.

It returns a reference to the singleton instance.

Returns
A reference to the singleton instance.
te::common::AbstractParameters* te::st::NearestCoverageAtTimeInterp::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::AbstractCoverageSeriesInterp.

Definition at line 55 of file NearestCoverageAtTimeInterp.h.

void te::st::NearestCoverageAtTimeInterp::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::AbstractCoverageSeriesInterp.

Definition at line 57 of file NearestCoverageAtTimeInterp.h.

Friends And Related Function Documentation

Definition at line 51 of file NearestCoverageAtTimeInterp.h.


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