GDAL
|
A simple feature, including geometry and attributes. More...
#include <ogr_feature.h>
Classes | |
class | ConstFieldIterator |
Field value iterator class. More... | |
class | FieldNotFoundException |
Exception raised by operator[](const char*) when a field is not found. More... | |
class | FieldValue |
Field value. More... | |
Public Member Functions | |
OGRFeature (OGRFeatureDefn *) | |
Constructor. | |
ConstFieldIterator | begin () const |
Return begin of field value iterator. | |
ConstFieldIterator | end () const |
Return end of field value iterator. | |
const FieldValue | operator[] (int iField) const |
Return a field value. | |
FieldValue | operator[] (int iField) |
Return a field value. | |
const FieldValue | operator[] (const char *pszFieldName) const |
Return a field value. | |
FieldValue | operator[] (const char *pszFieldName) |
Return a field value. | |
OGRFeatureDefn * | GetDefnRef () |
Fetch feature definition. | |
const OGRFeatureDefn * | GetDefnRef () const |
Fetch feature definition. | |
OGRErr | SetGeometryDirectly (OGRGeometry *) |
Set feature geometry. | |
OGRErr | SetGeometry (const OGRGeometry *) |
Set feature geometry. | |
OGRErr | SetGeometry (std::unique_ptr< OGRGeometry >) |
Set feature geometry. | |
OGRGeometry * | GetGeometryRef () |
Fetch pointer to feature geometry. | |
const OGRGeometry * | GetGeometryRef () const |
Fetch pointer to feature geometry. | |
OGRGeometry * | StealGeometry () |
Take away ownership of geometry. | |
int | GetGeomFieldCount () const |
Fetch number of geometry fields on this feature. | |
OGRGeomFieldDefn * | GetGeomFieldDefnRef (int iField) |
Fetch definition for this geometry field. | |
const OGRGeomFieldDefn * | GetGeomFieldDefnRef (int iField) const |
Fetch definition for this geometry field. | |
int | GetGeomFieldIndex (const char *pszName) const |
Fetch the geometry field index given geometry field name. | |
OGRGeometry * | GetGeomFieldRef (int iField) |
Fetch pointer to feature geometry. | |
const OGRGeometry * | GetGeomFieldRef (int iField) const |
Fetch pointer to feature geometry. | |
OGRGeometry * | StealGeometry (int iField) |
Take away ownership of geometry. | |
OGRGeometry * | GetGeomFieldRef (const char *pszFName) |
Fetch pointer to feature geometry. | |
const OGRGeometry * | GetGeomFieldRef (const char *pszFName) const |
Fetch pointer to feature geometry. | |
OGRErr | SetGeomFieldDirectly (int iField, OGRGeometry *) |
Set feature geometry of a specified geometry field. | |
OGRErr | SetGeomField (int iField, const OGRGeometry *) |
Set feature geometry of a specified geometry field. | |
OGRErr | SetGeomField (int iField, std::unique_ptr< OGRGeometry >) |
Set feature geometry of a specified geometry field. | |
void | Reset () |
Reset the state of a OGRFeature to its state after construction. | |
OGRFeature * | Clone () const |
Duplicate feature. | |
virtual OGRBoolean | Equal (const OGRFeature *poFeature) const |
Test if two features are the same. | |
int | GetFieldCount () const |
Fetch number of fields on this feature. | |
const OGRFieldDefn * | GetFieldDefnRef (int iField) const |
Fetch definition for this field. | |
OGRFieldDefn * | GetFieldDefnRef (int iField) |
Fetch definition for this field. | |
int | GetFieldIndex (const char *pszName) const |
Fetch the field index given field name. | |
int | IsFieldSet (int iField) const |
Test if a field has ever been assigned a value or not. | |
void | UnsetField (int iField) |
Clear a field, marking it as unset. | |
bool | IsFieldNull (int iField) const |
Test if a field is null. | |
void | SetFieldNull (int iField) |
Clear a field, marking it as null. | |
bool | IsFieldSetAndNotNull (int iField) const |
Test if a field is set and not null. | |
OGRField * | GetRawFieldRef (int i) |
Fetch a pointer to the internal field value given the index. | |
const OGRField * | GetRawFieldRef (int i) const |
Fetch a pointer to the internal field value given the index. | |
int | GetFieldAsInteger (int i) const |
Fetch field value as integer. | |
GIntBig | GetFieldAsInteger64 (int i) const |
Fetch field value as integer 64 bit. | |
double | GetFieldAsDouble (int i) const |
Fetch field value as a double. | |
const char * | GetFieldAsString (int i) const |
Fetch field value as a string. | |
const char * | GetFieldAsISO8601DateTime (int i, CSLConstList papszOptions) const |
Fetch OFTDateTime field value as a ISO8601 representation. | |
const int * | GetFieldAsIntegerList (int i, int *pnCount) const |
Fetch field value as a list of integers. | |
const GIntBig * | GetFieldAsInteger64List (int i, int *pnCount) const |
Fetch field value as a list of 64 bit integers. | |
const double * | GetFieldAsDoubleList (int i, int *pnCount) const |
Fetch field value as a list of doubles. | |
char ** | GetFieldAsStringList (int i) const |
Fetch field value as a list of strings. | |
GByte * | GetFieldAsBinary (int i, int *pnCount) const |
Fetch field value as binary data. | |
int | GetFieldAsDateTime (int i, int *pnYear, int *pnMonth, int *pnDay, int *pnHour, int *pnMinute, int *pnSecond, int *pnTZFlag) const |
Fetch field value as date and time. | |
int | GetFieldAsDateTime (int i, int *pnYear, int *pnMonth, int *pnDay, int *pnHour, int *pnMinute, float *pfSecond, int *pnTZFlag) const |
Fetch field value as date and time. | |
char * | GetFieldAsSerializedJSon (int i) const |
Fetch field value as a serialized JSon object. | |
int | GetFieldAsInteger (const char *pszFName) const |
Fetch field value as integer. | |
GIntBig | GetFieldAsInteger64 (const char *pszFName) const |
Fetch field value as integer 64 bit. | |
double | GetFieldAsDouble (const char *pszFName) const |
Fetch field value as a double. | |
const char * | GetFieldAsString (const char *pszFName) const |
Fetch field value as a string. | |
const char * | GetFieldAsISO8601DateTime (const char *pszFName, CSLConstList papszOptions) const |
Fetch OFTDateTime field value as a ISO8601 representation. | |
const int * | GetFieldAsIntegerList (const char *pszFName, int *pnCount) const |
Fetch field value as a list of integers. | |
const GIntBig * | GetFieldAsInteger64List (const char *pszFName, int *pnCount) const |
Fetch field value as a list of 64 bit integers. | |
const double * | GetFieldAsDoubleList (const char *pszFName, int *pnCount) const |
Fetch field value as a list of doubles. | |
char ** | GetFieldAsStringList (const char *pszFName) const |
Fetch field value as a list of strings. | |
void | SetField (int i, int nValue) |
Set field to integer value. | |
void | SetField (int i, GIntBig nValue) |
Set field to 64 bit integer value. | |
void | SetField (int i, double dfValue) |
Set field to double value. | |
void | SetField (int i, const char *pszValue) |
Set field to string value. | |
void | SetField (int i, int nCount, const int *panValues) |
Set field to list of integers value. | |
void | SetField (int i, int nCount, const GIntBig *panValues) |
Set field to list of 64 bit integers value. | |
void | SetField (int i, int nCount, const double *padfValues) |
Set field to list of doubles value. | |
void | SetField (int i, const char *const *papszValues) |
Set field to list of strings value. | |
void | SetField (int i, const OGRField *puValue) |
Set field. | |
void | SetField (int i, int nCount, const void *pabyBinary) |
Set field to binary data. | |
void | SetField (int i, int nYear, int nMonth, int nDay, int nHour=0, int nMinute=0, float fSecond=0.f, int nTZFlag=0) |
Set field to date. | |
void | SetField (const char *pszFName, int nValue) |
Set field to integer value. | |
void | SetField (const char *pszFName, GIntBig nValue) |
Set field to 64 bit integer value. | |
void | SetField (const char *pszFName, double dfValue) |
Set field to double value. | |
void | SetField (const char *pszFName, const char *pszValue) |
Set field to string value. | |
void | SetField (const char *pszFName, int nCount, const int *panValues) |
This method currently on has an effect of OFTIntegerList, OFTInteger64List and OFTRealList fields. | |
void | SetField (const char *pszFName, int nCount, const GIntBig *panValues) |
Set field to list of 64 bit integers value. | |
void | SetField (const char *pszFName, int nCount, const double *padfValues) |
This method currently on has an effect of OFTIntegerList, OFTInteger64List, OFTRealList fields. | |
void | SetField (const char *pszFName, const char *const *papszValues) |
This method currently on has an effect of OFTStringList fields. | |
void | SetField (const char *pszFName, const OGRField *puValue) |
Set field. | |
void | SetField (const char *pszFName, int nYear, int nMonth, int nDay, int nHour=0, int nMinute=0, float fSecond=0.f, int nTZFlag=0) |
Set field to date. | |
GIntBig | GetFID () const |
Get feature identifier. | |
virtual OGRErr | SetFID (GIntBig nFIDIn) |
Set the feature identifier. | |
void | DumpReadable (FILE *, CSLConstList papszOptions=nullptr) const |
Dump this feature in a human readable form. | |
std::string | DumpReadableAsString (CSLConstList papszOptions=nullptr) const |
Dump this feature in a human readable form. | |
OGRErr | SetFrom (const OGRFeature *, int bForgiving=TRUE) |
Set one feature from another. | |
OGRErr | SetFrom (const OGRFeature *, const int *panMap, int bForgiving=TRUE, bool bUseISO8601ForDateTimeAsString=false) |
Set one feature from another. | |
OGRErr | SetFieldsFrom (const OGRFeature *, const int *panMap, int bForgiving=TRUE, bool bUseISO8601ForDateTimeAsString=false) |
Set fields from another feature. | |
int | Validate (int nValidateFlags, int bEmitError) const |
Validate that a feature meets constraints of its schema. | |
void | FillUnsetWithDefault (int bNotNullableOnly, char **papszOptions) |
Fill unset fields with default values that might be defined. | |
bool | SerializeToBinary (std::vector< GByte > &abyBuffer) const |
Serialize the feature to a binary encoding. | |
bool | DeserializeFromBinary (const GByte *pabyBuffer, size_t nSize) |
Instantiate a feature from a binary encoding produces by SerializeToBinary() | |
virtual const char * | GetStyleString () const |
Fetch style string for this feature. | |
virtual void | SetStyleString (const char *) |
Set feature style string. | |
virtual void | SetStyleStringDirectly (char *) |
Set feature style string. | |
virtual OGRStyleTable * | GetStyleTable () const |
Return style table. | |
virtual void | SetStyleTable (OGRStyleTable *poStyleTable) |
Set style table. | |
virtual void | SetStyleTableDirectly (OGRStyleTable *poStyleTable) |
Set style table. | |
const char * | GetNativeData () const |
Returns the native data for the feature. | |
const char * | GetNativeMediaType () const |
Returns the native media type for the feature. | |
void | SetNativeData (const char *pszNativeData) |
Sets the native data for the feature. | |
void | SetNativeMediaType (const char *pszNativeMediaType) |
Sets the native media type for the feature. | |
Static Public Member Functions | |
static OGRFeature * | CreateFeature (OGRFeatureDefn *) |
Feature factory. | |
static void | DestroyFeature (OGRFeature *) |
Destroy feature. | |
static OGRFeatureH | ToHandle (OGRFeature *poFeature) |
Convert a OGRFeature* to a OGRFeatureH. | |
static OGRFeature * | FromHandle (OGRFeatureH hFeature) |
Convert a OGRFeatureH to a OGRFeature*. | |
Protected Member Functions | |
bool | CopySelfTo (OGRFeature *poNew) const |
Copies the innards of this OGRFeature into the supplied object. | |
A simple feature, including geometry and attributes.
|
explicit |
Constructor.
Note that the OGRFeature will increment the reference count of its defining OGRFeatureDefn. Destruction of the OGRFeatureDefn before destruction of all OGRFeatures that depend on it is likely to result in a crash.
This method is the same as the C function OGR_F_Create().
poDefnIn | feature class (layer) definition to which the feature will adhere. |
OGRFeature::ConstFieldIterator OGRFeature::begin | ( | ) | const |
Return begin of field value iterator.
Using this iterator for standard range-based loops is safe, but due to implementation limitations, you shouldn't try to access (dereference) more than one iterator step at a time, since you will get a reference to the same object (FieldValue) at each iteration step.
for( auto&& oField: poFeature ) { std::cout << oField.GetIndex() << "," << oField.GetName()<< ": " << oField.GetAsString() << std::endl; }
OGRFeature * OGRFeature::Clone | ( | ) | const |
Duplicate feature.
The newly created feature is owned by the caller, and will have its own reference to the OGRFeatureDefn.
This method is the same as the C function OGR_F_Clone().
|
protected |
Copies the innards of this OGRFeature into the supplied object.
This is mainly intended to allow derived classes to implement their own Clone functions.
poNew | The object into which to copy the data of this object. |
|
static |
Feature factory.
This is essentially a feature factory, useful for applications creating features but wanting to ensure they are created out of the OGR/GDAL heap.
This method is the same as the C function OGR_F_Create().
poDefn | Feature definition defining schema. |
bool OGRFeature::DeserializeFromBinary | ( | const GByte * | pabyBuffer, |
size_t | nSize | ||
) |
Instantiate a feature from a binary encoding produces by SerializeToBinary()
This sets the feature ID, attribute fields content and geometry fields content.
DeserializeFromBinary() should be called on a feature whose feature definition is exactly the same as the one on which SerializeToBinary() was called. (but there is no security issue if not doing that, or if feeding a "random" buffer to that method).
The format of that encoding may vary across GDAL versions.
|
static |
Destroy feature.
The feature is deleted, but within the context of the GDAL/OGR heap. This is necessary when higher level applications use GDAL/OGR from a DLL and they want to delete a feature created within the DLL. If the delete is done in the calling application the memory will be freed onto the application heap which is inappropriate.
This method is the same as the C function OGR_F_Destroy().
poFeature | the feature to delete. |
void OGRFeature::DumpReadable | ( | FILE * | fpOut, |
CSLConstList | papszOptions = nullptr |
||
) | const |
Dump this feature in a human readable form.
This dumps the attributes, and geometry; however, it doesn't definition information (other than field types and names), nor does it report the geometry spatial reference system.
A few options can be defined to change the default dump :
This method is the same as the C function OGR_F_DumpReadable().
fpOut | the stream to write to, such as stdout. If NULL stdout will be used. |
papszOptions | NULL terminated list of options (may be NULL) |
std::string OGRFeature::DumpReadableAsString | ( | CSLConstList | papszOptions = nullptr | ) | const |
Dump this feature in a human readable form.
This dumps the attributes, and geometry; however, it doesn't definition information (other than field types and names), nor does it report the geometry spatial reference system.
A few options can be defined to change the default dump :
papszOptions | NULL terminated list of options (may be NULL) |
|
virtual |
Test if two features are the same.
Two features are considered equal if the share them (pointer equality) same OGRFeatureDefn, have the same field values, and the same geometry (as tested by OGRGeometry::Equal()) as well as the same feature id.
This method is the same as the C function OGR_F_Equal().
poFeature | the other feature to test this one against. |
void OGRFeature::FillUnsetWithDefault | ( | int | bNotNullableOnly, |
char ** | papszOptions | ||
) |
Fill unset fields with default values that might be defined.
This method is the same as the C function OGR_F_FillUnsetWithDefault().
bNotNullableOnly | if we should fill only unset fields with a not-null constraint. |
papszOptions | unused currently. Must be set to NULL. |
|
inlinestatic |
Convert a OGRFeatureH to a OGRFeature*.
|
inline |
Fetch feature definition.
This method is the same as the C function OGR_F_GetDefnRef().
|
inline |
Fetch feature definition.
This method is the same as the C function OGR_F_GetDefnRef().
|
inline |
Get feature identifier.
This method is the same as the C function OGR_F_GetFID(). Note: since GDAL 2.0, this method returns a GIntBig (previously a long)
GByte * OGRFeature::GetFieldAsBinary | ( | int | iField, |
int * | pnBytes | ||
) | const |
Fetch field value as binary data.
This method only works for OFTBinary and OFTString fields.
This method is the same as the C function OGR_F_GetFieldAsBinary().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
pnBytes | location to put the number of bytes returned. |
int OGRFeature::GetFieldAsDateTime | ( | int | iField, |
int * | pnYear, | ||
int * | pnMonth, | ||
int * | pnDay, | ||
int * | pnHour, | ||
int * | pnMinute, | ||
float * | pfSecond, | ||
int * | pnTZFlag | ||
) | const |
Fetch field value as date and time.
Currently this method only works for OFTDate, OFTTime and OFTDateTime fields.
This method is the same as the C function OGR_F_GetFieldAsDateTime().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
pnYear | (including century) |
pnMonth | (1-12) |
pnDay | (1-31) |
pnHour | (0-23) |
pnMinute | (0-59) |
pfSecond | (0-59 with millisecond accuracy) |
pnTZFlag | (0=unknown, 1=localtime, 100=GMT, see data model for details) |
int OGRFeature::GetFieldAsDateTime | ( | int | iField, |
int * | pnYear, | ||
int * | pnMonth, | ||
int * | pnDay, | ||
int * | pnHour, | ||
int * | pnMinute, | ||
int * | pnSecond, | ||
int * | pnTZFlag | ||
) | const |
Fetch field value as date and time.
Currently this method only works for OFTDate, OFTTime and OFTDateTime fields.
This method is the same as the C function OGR_F_GetFieldAsDateTime().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
pnYear | (including century) |
pnMonth | (1-12) |
pnDay | (1-31) |
pnHour | (0-23) |
pnMinute | (0-59) |
pnSecond | (0-59) |
pnTZFlag | (0=unknown, 1=localtime, 100=GMT, see data model for details) |
|
inline |
Fetch field value as a double.
OFTString features will be translated using CPLAtof(). OFTInteger and OFTInteger64 fields will be cast to double. Other field types, or errors will result in a return value of zero.
pszFName | the name of the field to fetch. |
double OGRFeature::GetFieldAsDouble | ( | int | iField | ) | const |
Fetch field value as a double.
OFTString features will be translated using CPLAtof(). OFTInteger and OFTInteger64 fields will be cast to double. Other field types, or errors will result in a return value of zero.
This method is the same as the C function OGR_F_GetFieldAsDouble().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
|
inline |
Fetch field value as a list of doubles.
Currently this method only works for OFTRealList fields.
pszFName | the name of the field to fetch. |
pnCount | an integer to put the list count (number of doubles) into. |
const double * OGRFeature::GetFieldAsDoubleList | ( | int | iField, |
int * | pnCount | ||
) | const |
Fetch field value as a list of doubles.
Currently this method only works for OFTRealList fields.
This method is the same as the C function OGR_F_GetFieldAsDoubleList().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
pnCount | an integer to put the list count (number of doubles) into. |
|
inline |
Fetch field value as integer.
OFTString features will be translated using atoi(). OFTReal fields will be cast to integer. OFTInteger64 are demoted to 32 bit, with clamping if out-of-range. Other field types, or errors will result in a return value of zero.
pszFName | the name of the field to fetch. |
int OGRFeature::GetFieldAsInteger | ( | int | iField | ) | const |
Fetch field value as integer.
OFTString features will be translated using atoi(). OFTReal fields will be cast to integer. OFTInteger64 are demoted to 32 bit, with clamping if out-of-range. Other field types, or errors will result in a return value of zero.
This method is the same as the C function OGR_F_GetFieldAsInteger().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
|
inline |
Fetch field value as integer 64 bit.
OFTInteger are promoted to 64 bit. OFTString features will be translated using CPLAtoGIntBig(). OFTReal fields will be cast to integer. Other field types, or errors will result in a return value of zero.
pszFName | the name of the field to fetch. |
GIntBig OGRFeature::GetFieldAsInteger64 | ( | int | iField | ) | const |
Fetch field value as integer 64 bit.
OFTInteger are promoted to 64 bit. OFTString features will be translated using CPLAtoGIntBig(). OFTReal fields will be cast to integer. Other field types, or errors will result in a return value of zero.
This method is the same as the C function OGR_F_GetFieldAsInteger64().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
|
inline |
Fetch field value as a list of 64 bit integers.
Currently this method only works for OFTInteger64List fields.
pszFName | the name of the field to fetch. |
pnCount | an integer to put the list count (number of integers) into. |
const GIntBig * OGRFeature::GetFieldAsInteger64List | ( | int | iField, |
int * | pnCount | ||
) | const |
Fetch field value as a list of 64 bit integers.
Currently this method only works for OFTInteger64List fields.
This method is the same as the C function OGR_F_GetFieldAsInteger64List().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
pnCount | an integer to put the list count (number of integers) into. |
|
inline |
Fetch field value as a list of integers.
Currently this method only works for OFTIntegerList fields.
pszFName | the name of the field to fetch. |
pnCount | an integer to put the list count (number of integers) into. |
const int * OGRFeature::GetFieldAsIntegerList | ( | int | iField, |
int * | pnCount | ||
) | const |
Fetch field value as a list of integers.
Currently this method only works for OFTIntegerList fields.
This method is the same as the C function OGR_F_GetFieldAsIntegerList().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
pnCount | an integer to put the list count (number of integers) into. |
|
inline |
Fetch OFTDateTime field value as a ISO8601 representation.
Return a string like "YYYY-MM-DDTHH:MM:SS(.sss)?(Z|([+|-]HH:MM))?" Milliseconds are omitted if equal to zero. Other field types, or errors will result in a return of an empty string.
pszFName | the name of the field to fetch. |
papszOptions | NULL terminated list of strings, or NULL. No options are defined currently. |
const char * OGRFeature::GetFieldAsISO8601DateTime | ( | int | iField, |
CSLConstList | papszOptions | ||
) | const |
Fetch OFTDateTime field value as a ISO8601 representation.
Return a string like "YYYY-MM-DDTHH:MM:SS(.sss)?(Z|([+|-]HH:MM))?" Milliseconds are omitted if equal to zero. Other field types, or errors will result in a return of an empty string.
This method is the same as the C function OGR_F_GetFieldAsISO8601DateTime().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
papszOptions | NULL terminated list of strings, or NULL. No options are defined currently. |
char * OGRFeature::GetFieldAsSerializedJSon | ( | int | iField | ) | const |
Fetch field value as a serialized JSon object.
Currently this method only works for OFTString with OFSTJSON subtype, OFTStringList, OFTIntegerList, OFTInteger64List and OFTRealList
iField | the field to fetch, from 0 to GetFieldCount()-1. |
|
inline |
Fetch field value as a string.
OFTReal, OFTInteger, OFTInteger64 fields will be translated to string using sprintf(), but not necessarily using the established formatting rules. OFTDateTime fields are formatted with "YYYY/MM/DD HH:MM:SS[.sss]+ZZ" (note this is not a ISO-8601 compliant string. Use GetFieldAsISO8601DateTime()) OFTDate fields are formatted as "YYYY/MM/DD" OFTTime fields are formatted as "HH:MM:SS[.sss]" OFTRealList, OFTIntegerList, OFTInteger64List, OFTStringList fields are formatted as "(number_of_values:val1,val2,...,valN)" OFTBinary fields are formatted as an hexadecimal representation. Other field types, or errors will result in a return of an empty string.
pszFName | the name of the field to fetch. |
const char * OGRFeature::GetFieldAsString | ( | int | iField | ) | const |
Fetch field value as a string.
OFTReal, OFTInteger, OFTInteger64 fields will be translated to string using sprintf(), but not necessarily using the established formatting rules. OFTDateTime fields are formatted with "YYYY/MM/DD HH:MM:SS[.sss]+ZZ" (note this is not a ISO-8601 compliant string. Use GetFieldAsISO8601DateTime()) OFTDate fields are formatted as "YYYY/MM/DD" OFTTime fields are formatted as "HH:MM:SS[.sss]" OFTRealList, OFTIntegerList, OFTInteger64List, OFTStringList fields are formatted as "(number_of_values:val1,val2,...,valN)" OFTBinary fields are formatted as an hexadecimal representation. Other field types, or errors will result in a return of an empty string.
This method is the same as the C function OGR_F_GetFieldAsString().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
|
inline |
Fetch field value as a list of strings.
Currently this method only works for OFTStringList fields.
The returned list is terminated by a NULL pointer. The number of elements can also be calculated using CSLCount().
pszFName | the name of the field to fetch. |
char ** OGRFeature::GetFieldAsStringList | ( | int | iField | ) | const |
Fetch field value as a list of strings.
Currently this method only works for OFTStringList fields.
The returned list is terminated by a NULL pointer. The number of elements can also be calculated using CSLCount().
This method is the same as the C function OGR_F_GetFieldAsStringList().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
|
inline |
Fetch number of fields on this feature.
This will always be the same as the field count for the OGRFeatureDefn.
This method is the same as the C function OGR_F_GetFieldCount().
|
inline |
Fetch definition for this field.
This method is the same as the C function OGR_F_GetFieldDefnRef().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
|
inline |
Fetch definition for this field.
This method is the same as the C function OGR_F_GetFieldDefnRef().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
|
inline |
Fetch the field index given field name.
This is a cover for the OGRFeatureDefn::GetFieldIndex() method.
This method is the same as the C function OGR_F_GetFieldIndex().
pszName | the name of the field to search for. |
OGRGeometry * OGRFeature::GetGeometryRef | ( | ) |
Fetch pointer to feature geometry.
This method is essentially the same as the C function OGR_F_GetGeometryRef(). (the only difference is that the C function honours OGRGetNonLinearGeometriesEnabledFlag())
Starting with GDAL 1.11, this is equivalent to calling OGRFeature::GetGeomFieldRef(0).
const OGRGeometry * OGRFeature::GetGeometryRef | ( | ) | const |
Fetch pointer to feature geometry.
This method is essentially the same as the C function OGR_F_GetGeometryRef(). (the only difference is that the C function honours OGRGetNonLinearGeometriesEnabledFlag())
|
inline |
Fetch number of geometry fields on this feature.
This will always be the same as the geometry field count for the OGRFeatureDefn.
This method is the same as the C function OGR_F_GetGeomFieldCount().
|
inline |
Fetch definition for this geometry field.
This method is the same as the C function OGR_F_GetGeomFieldDefnRef().
iGeomField | the field to fetch, from 0 to GetGeomFieldCount()-1. |
|
inline |
Fetch definition for this geometry field.
This method is the same as the C function OGR_F_GetGeomFieldDefnRef().
iGeomField | the field to fetch, from 0 to GetGeomFieldCount()-1. |
|
inline |
Fetch the geometry field index given geometry field name.
This is a cover for the OGRFeatureDefn::GetGeomFieldIndex() method.
This method is the same as the C function OGR_F_GetGeomFieldIndex().
pszName | the name of the geometry field to search for. |
OGRGeometry * OGRFeature::GetGeomFieldRef | ( | const char * | pszFName | ) |
Fetch pointer to feature geometry.
pszFName | name of geometry field to get. |
const OGRGeometry * OGRFeature::GetGeomFieldRef | ( | const char * | pszFName | ) | const |
Fetch pointer to feature geometry.
pszFName | name of geometry field to get. |
OGRGeometry * OGRFeature::GetGeomFieldRef | ( | int | iField | ) |
Fetch pointer to feature geometry.
This method is the same as the C function OGR_F_GetGeomFieldRef().
iField | geometry field to get. |
const OGRGeometry * OGRFeature::GetGeomFieldRef | ( | int | iField | ) | const |
Fetch pointer to feature geometry.
This method is the same as the C function OGR_F_GetGeomFieldRef().
iField | geometry field to get. |
|
inline |
Returns the native data for the feature.
The native data is the representation in a "natural" form that comes from the driver that created this feature, or that is aimed at an output driver. The native data may be in different format, which is indicated by GetNativeMediaType().
Note that most drivers do not support storing the native data in the feature object, and if they do, generally the NATIVE_DATA open option must be passed at dataset opening.
The "native data" does not imply it is something more performant or powerful than what can be obtained with the rest of the API, but it may be useful in round-tripping scenarios where some characteristics of the underlying format are not captured otherwise by the OGR abstraction.
This function is the same as the C function OGR_F_GetNativeData().
|
inline |
Returns the native media type for the feature.
The native media type is the identifier for the format of the native data. It follows the IANA RFC 2045 (see https://en.wikipedia.org/wiki/Media_type), e.g. "application/vnd.geo+json" for JSon.
This function is the same as the C function OGR_F_GetNativeMediaType().
|
inline |
Fetch a pointer to the internal field value given the index.
This method is the same as the C function OGR_F_GetRawFieldRef().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
|
inline |
Fetch a pointer to the internal field value given the index.
This method is the same as the C function OGR_F_GetRawFieldRef().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
|
virtual |
Fetch style string for this feature.
Set the OGR Feature Style Specification for details on the format of this string, and ogr_featurestyle.h for services available to parse it.
This method is the same as the C function OGR_F_GetStyleString().
|
inlinevirtual |
Return style table.
bool OGRFeature::IsFieldNull | ( | int | iField | ) | const |
Test if a field is null.
This method is the same as the C function OGR_F_IsFieldNull().
iField | the field to test. |
int OGRFeature::IsFieldSet | ( | int | iField | ) | const |
Test if a field has ever been assigned a value or not.
This method is the same as the C function OGR_F_IsFieldSet().
iField | the field to test. |
bool OGRFeature::IsFieldSetAndNotNull | ( | int | iField | ) | const |
Test if a field is set and not null.
This method is the same as the C function OGR_F_IsFieldSetAndNotNull().
iField | the field to test. |
OGRFeature::FieldValue OGRFeature::operator[] | ( | const char * | pszFieldName | ) |
Return a field value.
pszFieldName | field name |
const OGRFeature::FieldValue OGRFeature::operator[] | ( | const char * | pszFieldName | ) | const |
Return a field value.
pszFieldName | field name |
OGRFeature::FieldValue OGRFeature::operator[] | ( | int | iField | ) |
Return a field value.
iField | the field to fetch, from 0 to GetFieldCount()-1. This is not checked by the method ! |
const OGRFeature::FieldValue OGRFeature::operator[] | ( | int | iField | ) | const |
Return a field value.
iField | the field to fetch, from 0 to GetFieldCount()-1. This is not checked by the method ! |
void OGRFeature::Reset | ( | ) |
Reset the state of a OGRFeature to its state after construction.
This enables recycling existing OGRFeature instances.
bool OGRFeature::SerializeToBinary | ( | std::vector< GByte > & | abyBuffer | ) | const |
Serialize the feature to a binary encoding.
This saves the feature ID, attribute fields content and geometry fields content.
This method is aimed at being paired with DeserializeFromBinary().
The format of that encoding may vary across GDAL versions.
Note that abyBuffer is cleared at the beginning of this function.
Set the feature identifier.
For specific types of features this operation may fail on illegal features ids. Generally it always succeeds. Feature ids should be greater than or equal to zero, with the exception of OGRNullFID (-1) indicating that the feature id is unknown.
This method is the same as the C function OGR_F_SetFID().
nFIDIn | the new feature identifier value to assign. |
|
inline |
This method currently on has an effect of OFTStringList fields.
pszFName | the name of the field to set. |
papszValues | the values to assign. List of NUL-terminated string, ending with a NULL pointer. |
|
inline |
Set field to string value.
OFTInteger fields will be set based on an atoi() conversion of the string. OFTInteger64 fields will be set based on an CPLAtoGIntBig() conversion of the string. OFTReal fields will be set based on an CPLAtof() conversion of the string. Other field types may be unaffected.
pszFName | the name of the field to set. |
pszValue | the value to assign. |
|
inline |
Set field.
The passed value OGRField must be of exactly the same type as the target field, or an application crash may occur. The passed value is copied, and will not be affected. It remains the responsibility of the caller.
pszFName | the name of the field to set. |
puValue | the value to assign. |
|
inline |
Set field to double value.
OFTInteger, OFTInteger64 and OFTReal fields will be set directly. OFTString fields will be assigned a string representation of the value, but not necessarily taking into account formatting constraints on this field. Other field types may be unaffected.
pszFName | the name of the field to set. |
dfValue | the value to assign. |
|
inline |
Set field to 64 bit integer value.
OFTInteger, OFTInteger64 and OFTReal fields will be set directly. OFTString fields will be assigned a string representation of the value, but not necessarily taking into account formatting constraints on this field. Other field types may be unaffected.
pszFName | the name of the field to set. |
nValue | the value to assign. |
|
inline |
This method currently on has an effect of OFTIntegerList, OFTInteger64List, OFTRealList fields.
pszFName | the name of the field to set. |
nCount | the number of values in the list being assigned. |
padfValues | the values to assign. |
|
inline |
Set field to list of 64 bit integers value.
This method currently on has an effect of OFTIntegerList, OFTInteger64List and OFTRealList fields.
pszFName | the name of the field to set. |
nCount | the number of values in the list being assigned. |
panValues | the values to assign. |
|
inline |
This method currently on has an effect of OFTIntegerList, OFTInteger64List and OFTRealList fields.
pszFName | the name of the field to set. |
nCount | the number of values in the list being assigned. |
panValues | the values to assign. |
|
inline |
Set field to integer value.
OFTInteger, OFTInteger64 and OFTReal fields will be set directly. OFTString fields will be assigned a string representation of the value, but not necessarily taking into account formatting constraints on this field. Other field types may be unaffected.
pszFName | the name of the field to set. |
nValue | the value to assign. |
|
inline |
Set field to date.
This method currently only has an effect for OFTDate, OFTTime and OFTDateTime fields.
pszFName | the name of the field to set. |
nYear | (including century) |
nMonth | (1-12) |
nDay | (1-31) |
nHour | (0-23) |
nMinute | (0-59) |
fSecond | (0-59, with millisecond accuracy) |
nTZFlag | (0=unknown, 1=localtime, 100=GMT, see data model for details) |
void OGRFeature::SetField | ( | int | iField, |
const char *const * | papszValues | ||
) |
Set field to list of strings value.
This method currently on has an effect of OFTStringList fields.
This method is the same as the C function OGR_F_SetFieldStringList().
iField | the field to set, from 0 to GetFieldCount()-1. |
papszValues | the values to assign. List of NUL-terminated string, ending with a NULL pointer. |
void OGRFeature::SetField | ( | int | iField, |
const char * | pszValue | ||
) |
Set field to string value.
OFTInteger fields will be set based on an atoi() conversion of the string. OFTInteger64 fields will be set based on an CPLAtoGIntBig() conversion of the string. OFTReal fields will be set based on an CPLAtof() conversion of the string. Other field types may be unaffected.
This method is the same as the C function OGR_F_SetFieldString().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
pszValue | the value to assign. |
void OGRFeature::SetField | ( | int | iField, |
const OGRField * | puValue | ||
) |
Set field.
The passed value OGRField must be of exactly the same type as the target field, or an application crash may occur. The passed value is copied, and will not be affected. It remains the responsibility of the caller.
This method is the same as the C function OGR_F_SetFieldRaw().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
puValue | the value to assign. |
void OGRFeature::SetField | ( | int | iField, |
double | dfValue | ||
) |
Set field to double value.
OFTInteger, OFTInteger64 and OFTReal fields will be set directly. OFTString fields will be assigned a string representation of the value, but not necessarily taking into account formatting constraints on this field. Other field types may be unaffected.
This method is the same as the C function OGR_F_SetFieldDouble().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
dfValue | the value to assign. |
void OGRFeature::SetField | ( | int | iField, |
GIntBig | nValue | ||
) |
Set field to 64 bit integer value.
OFTInteger, OFTInteger64 and OFTReal fields will be set directly. OFTString fields will be assigned a string representation of the value, but not necessarily taking into account formatting constraints on this field. Other field types may be unaffected.
This method is the same as the C function OGR_F_SetFieldInteger64().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
nValue | the value to assign. |
void OGRFeature::SetField | ( | int | iField, |
int | nCount, | ||
const double * | padfValues | ||
) |
Set field to list of doubles value.
This method currently on has an effect of OFTIntegerList, OFTInteger64List, OFTRealList fields.
This method is the same as the C function OGR_F_SetFieldDoubleList().
iField | the field to set, from 0 to GetFieldCount()-1. |
nCount | the number of values in the list being assigned. |
padfValues | the values to assign. |
void OGRFeature::SetField | ( | int | iField, |
int | nCount, | ||
const GIntBig * | panValues | ||
) |
Set field to list of 64 bit integers value.
This method currently on has an effect of OFTIntegerList, OFTInteger64List and OFTRealList fields.
This method is the same as the C function OGR_F_SetFieldInteger64List().
iField | the field to set, from 0 to GetFieldCount()-1. |
nCount | the number of values in the list being assigned. |
panValues | the values to assign. |
void OGRFeature::SetField | ( | int | iField, |
int | nCount, | ||
const int * | panValues | ||
) |
Set field to list of integers value.
This method currently on has an effect of OFTIntegerList, OFTInteger64List and OFTRealList fields.
This method is the same as the C function OGR_F_SetFieldIntegerList().
iField | the field to set, from 0 to GetFieldCount()-1. |
nCount | the number of values in the list being assigned. |
panValues | the values to assign. |
void OGRFeature::SetField | ( | int | iField, |
int | nBytes, | ||
const void * | pabyData | ||
) |
Set field to binary data.
This method currently on has an effect of OFTBinary fields.
This method is the same as the C function OGR_F_SetFieldBinary().
iField | the field to set, from 0 to GetFieldCount()-1. |
nBytes | bytes of data being set. |
pabyData | the raw data being applied. |
void OGRFeature::SetField | ( | int | iField, |
int | nValue | ||
) |
Set field to integer value.
OFTInteger, OFTInteger64 and OFTReal fields will be set directly. OFTString fields will be assigned a string representation of the value, but not necessarily taking into account formatting constraints on this field. Other field types may be unaffected.
This method is the same as the C function OGR_F_SetFieldInteger().
iField | the field to fetch, from 0 to GetFieldCount()-1. |
nValue | the value to assign. |
void OGRFeature::SetField | ( | int | iField, |
int | nYear, | ||
int | nMonth, | ||
int | nDay, | ||
int | nHour = 0 , |
||
int | nMinute = 0 , |
||
float | fSecond = 0.f , |
||
int | nTZFlag = 0 |
||
) |
Set field to date.
This method currently only has an effect for OFTDate, OFTTime and OFTDateTime fields.
This method is the same as the C function OGR_F_SetFieldDateTime().
iField | the field to set, from 0 to GetFieldCount()-1. |
nYear | (including century) |
nMonth | (1-12) |
nDay | (1-31) |
nHour | (0-23) |
nMinute | (0-59) |
fSecond | (0-59, with millisecond accuracy) |
nTZFlag | (0=unknown, 1=localtime, 100=GMT, see data model for details) |
void OGRFeature::SetFieldNull | ( | int | iField | ) |
Clear a field, marking it as null.
This method is the same as the C function OGR_F_SetFieldNull().
iField | the field to set to null. |
OGRErr OGRFeature::SetFieldsFrom | ( | const OGRFeature * | poSrcFeature, |
const int * | panMap, | ||
int | bForgiving = TRUE , |
||
bool | bUseISO8601ForDateTimeAsString = false |
||
) |
Set fields from another feature.
Overwrite the fields of this feature from the attributes of another. The FID and the style string are not set. The poSrcFeature does not need to have the same OGRFeatureDefn. Field values are copied according to the provided indices map. Field types do not have to exactly match. SetField() method conversion rules will be applied as needed. This is more efficient than OGR_F_SetFrom() in that this doesn't lookup the fields by their names. Particularly useful when the field names don't match.
poSrcFeature | the feature from which geometry, and field values will be copied. |
panMap | Array of the indices of the feature's fields stored at the corresponding index of the source feature's fields. A value of -1 should be used to ignore the source's field. The array should not be NULL and be as long as the number of fields in the source feature. |
bForgiving | TRUE if the operation should continue despite lacking output fields matching some of the source fields. |
bUseISO8601ForDateTimeAsString | true if datetime fields converted to string should use ISO8601 formatting rather than OGR own format. |
OGRErr OGRFeature::SetFrom | ( | const OGRFeature * | poSrcFeature, |
const int * | panMap, | ||
int | bForgiving = TRUE , |
||
bool | bUseISO8601ForDateTimeAsString = false |
||
) |
Set one feature from another.
Overwrite the contents of this feature from the geometry and attributes of another. The poSrcFeature does not need to have the same OGRFeatureDefn. Field values are copied according to the provided indices map. Field types do not have to exactly match. SetField() method conversion rules will be applied as needed. This is more efficient than OGR_F_SetFrom() in that this doesn't lookup the fields by their names. Particularly useful when the field names don't match.
This method is the same as the C function OGR_F_SetFromWithMap().
poSrcFeature | the feature from which geometry, and field values will be copied. |
panMap | Array of the indices of the feature's fields stored at the corresponding index of the source feature's fields. A value of -1 should be used to ignore the source's field. The array should not be NULL and be as long as the number of fields in the source feature. |
bForgiving | TRUE if the operation should continue despite lacking output fields matching some of the source fields. |
bUseISO8601ForDateTimeAsString | true if datetime fields converted to string should use ISO8601 formatting rather than OGR own format. |
OGRErr OGRFeature::SetFrom | ( | const OGRFeature * | poSrcFeature, |
int | bForgiving = TRUE |
||
) |
Set one feature from another.
Overwrite the contents of this feature from the geometry and attributes of another. The poSrcFeature does not need to have the same OGRFeatureDefn. Field values are copied by corresponding field names. Field types do not have to exactly match. SetField() method conversion rules will be applied as needed.
This method is the same as the C function OGR_F_SetFrom().
poSrcFeature | the feature from which geometry, and field values will be copied. |
bForgiving | TRUE if the operation should continue despite lacking output fields matching some of the source fields. |
OGRErr OGRFeature::SetGeometry | ( | const OGRGeometry * | poGeomIn | ) |
Set feature geometry.
This method updates the features geometry, and operates the same as SetGeometryDirectly(), except that this method does not assume ownership of the passed geometry, but instead makes a copy of it.
This method is the same as the C function OGR_F_SetGeometry().
poGeomIn | new geometry to apply to feature. Passing NULL value here is correct and it will result in deallocation of currently assigned geometry without assigning new one. |
OGRErr OGRFeature::SetGeometry | ( | std::unique_ptr< OGRGeometry > | poGeomIn | ) |
Set feature geometry.
This method is the same as the C function OGR_F_SetGeometryDirectly().
poGeomIn | new geometry to apply to feature. Passing NULL value here is correct and it will result in deallocation of currently assigned geometry without assigning new one. |
OGRErr OGRFeature::SetGeometryDirectly | ( | OGRGeometry * | poGeomIn | ) |
Set feature geometry.
This method updates the features geometry, and operates the same as SetGeometry(), except that this method assumes ownership of the passed geometry (even in case of failure of that function).
This method is the same as the C function OGR_F_SetGeometryDirectly().
poGeomIn | new geometry to apply to feature. Passing NULL value here is correct and it will result in deallocation of currently assigned geometry without assigning new one. |
OGRErr OGRFeature::SetGeomField | ( | int | iField, |
const OGRGeometry * | poGeomIn | ||
) |
Set feature geometry of a specified geometry field.
This method updates the features geometry, and operates the same as SetGeomFieldDirectly(), except that this method does not assume ownership of the passed geometry, but instead makes a copy of it.
This method is the same as the C function OGR_F_SetGeomField().
iField | geometry field to set. |
poGeomIn | new geometry to apply to feature. Passing NULL value here is correct and it will result in deallocation of currently assigned geometry without assigning new one. |
OGRErr OGRFeature::SetGeomField | ( | int | iField, |
std::unique_ptr< OGRGeometry > | poGeomIn | ||
) |
Set feature geometry of a specified geometry field.
This method is the same as the C function OGR_F_SetGeomFieldDirectly().
iField | geometry field to set. |
poGeomIn | new geometry to apply to feature. Passing NULL value here is correct and it will result in deallocation of currently assigned geometry without assigning new one. |
OGRErr OGRFeature::SetGeomFieldDirectly | ( | int | iField, |
OGRGeometry * | poGeomIn | ||
) |
Set feature geometry of a specified geometry field.
This method updates the features geometry, and operates the same as SetGeomField(), except that this method assumes ownership of the passed geometry (even in case of failure of that function).
This method is the same as the C function OGR_F_SetGeomFieldDirectly().
iField | geometry field to set. |
poGeomIn | new geometry to apply to feature. Passing NULL value here is correct and it will result in deallocation of currently assigned geometry without assigning new one. |
void OGRFeature::SetNativeData | ( | const char * | pszNativeData | ) |
Sets the native data for the feature.
The native data is the representation in a "natural" form that comes from the driver that created this feature, or that is aimed at an output driver. The native data may be in different format, which is indicated by GetNativeMediaType().
This function is the same as the C function OGR_F_SetNativeData().
pszNativeData | a string with the native data, or NULL if there is none. |
void OGRFeature::SetNativeMediaType | ( | const char * | pszNativeMediaType | ) |
Sets the native media type for the feature.
The native media type is the identifier for the format of the native data. It follows the IANA RFC 2045 (see https://en.wikipedia.org/wiki/Media_type), e.g. "application/vnd.geo+json" for JSon.
This function is the same as the C function OGR_F_SetNativeMediaType().
pszNativeMediaType | a string with the native media type, or NULL if there is none. |
|
virtual |
Set feature style string.
This method operates the same as OGRFeature::SetStyleStringDirectly() except that it does not assume ownership of the passed string, but instead makes a copy of it.
This method is the same as the C function OGR_F_SetStyleString().
pszString | the style string to apply to this feature, cannot be NULL. |
|
virtual |
Set feature style string.
This method operates the same as OGRFeature::SetStyleString() except that it assumes ownership of the passed string.
This method is the same as the C function OGR_F_SetStyleStringDirectly().
pszString | the style string to apply to this feature, cannot be NULL. |
|
virtual |
Set style table.
poStyleTable | new style table (will be cloned) |
|
virtual |
Set style table.
poStyleTable | new style table (ownership transferred to the object) |
OGRGeometry * OGRFeature::StealGeometry | ( | ) |
Take away ownership of geometry.
Fetch the geometry from this feature, and clear the reference to the geometry on the feature. This is a mechanism for the application to take over ownership of the geometry from the feature without copying. Sort of an inverse to SetGeometryDirectly().
After this call the OGRFeature will have a NULL geometry.
OGRGeometry * OGRFeature::StealGeometry | ( | int | iGeomField | ) |
Take away ownership of geometry.
Fetch the geometry from this feature, and clear the reference to the geometry on the feature. This is a mechanism for the application to take over ownership of the geometry from the feature without copying. Sort of an inverse to SetGeometryDirectly().
After this call the OGRFeature will have a NULL geometry.
iGeomField | index of the geometry field. |
|
inlinestatic |
Convert a OGRFeature* to a OGRFeatureH.
void OGRFeature::UnsetField | ( | int | iField | ) |
Clear a field, marking it as unset.
This method is the same as the C function OGR_F_UnsetField().
iField | the field to unset. |
int OGRFeature::Validate | ( | int | nValidateFlags, |
int | bEmitError | ||
) | const |
Validate that a feature meets constraints of its schema.
The scope of test is specified with the nValidateFlags parameter.
Regarding OGR_F_VAL_WIDTH, the test is done assuming the string width must be interpreted as the number of UTF-8 characters. Some drivers might interpret the width as the number of bytes instead. So this test is rather conservative (if it fails, then it will fail for all interpretations).
This method is the same as the C function OGR_F_Validate().
nValidateFlags | OGR_F_VAL_ALL or combination of OGR_F_VAL_NULL, OGR_F_VAL_GEOM_TYPE, OGR_F_VAL_WIDTH and OGR_F_VAL_ALLOW_NULL_WHEN_DEFAULT, OGR_F_VAL_ALLOW_DIFFERENT_GEOM_DIM with '|' operator |
bEmitError | TRUE if a CPLError() must be emitted when a check fails |