RasterLayer.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 terralib/maptools/RasterLayer.h
22 
23  \brief A layer with reference to a raster.
24 */
25 
26 #ifndef __TERRALIB_MAPTOOLS_INTERNAL_RASTERLAYER_H
27 #define __TERRALIB_MAPTOOLS_INTERNAL_RASTERLAYER_H
28 
29 // TerraLib
30 #include "AbstractLayer.h"
31 
32 // STL
33 #include <map>
34 #include <memory>
35 
36 namespace te
37 {
38 // Forward declaration
39  namespace rst { class Raster; }
40 
41  namespace map
42  {
43  /*!
44  \class RasterLayer
45 
46  \brief A layer with reference to a raster.
47 
48  \ingroup map
49 
50  \sa AbstractLayer, DataSetLayer, QueryLayer, FolderLayer
51  */
53  {
54  public:
55 
56  /*!
57  \brief It initializes a new layer.
58 
59  \param parent The parent layer (NULL if it has no parent).
60  */
61  RasterLayer(AbstractLayer* parent = 0);
62 
63  /*!
64  \brief It initializes a new layer.
65 
66  \param id The layer id.
67  \param parent The parent layer (NULL if it has no parent).
68  */
69  RasterLayer(const std::string& id, AbstractLayer* parent = 0);
70 
71  /*!
72  \brief It initializes a new Layer.
73 
74  \param id The layer id.
75  \param title The title is a brief description about the layer.
76  \param parent The parent layer (NULL if it has no parent).
77  */
78  RasterLayer(const std::string& id, const std::string& title, AbstractLayer* parent = 0);
79 
80  /*! \brief Destructor. */
81  ~RasterLayer();
82 
83  std::auto_ptr<LayerSchema> getSchema() const;
84 
85  std::auto_ptr<te::da::DataSet> getData(te::common::TraverseType travType = te::common::FORWARDONLY,
86  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
87 
88  std::auto_ptr<te::da::DataSet> getData(const std::string& /*propertyName*/,
89  const te::gm::Envelope* /*e*/,
92  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
93 
94  std::auto_ptr<te::da::DataSet> getData(const std::string& /*propertyName*/,
95  const te::gm::Geometry* /*g*/,
98  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
99 
100  std::auto_ptr<te::da::DataSet> getData(te::da::Expression* /*restriction*/,
102  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
103 
104  std::auto_ptr<te::da::DataSet> getData(const te::da::ObjectIdSet* /*oids*/,
106  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
107 
108  /*!
109  \brief It returns the layer type: RASTER_LAYER.
110 
111  \return The layer type: RASTER_LAYER.
112  */
113  const std::string& getType() const;
114 
115  bool isValid() const;
116 
117  void draw(Canvas* canvas, const te::gm::Envelope& bbox, int srid, const double& scale, bool* cancel);
118 
119  /*!
120  \brief
121 
122  \return
123  */
124  const std::string& getRendererType() const;
125 
126  /*!
127  \brief
128 
129  \param t
130  */
131  void setRendererType(const std::string& t);
132 
133  /*!
134  \brief
135 
136  \return Raster Ptr
137 
138  \note The caller of this method WILL TAKE the ownership of the raster.
139  */
140  te::rst::Raster* getRaster() const;
141 
142  /*!
143  \brief
144 
145  \param rinfo Map of string for raster connection info.
146  */
147  void setRasterInfo(const std::map<std::string, std::string>& rinfo);
148 
149  /*!
150  \brief
151 
152  \return A raster connection info
153  */
154  std::map<std::string, std::string> getRasterInfo() const;
155 
156  private:
157 
158  std::string m_rendererType; //!< A pointer to the internal renderer used to paint this layer.
159  std::map<std::string, std::string> m_rinfo; //!< A raster connection info.
160  static const std::string sm_type; //!< A static data member used in the implementation of getType method.
161  };
162 
163  typedef boost::intrusive_ptr<RasterLayer> RasterLayerPtr;
164 
165  } // end namespace map
166 } // end namespace te
167 
168 #endif // __TERRALIB_MAPTOOLS_INTERNAL_RASTERLAYER_H
This is the base class for layers.
Definition: AbstractLayer.h:76
This is the base class for Layers.
SpatialRelation
Spatial relations between geometric objects.
Definition: Enums.h:127
This is an abstract class that models a query expression.
Definition: Expression.h:47
AccessPolicy
Supported data access policies (can be used as bitfield).
Definition: Enums.h:40
TraverseType
A dataset can be traversed in two ways:
Definition: Enums.h:53
A layer with reference to a raster.
Definition: RasterLayer.h:52
An Envelope defines a 2D rectangular region.
Definition: Envelope.h:51
This class represents a set of unique ids created in the same context. i.e. from the same data set...
Definition: ObjectIdSet.h:55
An abstract class for raster data strucutures.
Definition: Raster.h:71
URI C++ Library.
#define TEMAPEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:60
std::map< std::string, std::string > m_rinfo
A raster connection info.
Definition: RasterLayer.h:159
Geometry is the root class of the geometries hierarchy, it follows OGC and ISO standards.
Definition: Geometry.h:74
A canvas is an abstraction of a drawing area.
Definition: Canvas.h:92
static const std::string sm_type
A static data member used in the implementation of getType method.
Definition: RasterLayer.h:160
std::string m_rendererType
A pointer to the internal renderer used to paint this layer.
Definition: RasterLayer.h:158
boost::intrusive_ptr< RasterLayer > RasterLayerPtr
Definition: RasterLayer.h:163