1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
%extend OGRFeatureDefnShadow {
// File: ogrfeaturedefn_8cpp.xml
%feature("docstring") CPL_CVSID "CPL_CVSID(\"$Id: ogrfeaturedefn.cpp
22900 2011-08-07 20:47:41Z rouault $\") ";
%feature("docstring") Create "OGRFeatureDefnH OGR_FD_Create(const
char *pszName)
Create a new feature definition object to hold the field definitions.
The OGRFeatureDefn maintains a reference count, but this starts at
zero, and should normally be incremented by the owner.
This function is the same as the C++ method
OGRFeatureDefn::OGRFeatureDefn().
Parameters:
-----------
pszName: the name to be assigned to this layer/class. It does not
need to be unique.
handle to the newly created feature definition. ";
%feature("docstring") Destroy "void OGR_FD_Destroy(OGRFeatureDefnH
hDefn)
Destroy a feature definition object and release all memory associated
with it.
This function is the same as the C++ method
OGRFeatureDefn::~OGRFeatureDefn().
Parameters:
-----------
hDefn: handle to the feature definition to be destroyed. ";
%feature("docstring") Release "void OGR_FD_Release(OGRFeatureDefnH
hDefn)
Drop a reference, and destroy if unreferenced.
This function is the same as the C++ method OGRFeatureDefn::Release().
Parameters:
-----------
hDefn: handle to the feature definition to be released. ";
%feature("docstring") GetName "const char*
OGR_FD_GetName(OGRFeatureDefnH hDefn)
Get name of the OGRFeatureDefn passed as an argument.
This function is the same as the C++ method OGRFeatureDefn::GetName().
Parameters:
-----------
hDefn: handle to the feature definition to get the name from.
the name. This name is internal and should not be modified, or freed.
";
%feature("docstring") GetFieldCount "int
OGR_FD_GetFieldCount(OGRFeatureDefnH hDefn)
Fetch number of fields on the passed feature definition.
This function is the same as the C++ OGRFeatureDefn::GetFieldCount().
Parameters:
-----------
hDefn: handle to the feature definition to get the fields count from.
count of fields. ";
%feature("docstring") GetFieldDefn "OGRFieldDefnH
OGR_FD_GetFieldDefn(OGRFeatureDefnH hDefn, int iField)
Fetch field definition of the passed feature definition.
This function is the same as the C++ method
OGRFeatureDefn::GetFieldDefn().
Starting with GDAL 1.7.0, this method will also issue an error if the
index is not valid.
Parameters:
-----------
hDefn: handle to the feature definition to get the field definition
from.
iField: the field to fetch, between 0 and GetFieldCount()-1.
an handle to an internal field definition object or NULL if invalid
index. This object should not be modified or freed by the application.
";
%feature("docstring") AddFieldDefn "void
OGR_FD_AddFieldDefn(OGRFeatureDefnH hDefn, OGRFieldDefnH hNewField)
Add a new field definition to the passed feature definition.
To add a new field definition to a layer definition, do not use this
function directly, but use OGR_L_CreateField() instead.
This function should only be called while there are no OGRFeature
objects in existance based on this OGRFeatureDefn. The OGRFieldDefn
passed in is copied, and remains the responsibility of the caller.
This function is the same as the C++ method
OGRFeatureDefn::AddFieldDefn().
Parameters:
-----------
hDefn: handle to the feature definition to add the field definition
to.
hNewField: handle to the new field definition. ";
%feature("docstring") DeleteFieldDefn "OGRErr
OGR_FD_DeleteFieldDefn(OGRFeatureDefnH hDefn, int iField)
Delete an existing field definition.
To delete an existing field definition from a layer definition, do not
use this function directly, but use OGR_L_DeleteField() instead.
This method should only be called while there are no OGRFeature
objects in existance based on this OGRFeatureDefn.
This method is the same as the C++ method
OGRFeatureDefn::DeleteFieldDefn().
Parameters:
-----------
hDefn: handle to the feature definition.
iField: the index of the field defintion.
OGRERR_NONE in case of success.
OGR 1.9.0 ";
%feature("docstring") ReorderFieldDefn "OGRErr
OGR_FD_ReorderFieldDefn(OGRFeatureDefnH hDefn, int *panMap)
Reorder the field definitions in the array of the feature definition.
To reorder the field definitions in a layer definition, do not use
this function directly, but use OGR_L_ReorderFields() instead.
This method should only be called while there are no OGRFeature
objects in existance based on this OGRFeatureDefn.
This method is the same as the C++ method
OGRFeatureDefn::ReorderFieldDefns().
Parameters:
-----------
hDefn: handle to the feature definition.
panMap: an array of GetFieldCount() elements which is a permutation
of [0, GetFieldCount()-1]. panMap is such that, for each field
definition at position i after reordering, its position before
reordering was panMap[i].
OGRERR_NONE in case of success.
OGR 1.9.0 ";
%feature("docstring") GetGeomType "OGRwkbGeometryType
OGR_FD_GetGeomType(OGRFeatureDefnH hDefn)
Fetch the geometry base type of the passed feature definition.
This function is the same as the C++ method
OGRFeatureDefn::GetGeomType().
Parameters:
-----------
hDefn: handle to the feature definition to get the geometry type
from.
the base type for all geometry related to this definition. ";
%feature("docstring") SetGeomType "void
OGR_FD_SetGeomType(OGRFeatureDefnH hDefn, OGRwkbGeometryType eType)
Assign the base geometry type for the passed layer (the same as the
feature definition).
All geometry objects using this type must be of the defined type or a
derived type. The default upon creation is wkbUnknown which allows for
any geometry type. The geometry type should generally not be changed
after any OGRFeatures have been created against this definition.
This function is the same as the C++ method
OGRFeatureDefn::SetGeomType().
Parameters:
-----------
hDefn: handle to the layer or feature definition to set the geometry
type to.
eType: the new type to assign. ";
%feature("docstring") Reference "int
OGR_FD_Reference(OGRFeatureDefnH hDefn)
Increments the reference count by one.
The reference count is used keep track of the number of OGRFeature
objects referencing this definition.
This function is the same as the C++ method
OGRFeatureDefn::Reference().
Parameters:
-----------
hDefn: handle to the feature definition on witch OGRFeature are based
on.
the updated reference count. ";
%feature("docstring") Dereference "int
OGR_FD_Dereference(OGRFeatureDefnH hDefn)
Decrements the reference count by one.
This function is the same as the C++ method
OGRFeatureDefn::Dereference().
Parameters:
-----------
hDefn: handle to the feature definition on witch OGRFeature are based
on.
the updated reference count. ";
%feature("docstring") GetReferenceCount "int
OGR_FD_GetReferenceCount(OGRFeatureDefnH hDefn)
Fetch current reference count.
This function is the same as the C++ method
OGRFeatureDefn::GetReferenceCount().
Parameters:
-----------
hDefn: hanlde to the feature definition on witch OGRFeature are based
on.
the current reference count. ";
%feature("docstring") GetFieldIndex "int
OGR_FD_GetFieldIndex(OGRFeatureDefnH hDefn, const char *pszFieldName)
Find field by name.
The field index of the first field matching the passed field name
(case insensitively) is returned.
This function is the same as the C++ method
OGRFeatureDefn::GetFieldIndex.
Parameters:
-----------
hDefn: handle to the feature definition to get field index from.
pszFieldName: the field name to search for.
the field index, or -1 if no match found. ";
%feature("docstring") IsGeometryIgnored "int
OGR_FD_IsGeometryIgnored(OGRFeatureDefnH hDefn)
Determine whether the geometry can be omitted when fetching features.
This function is the same as the C++ method
OGRFeatureDefn::IsGeometryIgnored().
Parameters:
-----------
hDefn: hanlde to the feature definition on witch OGRFeature are based
on.
ignore state ";
%feature("docstring") SetGeometryIgnored "void
OGR_FD_SetGeometryIgnored(OGRFeatureDefnH hDefn, int bIgnore)
Set whether the geometry can be omitted when fetching features.
This function is the same as the C++ method
OGRFeatureDefn::SetGeometryIgnored().
Parameters:
-----------
hDefn: hanlde to the feature definition on witch OGRFeature are based
on.
bIgnore: ignore state ";
%feature("docstring") IsStyleIgnored "int
OGR_FD_IsStyleIgnored(OGRFeatureDefnH hDefn)
Determine whether the style can be omitted when fetching features.
This function is the same as the C++ method
OGRFeatureDefn::IsStyleIgnored().
Parameters:
-----------
hDefn: handle to the feature definition on which OGRFeature are based
on.
ignore state ";
%feature("docstring") SetStyleIgnored "void
OGR_FD_SetStyleIgnored(OGRFeatureDefnH hDefn, int bIgnore)
Set whether the style can be omitted when fetching features.
This function is the same as the C++ method
OGRFeatureDefn::SetStyleIgnored().
Parameters:
-----------
hDefn: hanlde to the feature definition on witch OGRFeature are based
on.
bIgnore: ignore state ";
}
|
