DataSetAdapterLayer.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/DataSetAdapterLayer.h
22 
23  \brief A layer with reference to a DataSetTypeConverter.
24 */
25 
26 #ifndef __TERRALIB_MAPTOOLS_INTERNAL_DATASETADAPTERLAYER_H
27 #define __TERRALIB_MAPTOOLS_INTERNAL_DATASETADAPTERLAYER_H
28 
29 // TerraLib
30 #include "../sam/rtree/Index.h"
31 #include "../sam/rtree.h"
32 #include "AbstractLayer.h"
33 
34 namespace te
35 {
36 
37  namespace da { class DataSetTypeConverter; }
38 
39  namespace map
40  {
41  /*!
42  \class DataSetAdapterLayer
43 
44  \brief A layer with reference to a DataSetTypeConverter.
45 
46  A DataSetAdapterLayer is a reference to a DataSetTypeConverter.
47 
48  \sa AbstractLayer, QueryLayer, RasterLayer, FolderLayer, DatasetLayer
49  */
51  {
52  public:
53 
54  /*!
55  \brief It initializes a new layer.
56 
57  \param parent The parent layer (NULL if it has no parent).
58  */
60 
61  /*!
62  \brief It initializes a new layer.
63 
64  \param id The layer id.
65  \param parent The parent layer (NULL if it has no parent).
66  */
67  DataSetAdapterLayer(const std::string& id, AbstractLayer* parent = 0);
68 
69  /*!
70  \brief It initializes a new Layer.
71 
72  \param id The layer id.
73  \param title The title is a brief description about the layer.
74  \param parent The parent layer (NULL if it has no parent).
75  */
76  DataSetAdapterLayer(const std::string& id, const std::string& title, AbstractLayer* parent = 0);
77 
78  /*! \brief Destructor. */
80 
81  std::auto_ptr<LayerSchema> getSchema() const;
82 
83  std::auto_ptr<te::da::DataSet> getData(te::common::TraverseType travType = te::common::FORWARDONLY,
84  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
85 
86  std::auto_ptr<te::da::DataSet> getData(const std::string& propertyName,
87  const te::gm::Envelope* e,
90  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
91 
92  std::auto_ptr<te::da::DataSet> getData(const std::string& propertyName,
93  const te::gm::Geometry* g,
96  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
97 
98  std::auto_ptr<te::da::DataSet> getData(te::da::Expression* restriction,
100  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
101 
102  std::auto_ptr<te::da::DataSet> getData(const te::da::ObjectIdSet* oids,
104  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
105 
106  bool isValid() const;
107 
108  void draw(Canvas* canvas, const te::gm::Envelope& bbox, int srid, const double& scale, bool* cancel);
109 
110  /*!
111  \brief It returns the DataSetTypeConverter.
112 
113  \return The he DataSetTypeConverter.
114  \note The caller will not take ownership of the returned pointer.
115  */
116  te::da::DataSetTypeConverter* getConverter() const;
117 
118  /*!
119  \brief
120  It sets the converter that will be used by the layer
121  */
122  void setConverter(std::auto_ptr<te::da::DataSetTypeConverter> converter);
123 
124  /*!
125  \brief It returns the layer type: DATASET_LAYER.
126 
127  \return The layer type: DATASET_LAYER.
128  */
129  const std::string& getType() const;
130 
131  /*!
132  \brief
133 
134  \return
135  */
136  const std::string& getRendererType() const;
137 
138  /*!
139  \brief
140 
141  \param t
142  */
143  void setRendererType(const std::string& t);
144 
145  private:
146 
147  std::auto_ptr<te::da::DataSetTypeConverter> m_converter; //!< The DataSetConverter that will be cused to configure the layer.
148 
149  std::string m_rendererType; //!< A pointer to the internal renderer used to paint this layer.
150  static const std::string sm_type; //!< A static data member used in the implementation of getType method.
151 
153  };
154 
155  typedef boost::intrusive_ptr<DataSetAdapterLayer> DataSetAdapterLayerPtr;
156 
157  } // end namespace map
158 } // end namespace te
159 
160 #endif // __TERRALIB_MAPTOOLS_INTERNAL_DATASETADAPTERLAYER_H
std::auto_ptr< te::da::DataSetTypeConverter > m_converter
The DataSetConverter that will be cused to configure the layer.
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
te::sam::rtree::Index< std::size_t, 4 > m_rtree
static const std::string sm_type
A static data member used in the implementation of getType method.
This is an abstract class that models a query expression.
Definition: Expression.h:47
An converter for DataSetType.
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 DataSetTypeConverter.
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
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
Geometry is the root class of the geometries hierarchy, it follows OGC and ISO standards.
Definition: Geometry.h:74
std::string m_rendererType
A pointer to the internal renderer used to paint this layer.
A canvas is an abstraction of a drawing area.
Definition: Canvas.h:92
boost::intrusive_ptr< DataSetAdapterLayer > DataSetAdapterLayerPtr