ObservationDataSetLayer.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/st/maptools/ObservationDataSetLayer.h
22 
23  \brief A layer with a reference to an ObservationDataSet.
24 */
25 
26 #ifndef __TERRALIB_ST_INTERNAL_OBSERVATIONDATASETLAYER_H
27 #define __TERRALIB_ST_INTERNAL_OBSERVATIONDATASETLAYER_H
28 
29 // ST
30 #include "../Config.h"
31 #include "AbstractSTDataSetLayer.h"
32 
33 namespace te
34 {
35  namespace st
36  {
37 
38  //Forward declarations
39  class ObservationDataSet;
40  class ObservationDataSetInfo;
41 
42  typedef te::da::DataSetType LayerSchema;
43 
44  /*!
45  \class ObservationDataSetLayer
46 
47  \brief A layer with reference to a dataset that contains observations.
48 
49  \sa AbstractLayer, AbstractSTDataSetLayer
50  */
51  class TESTEXPORT ObservationDataSetLayer : public AbstractSTDataSetLayer
52  {
53  public:
54 
55  /*!
56  \brief It initializes a new layer.
57 
58  \param parent The parent layer (NULL if it has no parent).
59  \param info Infos about the data source and its data set that contains observations.
60 
61  \note It will take the ownership of the given pointer info
62  */
63  ObservationDataSetLayer(AbstractLayer* parent, ObservationDataSetInfo* info);
64 
65  /*!
66  \brief It initializes a new layer.
67 
68  \param id The layer id.
69  \param parent The parent layer (NULL if it has no parent).
70  \param info Infos about the data source and its data set that contains observations.
71 
72  \note It will take the ownership of the given pointer info
73  */
74  ObservationDataSetLayer(const std::string& id, AbstractLayer* parent, ObservationDataSetInfo* info);
75 
76  /*!
77  \brief It initializes a new Layer.
78 
79  \param id The layer id.
80  \param title The title is a brief description about the layer.
81  \param parent The parent layer (NULL if it has no parent).
82  \param info Infos about the data source and its data set that contains observations.
83 
84  \note It will take the ownership of the given pointer info
85  */
86  ObservationDataSetLayer(const std::string& id, const std::string& title, AbstractLayer* parent, ObservationDataSetInfo* info);
87 
88  /*! \brief Destructor. */
89  ~ObservationDataSetLayer();
90 
91  AbstractLayer* clone() { return nullptr; }
92 
93  std::unique_ptr<LayerSchema> getSchema() const;
94 
95  /*!
96  \brief It returns the layer temporal extent.
97 
98  \return The layer temporal extent.
99  */
100  te::dt::DateTimePeriod* getTemporalExtent() const;
101 
102  std::unique_ptr<te::da::DataSet> getData(te::common::TraverseType travType = te::common::FORWARDONLY,
103  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
104 
105  std::unique_ptr<te::da::DataSet> getData(const std::string& propertyName,
106  const te::gm::Envelope* e,
107  te::gm::SpatialRelation r = te::gm::INTERSECTS,
108  te::common::TraverseType travType = te::common::FORWARDONLY,
109  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
110 
111  std::unique_ptr<te::da::DataSet> getData(const std::string& propertyName,
112  const te::gm::Geometry* g,
113  te::gm::SpatialRelation r,
114  te::common::TraverseType travType = te::common::FORWARDONLY,
115  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
116 
117  std::unique_ptr<te::da::DataSet> getData(te::da::Expression* restriction,
118  te::common::TraverseType travType = te::common::FORWARDONLY,
119  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
120 
121  std::unique_ptr<te::da::DataSet> getData(const te::da::ObjectIdSet* oids,
122  te::common::TraverseType travType = te::common::FORWARDONLY,
123  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
124 
125  std::unique_ptr<te::st::ObservationDataSet> getObservationDataset(te::common::TraverseType travType = te::common::FORWARDONLY) const;
126 
127  std::unique_ptr<te::st::ObservationDataSet> getObservationDataset(const te::gm::Envelope& e,
128  te::gm::SpatialRelation r = te::gm::INTERSECTS,
129  te::common::TraverseType travType = te::common::FORWARDONLY) const;
130 
131  std::unique_ptr<te::st::ObservationDataSet> getObservationDataset(const te::gm::Geometry& g,
132  te::gm::SpatialRelation r,
133  te::common::TraverseType travType = te::common::FORWARDONLY) const;
134 
135  std::unique_ptr<te::da::DataSet> getData( const te::dt::DateTime& dt, te::dt::TemporalRelation r = te::dt::DURING,
136  te::common::TraverseType travType = te::common::FORWARDONLY,
137  te::common::AccessPolicy rwRole = te::common::RAccess) const;
138 
139  std::unique_ptr<te::da::DataSet> getData( const te::dt::DateTime& dt, te::dt::TemporalRelation tr,
140  const te::gm::Envelope& e, te::gm::SpatialRelation sr = te::gm::INTERSECTS,
141  te::common::TraverseType travType = te::common::FORWARDONLY,
142  te::common::AccessPolicy rwRole = te::common::RAccess) const;
143 
144  std::unique_ptr<te::da::DataSet> getData( const te::dt::DateTime& dt, te::dt::TemporalRelation tr,
145  const te::gm::Geometry& g, te::gm::SpatialRelation sr = te::gm::INTERSECTS,
146  te::common::TraverseType travType = te::common::FORWARDONLY,
147  te::common::AccessPolicy rwRole = te::common::RAccess) const;
148 
149  std::unique_ptr<te::st::ObservationDataSet> getObservationDataset( const te::dt::DateTime& dt, te::dt::TemporalRelation r = te::dt::DURING,
150  te::common::TraverseType travType = te::common::FORWARDONLY) const;
151 
152  std::unique_ptr<te::st::ObservationDataSet> getObservationDataset( const te::dt::DateTime& dt, te::dt::TemporalRelation tr,
153  const te::gm::Envelope& e, te::gm::SpatialRelation sr = te::gm::INTERSECTS,
154  te::common::TraverseType travType = te::common::FORWARDONLY) const;
155 
156  std::unique_ptr<te::st::ObservationDataSet> getObservationDataset( const te::dt::DateTime& dt, te::dt::TemporalRelation tr,
157  const te::gm::Geometry& g, te::gm::SpatialRelation sr = te::gm::INTERSECTS,
158  te::common::TraverseType travType = te::common::FORWARDONLY) const;
159 
160  bool isValid() const;
161 
162  void draw(te::map::Canvas* canvas, const te::gm::Envelope& bbox, int srid, const double& scale, bool* cancel);
163 
164  /*!
165  \brief It returns the layer type: OBSERVATIONDATASETLAYER.
166 
167  \return The layer type: OBSERVATIONDATASETLAYER.
168  */
169  const std::string& getType() const;
170 
171  /*!
172  \brief
173 
174  \return
175  */
176  const std::string& getDataSourceId() const;
177 
178  /*!
179  \brief
180 
181  \return
182  */
183  const std::string& getRendererType() const;
184 
185  /*!
186  \brief
187 
188  \param t
189  */
190  void setRendererType(const std::string& t);
191 
192  private:
193 
194  std::unique_ptr<ObservationDataSetInfo> m_info; //!< Infos about the data source and its data set that contains observations.
195  std::string m_rendererType; //!< A pointer to the internal renderer used to paint this layer.
196  static const std::string sm_type; //!< A static data member used in the implementation of getType method.
197  };
198 
199  typedef boost::intrusive_ptr<ObservationDataSetLayer> ObservationDataSetLayerPtr;
200 
201  } // end namespace st
202 } // end namespace te
203 
204 #endif // __TERRALIB_ST_INTERNAL_OBSERVATIONDATASETLAYER_H
205 
TESTEXPORT
#define TESTEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:88
te::st::ObservationDataSetLayer::m_info
std::unique_ptr< ObservationDataSetInfo > m_info
Infos about the data source and its data set that contains observations.
Definition: ObservationDataSetLayer.h:194
te::st::ObservationDataSetLayer
A layer with reference to a dataset that contains observations.
Definition: ObservationDataSetLayer.h:51
te::st::ObservationDataSetInfo
A class that contains infos about a DataSet that contains observations.
Definition: ObservationDataSetInfo.h:70
te::st::ObservationDataSetLayerPtr
boost::intrusive_ptr< ObservationDataSetLayer > ObservationDataSetLayerPtr
Definition: ObservationDataSetLayer.h:199
te::da::DataSetType
A class that models the description of a dataset.
Definition: DataSetType.h:72
AbstractSTDataSetLayer.h
This file has the AbstractSTDataSetLayer class that provides an abstract interface for layers that co...
te::dt::TemporalRelation
TemporalRelation
Temporal relations between date and time (Source: Allen, 1991).
Definition: Enums.h:140
te::gm::SpatialRelation
SpatialRelation
Spatial relations between geometric objects.
Definition: Enums.h:127
te::da::Expression
This is an abstract class that models a query expression.
Definition: Expression.h:47
te::st::ObservationDataSetLayer::sm_type
static const std::string sm_type
A static data member used in the implementation of getType method.
Definition: ObservationDataSetLayer.h:196
te::common::AccessPolicy
AccessPolicy
Supported data access policies (can be used as bitfield).
Definition: Enums.h:40
te::common::TraverseType
TraverseType
A dataset can be traversed in two ways:
Definition: Enums.h:53
te::st::AbstractSTDataSetLayer
A layer with reference to a dataset that contains spatiotemporal data.
Definition: AbstractSTDataSetLayer.h:52
te::st::LayerSchema
te::da::DataSetType LayerSchema
Definition: ObservationDataSetLayer.h:40
te::gm::Envelope
An Envelope defines a 2D rectangular region.
Definition: Envelope.h:51
te::da::ObjectIdSet
This class represents a set of unique ids created in the same context. i.e. from the same data set...
Definition: ObjectIdSet.h:55
te
TerraLib.
Definition: AddressGeocodingOp.h:51
te::st::ObservationDataSetLayer::m_rendererType
std::string m_rendererType
A pointer to the internal renderer used to paint this layer.
Definition: ObservationDataSetLayer.h:195
te::st::ObservationDataSetLayer::clone
AbstractLayer * clone()
It returns a clone of the object.
Definition: ObservationDataSetLayer.h:91
te::gm::Geometry
Geometry is the root class of the geometries hierarchy, it follows OGC and ISO standards.
Definition: Geometry.h:75
te::map::Canvas
A canvas is an abstraction of a drawing area.
Definition: Canvas.h:92
te::dt::DateTimePeriod
An abstract class to represent a period of date and time.
Definition: DateTimePeriod.h:48