GDAL
ogrunionlayer.h
1 /******************************************************************************
2  * $Id: ogrunionlayer.h 36501 2016-11-25 14:09:24Z rouault $
3  *
4  * Project: OpenGIS Simple Features Reference Implementation
5  * Purpose: Defines OGRUnionLayer class
6  * Author: Even Rouault, even dot rouault at mines dash paris dot org
7  *
8  ******************************************************************************
9  * Copyright (c) 2012-2014, Even Rouault <even dot rouault at mines-paris dot org>
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a
12  * copy of this software and associated documentation files (the "Software"),
13  * to deal in the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  * and/or sell copies of the Software, and to permit persons to whom the
16  * Software is furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included
19  * in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  ****************************************************************************/
29 
30 #ifndef OGRUNIONLAYER_H_INCLUDED
31 #define OGRUNIONLAYER_H_INCLUDED
32 
33 #ifndef DOXYGEN_SKIP
34 
35 #include "ogrsf_frmts.h"
36 
37 /************************************************************************/
38 /* OGRUnionLayerGeomFieldDefn */
39 /************************************************************************/
40 
41 class OGRUnionLayerGeomFieldDefn: public OGRGeomFieldDefn
42 {
43  public:
44 
45  int bGeomTypeSet;
46  int bSRSSet;
47  OGREnvelope sStaticEnvelope;
48 
49  OGRUnionLayerGeomFieldDefn(const char* pszName, OGRwkbGeometryType eType);
50  explicit OGRUnionLayerGeomFieldDefn(OGRGeomFieldDefn* poSrc);
51  explicit OGRUnionLayerGeomFieldDefn(OGRUnionLayerGeomFieldDefn* poSrc);
52  ~OGRUnionLayerGeomFieldDefn();
53 };
54 
55 /************************************************************************/
56 /* OGRUnionLayer */
57 /************************************************************************/
58 
59 typedef enum
60 {
61  FIELD_FROM_FIRST_LAYER,
62  FIELD_UNION_ALL_LAYERS,
63  FIELD_INTERSECTION_ALL_LAYERS,
64  FIELD_SPECIFIED,
65 } FieldUnionStrategy;
66 
67 class OGRUnionLayer : public OGRLayer
68 {
69  protected:
70  CPLString osName;
71  int nSrcLayers;
72  OGRLayer **papoSrcLayers;
73  int bHasLayerOwnership;
74 
75  OGRFeatureDefn *poFeatureDefn;
76  int nFields;
77  OGRFieldDefn **papoFields;
78  int nGeomFields;
79  OGRUnionLayerGeomFieldDefn **papoGeomFields;
80  FieldUnionStrategy eFieldStrategy;
81  CPLString osSourceLayerFieldName;
82 
83  int bPreserveSrcFID;
84 
85  GIntBig nFeatureCount;
86 
87  int iCurLayer;
88  char *pszAttributeFilter;
89  int nNextFID;
90  int *panMap;
91  char **papszIgnoredFields;
92  int bAttrFilterPassThroughValue;
93  int *pabModifiedLayers;
94  int *pabCheckIfAutoWrap;
95  OGRSpatialReference *poGlobalSRS;
96 
97  void AutoWarpLayerIfNecessary(int iSubLayer);
98  OGRFeature *TranslateFromSrcLayer(OGRFeature* poSrcFeature);
99  void ApplyAttributeFilterToSrcLayer(int iSubLayer);
100  int GetAttrFilterPassThroughValue();
101  void ConfigureActiveLayer();
102  void SetSpatialFilterToSourceLayer(OGRLayer* poSrcLayer);
103 
104  public:
105  OGRUnionLayer( const char* pszName,
106  int nSrcLayers, /* must be >= 1 */
107  OGRLayer** papoSrcLayers, /* array itself ownership always transferred, layer ownership depending on bTakeLayerOwnership */
108  int bTakeLayerOwnership);
109 
110  virtual ~OGRUnionLayer();
111 
112  /* All the following non virtual methods must be called just after the constructor */
113  /* and before any virtual method */
114  void SetFields(FieldUnionStrategy eFieldStrategy,
115  int nFields,
116  OGRFieldDefn** papoFields, /* duplicated by the method */
117  int nGeomFields, /* maybe -1 to explicitly disable geometry fields */
118  OGRUnionLayerGeomFieldDefn** papoGeomFields /* duplicated by the method */);
119  void SetSourceLayerFieldName(const char* pszSourceLayerFieldName);
120  void SetPreserveSrcFID(int bPreserveSrcFID);
121  void SetFeatureCount(int nFeatureCount);
122  virtual const char *GetName() override { return osName.c_str(); }
123  virtual OGRwkbGeometryType GetGeomType() override;
124 
125  virtual void ResetReading() override;
126  virtual OGRFeature *GetNextFeature() override;
127 
128  virtual OGRFeature *GetFeature( GIntBig nFeatureId ) override;
129 
130  virtual OGRErr ICreateFeature( OGRFeature* poFeature ) override;
131 
132  virtual OGRErr ISetFeature( OGRFeature* poFeature ) override;
133 
134  virtual OGRFeatureDefn *GetLayerDefn() override;
135 
136  virtual OGRSpatialReference *GetSpatialRef() override;
137 
138  virtual GIntBig GetFeatureCount( int ) override;
139 
140  virtual OGRErr SetAttributeFilter( const char * ) override;
141 
142  virtual int TestCapability( const char * ) override;
143 
144  virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent, int bForce = TRUE) override;
145  virtual OGRErr GetExtent( OGREnvelope *psExtent, int bForce ) override;
146 
147  virtual void SetSpatialFilter( OGRGeometry * poGeomIn ) override;
148  virtual void SetSpatialFilter( int iGeomField, OGRGeometry * ) override;
149 
150  virtual OGRErr SetIgnoredFields( const char **papszFields ) override;
151 
152  virtual OGRErr SyncToDisk() override;
153 };
154 
155 #endif /* #ifndef DOXYGEN_SKIP */
156 
157 #endif // OGRUNIONLAYER_H_INCLUDED
virtual OGRErr ISetFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT
Rewrite an existing feature.
Definition: ogrlayer.cpp:595
virtual OGRFeatureDefn * GetLayerDefn()=0
Fetch the schema information for this layer.
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition: ogrlayer.cpp:337
virtual OGRErr ICreateFeature(OGRFeature *poFeature) CPL_WARN_UNUSED_RESULT
Create and write a new feature within a layer.
Definition: ogrlayer.cpp:634
virtual void SetSpatialFilter(OGRGeometry *)
Set a new spatial filter.
Definition: ogrlayer.cpp:1106
Definition of a geometry field of an OGRFeatureDefn.
Definition: ogr_feature.h:141
virtual OGRErr SetIgnoredFields(const char **papszFields)
Set which fields can be omitted when retrieving features from the layer.
Definition: ogrlayer.cpp:1780
virtual const char * GetName()
Return the layer name.
Definition: ogrlayer.cpp:1716
Convenient string class based on std::string.
Definition: cpl_string.h:363
Definition of a feature class or feature layer.
Definition: ogr_feature.h:207
virtual OGRFeature * GetFeature(GIntBig nFID) CPL_WARN_UNUSED_RESULT
Fetch a feature by its identifier.
Definition: ogrlayer.cpp:445
Definition of an attribute of an OGRFeatureDefn.
Definition: ogr_feature.h:62
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:312
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition: ogrlayer.cpp:166
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:118
Classes related to registration of format support, and opening datasets.
virtual int TestCapability(const char *)=0
Test if this layer supported the named capability.
virtual void ResetReading()=0
Reset feature reading to start on the first feature.
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:132
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition: ogrlayer.cpp:1511
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:68
virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce=TRUE) CPL_WARN_UNUSED_RESULT
Fetch the extent of this layer.
Definition: ogrlayer.cpp:207
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:279
virtual OGRFeature * GetNextFeature() CPL_WARN_UNUSED_RESULT=0
Fetch the next available feature from this layer.
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:250
virtual OGRSpatialReference * GetSpatialRef()
Fetch the spatial reference system for this layer.
Definition: ogrlayer.cpp:1032
int OGRErr
Simple container for a bounding region.
Definition: ogr_core.h:285
virtual OGRwkbGeometryType GetGeomType()
Return the layer geometry type.
Definition: ogrlayer.cpp:1743

Generated for GDAL by doxygen 1.8.8.