Geo::GDAL  2.4
Geo::OGR::FeatureDefn Class Reference

The schema of a feature or a layer.
More...

+ Inheritance diagram for Geo::OGR::FeatureDefn:
+ Collaboration diagram for Geo::OGR::FeatureDefn:

Public Member Functions

public method AddField (hash params)
 
public method DeleteField (scalar name)
 
public method Feature ()
 
public scalar GetFieldDefn (scalar name)
 
public list GetFieldNames ()
 
public scalar GetGeomFieldDefn (scalar name)
 
public scalar GetName ()
 
public hash reference GetSchema ()
 Get the schema of this feature or layer definition.

More...
 
public method IsSame (Geo::OGR::FeatureDefn defn)
 
public scalar IsStyleIgnored ()
 
public method SetStyleIgnored (scalar IgnoreState)
 
public Geo::OGR::FeatureDefn new (hash schema)
 
public method DESTROY ()
 
public method new ()
 
public method DISOWN ()
 
public method ACQUIRE ()
 
public method RELEASE_PARENT ()
 
public method Feature ()
 
public method GetFieldIndex ()
 
public method GetGeomFieldIndex ()
 
public method GetSchema ()
 
public method AddField ()
 
public method DeleteField ()
 
public method GetFieldNames ()
 
public method GetFieldDefn ()
 
public method GetGeomFieldDefn ()
 
public method GeomType ()
 
public method GeometryIgnored ()
 
public method StyleIgnored ()
 
- Public Member Functions inherited from Geo::OGR
public list ByteOrders ()
 
public method CreateGeometryFromEsriJson ()
 
public Geo::GDAL::Driver Driver (scalar name)
 
public list DriverNames ()
 
public list Drivers ()
 
public method Flatten ()
 
public scalar GeometryTypeModify (scalar type, scalar modifier)
 
public scalar GeometryTypeTest (scalar type, scalar test, scalar type2)
 
public list GeometryTypes ()
 
public method GetNonLinearGeometriesEnabledFlag ()
 
public method GetOpenDSCount ()
 
public method HasM ()
 
public method HasZ ()
 
public Geo::GDAL::Dataset Open (scalar name, scalar update=0)
 
public Geo::GDAL::Dataset OpenShared (scalar name, scalar update=0)
 
public method SetGenerate_DB2_V72_BYTE_ORDER (scalar Generate_DB2_V72_BYTE_ORDER)
 
public method SetNonLinearGeometriesEnabledFlag ()
 
public method TIEHASH ()
 
public method CLEAR ()
 
public method FIRSTKEY ()
 
public method NEXTKEY ()
 
public method FETCH ()
 
public method STORE ()
 
public method this ()
 
public method Driver ()
 
public method GetDriverNames ()
 
public method Drivers ()
 
public method Open ()
 
public method OpenShared ()
 
public method GeometryType ()
 
public method GeometryTypeModify ()
 
public method GeometryTypeTest ()
 
public method RELEASE_PARENT ()
 

Detailed Description

The schema of a feature or a layer.

A FeatureDefn object is a collection of field definition objects. A
read-only FeatureDefn object can be obtained from a layer
(Geo::OGR::Layer::GetDefn()) or a feature
(Geo::OGR::Feature::GetDefn()).

Definition at line 11509 of file all.pm.

Member Function Documentation

◆ ACQUIRE()

public method Geo::OGR::FeatureDefn::ACQUIRE ( )

Undocumented Method

Code:
click to view

◆ AddField() [1/2]

public method Geo::OGR::FeatureDefn::AddField ( )

Undocumented Method

Code:
click to view

◆ AddField() [2/2]

public method Geo::OGR::FeatureDefn::AddField ( hash  params)

Object method.

Parameters
paramsNamed parameters to create a new Geo::OGR::FieldDefn
or Geo::OGR::GeomFieldDefn object.

Code:
click to view

◆ DeleteField() [1/2]

public method Geo::OGR::FeatureDefn::DeleteField ( )

Undocumented Method

Code:
click to view

◆ DeleteField() [2/2]

public method Geo::OGR::FeatureDefn::DeleteField ( scalar  name)

Object method.

Note
Currently only geometry fields can be deleted.
Parameters
indexthe index of the geometry field to be deleted.

Code:
click to view

◆ DESTROY()

public method Geo::OGR::FeatureDefn::DESTROY ( )

Undocumented Method

Code:
click to view

◆ DISOWN()

public method Geo::OGR::FeatureDefn::DISOWN ( )

Undocumented Method

Code:
click to view

◆ Feature()

public method Geo::OGR::FeatureDefn::Feature ( )


Code:
click to view

Undocumented Method

Code:
click to view

◆ GeometryIgnored()

public method Geo::OGR::FeatureDefn::GeometryIgnored ( )

Undocumented Method

Code:
click to view

◆ GeomType()

public method Geo::OGR::FeatureDefn::GeomType ( )

Undocumented Method

Code:
click to view

◆ GetFieldDefn() [1/2]

public method Geo::OGR::FeatureDefn::GetFieldDefn ( )

Undocumented Method

Code:
click to view

◆ GetFieldDefn() [2/2]

public scalar Geo::OGR::FeatureDefn::GetFieldDefn ( scalar  name)

Object method.
Get the definition of a field.

Parameters
namethe name of the field.
Returns
a Geo::OGR::FieldDefn object.

Code:
click to view

◆ GetFieldIndex()

public method Geo::OGR::FeatureDefn::GetFieldIndex ( )

Undocumented Method

Code:
click to view

◆ GetFieldNames()

public method Geo::OGR::FeatureDefn::GetFieldNames ( )

Object method.
The names of the fields in this layer or feature definition.

Returns
the list of field names.

Code:
click to view

Undocumented Method

Code:
click to view

◆ GetGeomFieldDefn() [1/2]

public method Geo::OGR::FeatureDefn::GetGeomFieldDefn ( )

Undocumented Method

Code:
click to view

◆ GetGeomFieldDefn() [2/2]

public scalar Geo::OGR::FeatureDefn::GetGeomFieldDefn ( scalar  name)

Object method.
Get the definition of a spatial field.

Parameters
namethe name of the spatial field.
Returns
a Geo::OGR::GeomFieldDefn object.

Code:
click to view

◆ GetGeomFieldIndex()

public method Geo::OGR::FeatureDefn::GetGeomFieldIndex ( )

Undocumented Method

Code:
click to view

◆ GetName()

public scalar Geo::OGR::FeatureDefn::GetName ( )

Object method.

Returns
the name of this layer or feature definition.

Code:
click to view

◆ GetSchema()

public method Geo::OGR::FeatureDefn::GetSchema ( )

Get the schema of this feature or layer definition.

Object method.

Returns
the schema as a hash whose keywords are Name, StyleIgnored
and Fields. Fields is an anonymous array of first non-spatial and
then spatial field schemas as in Geo::OGR::FieldDefn::Schema() and
Geo::OGR::GeomFieldDefn::Schema().

Code:
click to view

Undocumented Method

Code:
click to view

◆ IsSame()

public method Geo::OGR::FeatureDefn::IsSame ( Geo::OGR::FeatureDefn  defn)

Object method.

Returns
true if this definition is similar to the other definition,
false otherwise.

Code:
click to view

◆ IsStyleIgnored()

public scalar Geo::OGR::FeatureDefn::IsStyleIgnored ( )

Object method.
Get the ignore status of style information when fetching features.

Returns
the ignore status of style information
Since
1.9.0

Code:
click to view

◆ new() [1/2]

public method Geo::OGR::FeatureDefn::new ( )

Undocumented Method

Code:
click to view

◆ new() [2/2]

public Geo::OGR::FeatureDefn Geo::OGR::FeatureDefn::new ( hash  schema)

Class method.
Creates a new layer or feature definition. The new definition is
either initialized to the given schema or it will contain no
non-spatial fields and one spatial field, whose Name is '' and
GeometryType is 'Unknown' or the value of the named parameter
GeometryType.

Parameters
schema[optional] The schema for the new feature definition,
as in Geo::OGR::FeatureDefn::Schema().
Returns
a Geo::OGR::FeatureDefn object

Example usage:
<br> Name => "name",
<br> Fields => [{ Name => 'field1', Type => 'String' },
<br> { Name => 'geom', GeometryType => 'Point' }] );
<br>


Code:
click to view

◆ RELEASE_PARENT()

public method Geo::OGR::FeatureDefn::RELEASE_PARENT ( )

Undocumented Method

Code:
click to view

◆ SetStyleIgnored()

public method Geo::OGR::FeatureDefn::SetStyleIgnored ( scalar  IgnoreState)

Object method.
Set the ignore status of style information when fetching features.

Since
1.9.0

Code:
click to view

◆ StyleIgnored()

public method Geo::OGR::FeatureDefn::StyleIgnored ( )

Undocumented Method

Code:
click to view


The documentation for this class was generated from the following files:
Geo::OGR::FeatureDefn::ACQUIRE
public method ACQUIRE()
Geo::OGR::FeatureDefn::GeometryIgnored
public method GeometryIgnored()
Geo::OGR::FeatureDefn::RELEASE_PARENT
public method RELEASE_PARENT()
Geo::OGR::GeomFieldDefn::new
public Geo::OGR::GeomFieldDefn new(hash params)
Create a new spatial field definition.
Geo::OGR::FeatureDefn::IsStyleIgnored
public scalar IsStyleIgnored()
Geo::OGR::FeatureDefn::GetSchema
public hash reference GetSchema()
Get the schema of this feature or layer definition.
Geo::OGR::FeatureDefn
The schema of a feature or a layer.
Definition: all.pm:11510
Geo::OGR::FieldDefn::new
public Geo::OGR::FieldDefn new(hash params)
Create a new field definition.
Geo::OGR::FeatureDefn::new
public Geo::OGR::FeatureDefn new(hash schema)
Geo::OGR::FeatureDefn::GetGeomFieldIndex
public method GetGeomFieldIndex()
Geo::OGR::FeatureDefn::DISOWN
public method DISOWN()
Geo::OGR::FeatureDefn::GetGeomFieldDefn
public method GetGeomFieldDefn()
Geo::OGR::FeatureDefn::GetName
public scalar GetName()
Geo::OGR::FieldDefn
A definition of a non-spatial attribute.
Definition: all.pm:11920
Geo::OGR::FeatureDefn::GetFieldNames
public list GetFieldNames()
Geo::OGR::FeatureDefn::SetStyleIgnored
public method SetStyleIgnored(scalar IgnoreState)
Geo::OGR::FeatureDefn::DeleteField
public method DeleteField()
Geo::OGR::FeatureDefn::GeomType
public method GeomType()
Geo::OGR::FeatureDefn::AddField
public method AddField()
Geo::OGR::FeatureDefn::DESTROY
public method DESTROY()
Geo::OGR::FeatureDefn::Feature
public method Feature()
Geo::OGR::GeometryType
public method GeometryType()
Geo::OGR::FeatureDefn::GetFieldDefn
public method GetFieldDefn()
Geo::OGR::FeatureDefn::GetFieldIndex
public method GetFieldIndex()
Geo::OGR::GeomFieldDefn
A definition of a spatial attribute.
Definition: all.pm:12408
Geo::OGR::FeatureDefn::StyleIgnored
public method StyleIgnored()
Geo::OGR::FeatureDefn::IsSame
public method IsSame(Geo::OGR::FeatureDefn defn)