← Back to branch summary

~ubuntu-branches/debian/sid/gdal/sid

« back to all changes in this revision

Viewing changes to swig/include/python/docs/ogr_featuredef_docs.i

  • Committer: Package Import Robot
  • Author(s): Francesco Paolo Lovergine
  • Date: 2012-05-07 15:04:42 UTC
  • mfrom: (5.5.16 experimental)
  • Revision ID: package-import@ubuntu.com-20120507150442-2eks97loeh6rq005
Tags: 1.9.0-1
* Ready for sid, starting transition.
* All symfiles updated to latest builds.
* Added dh_numpy call in debian/rules to depend on numpy ABI.
* Policy bumped to 3.9.3, no changes required.

Show diffs side-by-side

added added

removed removed

Lines of Context:
swig/include/python/docs/ogr_featuredef_docs.i
1
1
%extend OGRFeatureDefnShadow {
2
2
// File: ogrfeaturedefn_8cpp.xml
3
3
%feature("docstring")  CPL_CVSID "CPL_CVSID(\"$Id: ogrfeaturedefn.cpp
4
 
17587 2009-08-27 17:56:01Z warmerdam $\") ";
 
4
22900 2011-08-07 20:47:41Z rouault $\") ";
5
5
 
6
6
%feature("docstring")  Create "OGRFeatureDefnH OGR_FD_Create(const
7
7
char *pszName)
105
105
 
106
106
Add a new field definition to the passed feature definition.
107
107
 
 
108
To add a new field definition to a layer definition, do not use this
 
109
function directly, but use OGR_L_CreateField() instead.
 
110
 
108
111
This function should only be called while there are no OGRFeature
109
112
objects in existance based on this OGRFeatureDefn. The OGRFieldDefn
110
113
passed in is copied, and remains the responsibility of the caller.
111
114
 
112
115
This function is the same as the C++ method
113
 
OGRFeatureDefn::AddFieldDefn.
 
116
OGRFeatureDefn::AddFieldDefn().
114
117
 
115
118
Parameters:
116
119
-----------
120
123
 
121
124
hNewField:  handle to the new field definition. ";
122
125
 
 
126
%feature("docstring")  DeleteFieldDefn "OGRErr
 
127
OGR_FD_DeleteFieldDefn(OGRFeatureDefnH hDefn, int iField)
 
128
 
 
129
Delete an existing field definition.
 
130
 
 
131
To delete an existing field definition from a layer definition, do not
 
132
use this function directly, but use OGR_L_DeleteField() instead.
 
133
 
 
134
This method should only be called while there are no OGRFeature
 
135
objects in existance based on this OGRFeatureDefn.
 
136
 
 
137
This method is the same as the C++ method
 
138
OGRFeatureDefn::DeleteFieldDefn().
 
139
 
 
140
Parameters:
 
141
-----------
 
142
 
 
143
hDefn:  handle to the feature definition.
 
144
 
 
145
iField:  the index of the field defintion.
 
146
 
 
147
OGRERR_NONE in case of success.
 
148
 
 
149
OGR 1.9.0 ";
 
150
 
 
151
%feature("docstring")  ReorderFieldDefn "OGRErr
 
152
OGR_FD_ReorderFieldDefn(OGRFeatureDefnH hDefn, int *panMap)
 
153
 
 
154
Reorder the field definitions in the array of the feature definition.
 
155
 
 
156
To reorder the field definitions in a layer definition, do not use
 
157
this function directly, but use OGR_L_ReorderFields() instead.
 
158
 
 
159
This method should only be called while there are no OGRFeature
 
160
objects in existance based on this OGRFeatureDefn.
 
161
 
 
162
This method is the same as the C++ method
 
163
OGRFeatureDefn::ReorderFieldDefns().
 
164
 
 
165
Parameters:
 
166
-----------
 
167
 
 
168
hDefn:  handle to the feature definition.
 
169
 
 
170
panMap:  an array of GetFieldCount() elements which is a permutation
 
171
of [0, GetFieldCount()-1]. panMap is such that, for each field
 
172
definition at position i after reordering, its position before
 
173
reordering was panMap[i].
 
174
 
 
175
OGRERR_NONE in case of success.
 
176
 
 
177
OGR 1.9.0 ";
 
178
 
123
179
%feature("docstring")  GetGeomType "OGRwkbGeometryType
124
180
OGR_FD_GetGeomType(OGRFeatureDefnH hDefn)
125
181
 
229
285
 
230
286
the field index, or -1 if no match found. ";
231
287
 
 
288
%feature("docstring")  IsGeometryIgnored "int
 
289
OGR_FD_IsGeometryIgnored(OGRFeatureDefnH hDefn)
 
290
 
 
291
Determine whether the geometry can be omitted when fetching features.
 
292
 
 
293
This function is the same as the C++ method
 
294
OGRFeatureDefn::IsGeometryIgnored().
 
295
 
 
296
Parameters:
 
297
-----------
 
298
 
 
299
hDefn:  hanlde to the feature definition on witch OGRFeature are based
 
300
on.
 
301
 
 
302
ignore state ";
 
303
 
 
304
%feature("docstring")  SetGeometryIgnored "void
 
305
OGR_FD_SetGeometryIgnored(OGRFeatureDefnH hDefn, int bIgnore)
 
306
 
 
307
Set whether the geometry can be omitted when fetching features.
 
308
 
 
309
This function is the same as the C++ method
 
310
OGRFeatureDefn::SetGeometryIgnored().
 
311
 
 
312
Parameters:
 
313
-----------
 
314
 
 
315
hDefn:  hanlde to the feature definition on witch OGRFeature are based
 
316
on.
 
317
 
 
318
bIgnore:  ignore state ";
 
319
 
 
320
%feature("docstring")  IsStyleIgnored "int
 
321
OGR_FD_IsStyleIgnored(OGRFeatureDefnH hDefn)
 
322
 
 
323
Determine whether the style can be omitted when fetching features.
 
324
 
 
325
This function is the same as the C++ method
 
326
OGRFeatureDefn::IsStyleIgnored().
 
327
 
 
328
Parameters:
 
329
-----------
 
330
 
 
331
hDefn:  handle to the feature definition on which OGRFeature are based
 
332
on.
 
333
 
 
334
ignore state ";
 
335
 
 
336
%feature("docstring")  SetStyleIgnored "void
 
337
OGR_FD_SetStyleIgnored(OGRFeatureDefnH hDefn, int bIgnore)
 
338
 
 
339
Set whether the style can be omitted when fetching features.
 
340
 
 
341
This function is the same as the C++ method
 
342
OGRFeatureDefn::SetStyleIgnored().
 
343
 
 
344
Parameters:
 
345
-----------
 
346
 
 
347
hDefn:  hanlde to the feature definition on witch OGRFeature are based
 
348
on.
 
349
 
 
350
bIgnore:  ignore state ";
 
351
 
232
352
}
 
 
b'\\ No newline at end of file'