EVOLUTION-MANAGER

Edit File: ogr_fielddef_docs.i

%extend OGRFieldDefnShadow { // File: ogrfielddefn_8cpp.xml %feature("docstring") CPL_CVSID "CPL_CVSID(\"$Id: ogrfielddefn.cpp 31961 2015-12-03 02:01:09Z goatbar $\") "; %feature("docstring") Create "OGRFieldDefnH OGR_Fld_Create(const char *pszName, OGRFieldType eType) Create a new field definition. By default, fields have no width, precision, are nullable and not ignored. This function is the same as the CPP method OGRFieldDefn::OGRFieldDefn(). Parameters: ----------- pszName: the name of the new field definition. eType: the type of the new field definition. handle to the new field definition. "; %feature("docstring") Destroy "void OGR_Fld_Destroy(OGRFieldDefnH hDefn) Destroy a field definition. Parameters: ----------- hDefn: handle to the field definition to destroy. "; %feature("docstring") SetName "void OGR_Fld_SetName(OGRFieldDefnH hDefn, const char *pszName) Reset the name of this field. This function is the same as the CPP method OGRFieldDefn::SetName(). Parameters: ----------- hDefn: handle to the field definition to apply the new name to. pszName: the new name to apply. "; %feature("docstring") GetNameRef "const char* OGR_Fld_GetNameRef(OGRFieldDefnH hDefn) Fetch name of this field. This function is the same as the CPP method OGRFieldDefn::GetNameRef(). Parameters: ----------- hDefn: handle to the field definition. the name of the field definition. "; %feature("docstring") GetType "OGRFieldType OGR_Fld_GetType(OGRFieldDefnH hDefn) Fetch type of this field. This function is the same as the CPP method OGRFieldDefn::GetType(). Parameters: ----------- hDefn: handle to the field definition to get type from. field type. "; %feature("docstring") SetType "void OGR_Fld_SetType(OGRFieldDefnH hDefn, OGRFieldType eType) Set the type of this field. This should never be done to an OGRFieldDefn that is already part of an OGRFeatureDefn. This function is the same as the CPP method OGRFieldDefn::SetType(). Parameters: ----------- hDefn: handle to the field definition to set type to. eType: the new field type. "; %feature("docstring") GetSubType "OGRFieldSubType OGR_Fld_GetSubType(OGRFieldDefnH hDefn) Fetch subtype of this field. This function is the same as the CPP method OGRFieldDefn::GetSubType(). Parameters: ----------- hDefn: handle to the field definition to get subtype from. field subtype. GDAL 2.0 "; %feature("docstring") SetSubType "void OGR_Fld_SetSubType(OGRFieldDefnH hDefn, OGRFieldSubType eSubType) Set the subtype of this field. This should never be done to an OGRFieldDefn that is already part of an OGRFeatureDefn. This function is the same as the CPP method OGRFieldDefn::SetSubType(). Parameters: ----------- hDefn: handle to the field definition to set type to. eSubType: the new field subtype. GDAL 2.0 "; %feature("docstring") SetDefault "void OGR_Fld_SetDefault(OGRFieldDefnH hDefn, const char *pszDefault) Set default field value. The default field value is taken into account by drivers (generally those with a SQL interface) that support it at field creation time. OGR will generally not automatically set the default field value to null fields by itself when calling OGRFeature::CreateFeature() / OGRFeature::SetFeature(), but will let the low-level layers to do the job. So retrieving the feature from the layer is recommended. The accepted values are NULL, a numeric value, a literal value enclosed between single quote characters (and inner single quote characters escaped by repetition of the single quote character), CURRENT_TIMESTAMP, CURRENT_TIME, CURRENT_DATE or a driver specific expression (that might be ignored by other drivers). For a datetime literal value, format should be 'YYYY/MM/DD HH:MM:SS[.sss]' (considered as UTC time). Drivers that support writing DEFAULT clauses will advertize the GDAL_DCAP_DEFAULT_FIELDS driver metadata item. This function is the same as the C++ method OGRFieldDefn::SetDefault(). Parameters: ----------- hDefn: handle to the field definition. pszDefault: new default field value or NULL pointer. GDAL 2.0 "; %feature("docstring") GetDefault "const char* OGR_Fld_GetDefault(OGRFieldDefnH hDefn) Get default field value. This function is the same as the C++ method OGRFieldDefn::GetDefault(). Parameters: ----------- hDefn: handle to the field definition. default field value or NULL. GDAL 2.0 "; %feature("docstring") IsDefaultDriverSpecific "int OGR_Fld_IsDefaultDriverSpecific(OGRFieldDefnH hDefn) Returns whether the default value is driver specific. Driver specific default values are those that are *not* NULL, a numeric value, a literal value enclosed between single quote characters, CURRENT_TIMESTAMP, CURRENT_TIME, CURRENT_DATE or datetime literal value. This function is the same as the C++ method OGRFieldDefn::IsDefaultDriverSpecific(). Parameters: ----------- hDefn: handle to the field definition TRUE if the default value is driver specific. GDAL 2.0 "; %feature("docstring") OGR_GetFieldTypeName "const char* OGR_GetFieldTypeName(OGRFieldType eType) Fetch human readable name for a field type. This function is the same as the CPP method OGRFieldDefn::GetFieldTypeName(). Parameters: ----------- eType: the field type to get name for. the name. "; %feature("docstring") OGR_GetFieldSubTypeName "const char* OGR_GetFieldSubTypeName(OGRFieldSubType eSubType) Fetch human readable name for a field subtype. This function is the same as the CPP method OGRFieldDefn::GetFieldSubTypeName(). Parameters: ----------- eSubType: the field subtype to get name for. the name. GDAL 2.0 "; %feature("docstring") OGR_AreTypeSubTypeCompatible "int OGR_AreTypeSubTypeCompatible(OGRFieldType eType, OGRFieldSubType eSubType) Return if type and subtype are compatible. Parameters: ----------- eType: the field type. eSubType: the field subtype. TRUE if type and subtype are compatible GDAL 2.0 "; %feature("docstring") GetJustify "OGRJustification OGR_Fld_GetJustify(OGRFieldDefnH hDefn) Get the justification for this field. This function is the same as the CPP method OGRFieldDefn::GetJustify(). Note: no driver is know to use the concept of field justification. Parameters: ----------- hDefn: handle to the field definition to get justification from. the justification. "; %feature("docstring") SetJustify "void OGR_Fld_SetJustify(OGRFieldDefnH hDefn, OGRJustification eJustify) Set the justification for this field. Note: no driver is know to use the concept of field justification. This function is the same as the CPP method OGRFieldDefn::SetJustify(). Parameters: ----------- hDefn: handle to the field definition to set justification to. eJustify: the new justification. "; %feature("docstring") GetWidth "int OGR_Fld_GetWidth(OGRFieldDefnH hDefn) Get the formatting width for this field. This function is the same as the CPP method OGRFieldDefn::GetWidth(). Parameters: ----------- hDefn: handle to the field definition to get width from. the width, zero means no specified width. "; %feature("docstring") SetWidth "void OGR_Fld_SetWidth(OGRFieldDefnH hDefn, int nNewWidth) Set the formatting width for this field in characters. This function is the same as the CPP method OGRFieldDefn::SetWidth(). Parameters: ----------- hDefn: handle to the field definition to set width to. nNewWidth: the new width. "; %feature("docstring") GetPrecision "int OGR_Fld_GetPrecision(OGRFieldDefnH hDefn) Get the formatting precision for this field. This should normally be zero for fields of types other than OFTReal. This function is the same as the CPP method OGRFieldDefn::GetPrecision(). Parameters: ----------- hDefn: handle to the field definition to get precision from. the precision. "; %feature("docstring") SetPrecision "void OGR_Fld_SetPrecision(OGRFieldDefnH hDefn, int nPrecision) Set the formatting precision for this field in characters. This should normally be zero for fields of types other than OFTReal. This function is the same as the CPP method OGRFieldDefn::SetPrecision(). Parameters: ----------- hDefn: handle to the field definition to set precision to. nPrecision: the new precision. "; %feature("docstring") Set "void OGR_Fld_Set(OGRFieldDefnH hDefn, const char *pszNameIn, OGRFieldType eTypeIn, int nWidthIn, int nPrecisionIn, OGRJustification eJustifyIn) Set defining parameters for a field in one call. This function is the same as the CPP method OGRFieldDefn::Set(). Parameters: ----------- hDefn: handle to the field definition to set to. pszNameIn: the new name to assign. eTypeIn: the new type (one of the OFT values like OFTInteger). nWidthIn: the preferred formatting width. Defaults to zero indicating undefined. nPrecisionIn: number of decimals places for formatting, defaults to zero indicating undefined. eJustifyIn: the formatting justification (OJLeft or OJRight), defaults to OJUndefined. "; %feature("docstring") IsIgnored "int OGR_Fld_IsIgnored(OGRFieldDefnH hDefn) Return whether this field should be omitted when fetching features. This method is the same as the C++ method OGRFieldDefn::IsIgnored(). Parameters: ----------- hDefn: handle to the field definition ignore state "; %feature("docstring") SetIgnored "void OGR_Fld_SetIgnored(OGRFieldDefnH hDefn, int ignore) Set whether this field should be omitted when fetching features. This method is the same as the C++ method OGRFieldDefn::SetIgnored(). Parameters: ----------- hDefn: handle to the field definition ignore: ignore state "; %feature("docstring") IsNullable "int OGR_Fld_IsNullable(OGRFieldDefnH hDefn) Return whether this field can receive null values. By default, fields are nullable. Even if this method returns FALSE (i.e not-nullable field), it doesn't mean that OGRFeature::IsFieldSet() will necessary return TRUE, as fields can be temporary unset and null/not-null validation is usually done when OGRLayer::CreateFeature()/SetFeature() is called. This method is the same as the C++ method OGRFieldDefn::IsNullable(). Parameters: ----------- hDefn: handle to the field definition TRUE if the field is authorized to be null. GDAL 2.0 "; %feature("docstring") SetNullable "void OGR_Fld_SetNullable(OGRFieldDefnH hDefn, int bNullableIn) Set whether this field can receive null values. By default, fields are nullable, so this method is generally called with FALSE to set a not-null constraint. Drivers that support writing not-null constraint will advertize the GDAL_DCAP_NOTNULL_FIELDS driver metadata item. This method is the same as the C++ method OGRFieldDefn::SetNullable(). Parameters: ----------- hDefn: handle to the field definition bNullableIn: FALSE if the field must have a not-null constraint. GDAL 2.0 "; %feature("docstring") OGRUpdateFieldType "void OGRUpdateFieldType(OGRFieldDefn *poFDefn, OGRFieldType eNewType, OGRFieldSubType eNewSubType) Update the type of a field definition by \"merging\" its existing type with a new type. The update is done such as broadening the type. For example a OFTInteger updated with OFTInteger64 will be promoted to OFTInteger64. Parameters: ----------- poFDefn: the field definition whose type must be updated. eNewType: the new field type to merge into the existing type. eNewSubType: the new field subtype to merge into the existing subtype. GDAL 2.1 "; }