AbstractCoverageSeriesInterp.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file AbstractCoverageSeriesInterp.h
22 
23  \brief This file contains an abstract class for interpolation function
24  or interpolator that estimate coverages at non-observed times
25  of a CoverageSeries.
26 */
27 
28 #ifndef __TERRALIB_ST_INTERNAL_ABSTRACTCOVERAGESERIESINTERP_H
29 #define __TERRALIB_ST_INTERNAL_ABSTRACTCOVERAGESERIESINTERP_H
30 
31 // ST
32 #include "../../Config.h"
33 
34 // STL
35 #include <memory>
36 
37 // Forward declarations
38 namespace te { namespace dt { class DateTime; } }
39 namespace te { namespace common { class AbstractParameters; } }
40 
41 namespace te
42 {
43  namespace st
44  {
45  // Forward declarations
46  class CoverageSeries;
47  class Coverage;
48 
49  /*!
50  \class AbstractCoverageSeriesInterp
51 
52  \brief An abstract class for interpolation function or interpolator that estimate coverages
53  at non-observed times of a CoverageSeries.
54 
55  This is an abstract class for every class that implements
56  interpolation functions that estimate coverages at non-observaved times
57  of a coverage series.
58 
59  \ingroup st
60 
61  \sa CoverageSeries
62  */
64  {
65 
66  public:
67 
68  /*!
69  \brief It gets the parameters associated to the interpolator.
70 
71  \return It returns the parameters associated to the interpolator.
72 
73  \note The caller will not take the ownership of the returned pointer.
74  */
75  virtual te::common::AbstractParameters* getParams() = 0;
76 
77  /*!
78  \brief It sets the parameters associated to the interpolator.
79 
80  \param p The parameters to be associated to the interpolator.
81 
82  \note It will take the ownership of the given pointer.
83  */
84  virtual void setParams(te::common::AbstractParameters* p) = 0;
85 
86  /*!
87  \brief It estimates a coverage of a coverage series at a given non-observed time .
88 
89  \param cvs A coverage series.
90  \param time The given non-observed time.
91 
92  \return The estimated coverage.
93 
94  \note It will NOT take the ownership of the given pointer.
95  \note The caller will take the ownership of the output Geometry pointer.
96  */
97  virtual std::auto_ptr<Coverage> estimate(const CoverageSeries& cvs, te::dt::DateTime* time) const = 0;
98 
99  /*! \brief Virtual destructor. */
100  virtual ~AbstractCoverageSeriesInterp();
101 
102  protected:
103 
104  /*! \brief Constructor. */
106  };
107  } // end namespace st
108 } // end namespace te
109 
110 #endif // __TERRALIB_ST_INTERNAL_ABSTRACTCOVERAGESERIESINTERP_H
111 
#define TESTEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:88
An abstract class for interpolation function or interpolator that estimate coverages at non-observed ...
URI C++ Library.
Abstract parameters base interface.
A class to represent a coverage series.