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