DataSet.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/ogr/DataSet.h
22 
23  \brief Implementation of a DataSet for OGR data provider.
24 */
25 
26 #ifndef __TERRALIB_OGR_INTERNAL_DATASET_H
27 #define __TERRALIB_OGR_INTERNAL_DATASET_H
28 
29 #include "Config.h"
30 
31 // TerraLib
32 #include "../dataaccess/dataset/DataSet.h"
33 
34 // STL
35 #include <vector>
36 
37 // Forward declarations
38 class OGRLayer;
39 class OGRFeature;
40 //class OGRDataSource;
41 class GDALDataset;
42 
43 namespace te
44 {
45 // Forward declaration
46  namespace da
47  {
48  class DataSetType;
49  }
50 
51  namespace ogr
52  {
53  /*!
54  \class DataSet
55 
56  \brief Implementation of a DataSet for OGR data provider.
57 
58  \sa Transactor, te::da::DataSet
59  */
61  {
62  public:
63 
64  /** @name Constructor/Destructor
65  * Initilizer methods.
66  */
67  //@{
68 
69  /*! \brief Constructor. */
70  //DataSet(OGRDataSource* dsrc, OGRLayer* layer);
71  DataSet(GDALDataset* dsrc, OGRLayer* layer);
72 
73  /*! \brief Destructor. */
74  ~DataSet();
75 
76  //@}
77 
79 
81 
82  std::size_t getNumProperties() const;
83 
84  int getPropertyDataType(std::size_t pos) const;
85 
86  std::string getPropertyName(std::size_t pos) const;
87 
88  std::string getDatasetNameOfProperty(std::size_t pos) const;
89 
90  bool isEmpty() const;
91 
92  bool isConnected() const { return true; }
93 
94  std::size_t size() const;
95 
96  std::auto_ptr<te::gm::Envelope> getExtent(std::size_t i);
97 
98  bool moveNext();
99 
100  bool movePrevious();
101 
102  bool moveBeforeFirst();
103 
104  bool moveFirst();
105 
106  bool moveLast();
107 
108  bool move(std::size_t i);
109 
110  bool isAtBegin() const;
111 
112  bool isBeforeBegin() const;
113 
114  bool isAtEnd() const;
115 
116  bool isAfterEnd() const;
117 
118  char getChar(std::size_t i) const;
119 
120  unsigned char getUChar(std::size_t i) const;
121 
122  boost::int16_t getInt16(std::size_t i) const;
123 
124  boost::int32_t getInt32(std::size_t i) const;
125 
126  boost::int64_t getInt64(std::size_t i) const;
127 
128  bool getBool(std::size_t i) const;
129 
130  float getFloat(std::size_t i) const;
131 
132  double getDouble(std::size_t i) const;
133 
134  std::string getNumeric(std::size_t i) const;
135 
136  std::string getString(std::size_t i) const;
137 
138  std::auto_ptr<te::dt::ByteArray> getByteArray(std::size_t i) const;
139 
140  std::auto_ptr<te::gm::Geometry> getGeometry(std::size_t i) const;
141 
142  std::auto_ptr<te::rst::Raster> getRaster(std::size_t i) const;
143 
144  std::auto_ptr<te::dt::DateTime> getDateTime(std::size_t i) const;
145 
146  std::auto_ptr<te::dt::Array> getArray(std::size_t i) const;
147 
148  bool isNull(std::size_t i) const;
149 
150  private:
151 
152  const unsigned char* getWKB() const;
153 
154  private:
155 
156  mutable te::da::DataSetType* m_dt; //!< DataSetType.
157 
158  //OGRDataSource* m_ogrDs; //<! Pointer to OGR data source.
159  GDALDataset* m_ogrDs; //<! Pointer to OGR data source.
160  OGRLayer* m_layer; //<! A pointer to OGR Layer.
161  OGRFeature* m_currentFeature; //<! A pointer to current OGR Feature of layer.
162  int m_i; //<! The current dataset index.
163 
164  mutable unsigned char* m_wkbArray; //<! The array that stores the wkb generated by OGR Library.
165  mutable int m_wkbArraySize; //<! The size of wkb array.
166 
167  int m_srid; //!< The SRS id associated to this dataset.
168  };
169 
170  } // end namespace ogr
171 } // end namespace te
172 
173 #endif // __TERRALIB_OGR_INTERNAL_DATASET_H
te::da::DataSetType * m_dt
DataSetType.
Definition: DataSet.h:156
te::common::AccessPolicy getAccessPolicy() const
It returns the read and write permission associated to the dataset.
Definition: DataSet.h:80
A class that models the description of a dataset.
Definition: DataSetType.h:72
int m_wkbArraySize
Definition: DataSet.h:165
#define TEOGREXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:79
int m_srid
The SRS id associated to this dataset.
Definition: DataSet.h:167
Implementation of a DataSet for OGR data provider.
Definition: DataSet.h:60
GDALDataset * m_ogrDs
Definition: DataSet.h:159
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
bool isConnected() const
It returns true if the dataset is connected and false if it is disconnected. A dataset can be connect...
Definition: DataSet.h:92
unsigned char * m_wkbArray
Definition: DataSet.h:164
OGRFeature * m_currentFeature
Definition: DataSet.h:161
URI C++ Library.
Configuration flags for the OGR Driver Implementation of TerraLib.
A dataset is the unit of information manipulated by the data access module of TerraLib.
Definition: DataSet.h:112
OGRLayer * m_layer
Definition: DataSet.h:160
te::common::TraverseType getTraverseType() const
It returns the traverse type associated to the dataset.
Definition: DataSet.h:78