RasterCoverageDataSetInfo.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 RasterCoverageDataSetInfo.h
22 
23  \brief This file contains a class called RasterCoverageDataSetInfo
24 */
25 
26 #ifndef __TERRALIB_ST_INTERNAL_RASTERCOVERAGEDATASETINFO_H
27 #define __TERRALIB_ST_INTERNAL_RASTERCOVERAGEDATASETINFO_H
28 
29 //ST
30 #include "../../Config.h"
31 #include "../observation/ObservationDataSetInfo.h"
32 #include "CoverageDataSetInfo.h"
33 
34 //Forward declarations
35 namespace te { namespace dt { class DateTime; } }
36 
37 namespace te
38 {
39  namespace st
40  {
41 
42  /*!
43  \class RasterCoverageDataSetInfo
44 
45  \brief A class that contains infos about a DataSource and DataSet
46  that contains observations of a raster coverage.
47 
48  \sa ObservationDataSetInfo
49  */
51  {
52  public:
53 
54  /*!
55  \brief Constructor.
56 
57  \param dsinfo Infos about the DataSource.
58  \param dsName The DataSet name.
59  \param rstPropName The property name that contains the raster associated to the coverage.
60  \param time The date and time associated to this raster coverage, when this information is not in the DataSet.
61 
62  \note It will take the ownership of the given pointers.
63  */
64  RasterCoverageDataSetInfo(const te::da::DataSourceInfo& dsinfo, const std::string& dsName,
65  const std::string& rstPropName, te::dt::DateTime* time);
66 
67  /*!
68  \brief Constructor.
69 
70  \param info Infos about the DataSource and DataSet that contains the coverage observations
71  \param rstPropName The property name that contains the raster associated to the coverage.
72  */
73  RasterCoverageDataSetInfo(const ObservationDataSetInfo& info, const std::string& rstPropName);
74 
75  /*! \name Inhered methods*/
76  //@{
77  te::st::CoverageType getCoverageType() const ;
78 
79  const ObservationDataSetInfo& getObservationDataSetInfo() const;
80  //@}
81 
82  /*!
83  \brief It returns the property index that contains the raster of the coverage.
84 
85  \return The property index that contains the raster of the coverage.
86  */
87  const std::string& getRasterPropName() const;
88 
89  /*! \brief Virtual destructor. */
90  virtual ~RasterCoverageDataSetInfo();
91 
92  protected:
93 
94  ObservationDataSetInfo m_obsDsInfo; //!< Infos about the DataSource and DataSet that contains the point coverage observations
95  std::string m_rstPropName; //!< The property index that contains the raster
96  };
97  } // end namespace st
98 } // end namespace te
99 
100 #endif // __TERRALIB_ST_INTERNAL_RASTERCOVERAGEDATASETINFO_H
101 
#define TESTEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:88
A class that contains infos about a DataSet that contains observations.
CoverageType
An enum for the types of coverage.
Definition: Enums.h:43
This file contains an abstract class called CoverageDataSetInfo.
URI C++ Library.
ObservationDataSetInfo m_obsDsInfo
Infos about the DataSource and DataSet that contains the point coverage observations.
A class that contains infos about a DataSource and DataSet that contains observations of a raster cov...
An abstract class that contains infos about a DataSource and DataSet that contains observations of a ...
A class that represents a data source component.
std::string m_rstPropName
The property index that contains the raster.