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 method	CreateGlobFieldDomain ()
public method	CreateRangeFieldDomain ()
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 method	OFDMP_DEFAULT_VALUE ()
public method	OFDMP_GEOMETRY_WEIGHTED ()
public method	OFDMP_SUM ()
public method	OFDSP_DEFAULT_VALUE ()
public method	OFDSP_DUPLICATE ()
public method	OFDSP_GEOMETRY_RATIO ()
public method	OFDT_CODED ()
public method	OFDT_GLOB ()
public method	OFDT_RANGE ()
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 12016 of file all.pm.

Member Function Documentation

ACQUIRE()

public method Geo::OGR::FeatureDefn::ACQUIRE

(

)

Undocumented Method

Code:

AddField() [1/2]

public method Geo::OGR::FeatureDefn::AddField

(

)

Undocumented Method

Code:

AddField() [2/2]

public method Geo::OGR::FeatureDefn::AddField

(

hash

params

)

Object method.

Parameters

params

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

Code:

DeleteField() [1/2]

public method Geo::OGR::FeatureDefn::DeleteField

(

)

Undocumented Method

Code:

DeleteField() [2/2]

public method Geo::OGR::FeatureDefn::DeleteField

(

scalar

name

)

Object method.

Note

Currently only geometry fields can be deleted.

Parameters

index

the index of the geometry field to be deleted.

Code:

DESTROY()

public method Geo::OGR::FeatureDefn::DESTROY

(

)

Undocumented Method

Code:

DISOWN()

public method Geo::OGR::FeatureDefn::DISOWN

(

)

Undocumented Method

Code:

Feature()

public method Geo::OGR::FeatureDefn::Feature

(

)

Code:

Undocumented Method

Code:

GeometryIgnored()

public method Geo::OGR::FeatureDefn::GeometryIgnored

(

)

Undocumented Method

Code:

GeomType()

public method Geo::OGR::FeatureDefn::GeomType

(

)

Undocumented Method

Code:

GetFieldDefn() [1/2]

public method Geo::OGR::FeatureDefn::GetFieldDefn

(

)

Undocumented Method

Code:

GetFieldDefn() [2/2]

public scalar Geo::OGR::FeatureDefn::GetFieldDefn

(

scalar

name

)

Object method.
Get the definition of a field.

Parameters

name	the name of the field.

Returns

a Geo::OGR::FieldDefn object.

Code:

GetFieldIndex()

public method Geo::OGR::FeatureDefn::GetFieldIndex

(

)

Undocumented Method

Code:

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:

Undocumented Method

Code:

GetGeomFieldDefn() [1/2]

public method Geo::OGR::FeatureDefn::GetGeomFieldDefn

(

)

Undocumented Method

Code:

GetGeomFieldDefn() [2/2]

public scalar Geo::OGR::FeatureDefn::GetGeomFieldDefn

(

scalar

name

)

Object method.
Get the definition of a spatial field.

Parameters

name	the name of the spatial field.

Returns

a Geo::OGR::GeomFieldDefn object.

Code:

GetGeomFieldIndex()

public method Geo::OGR::FeatureDefn::GetGeomFieldIndex

(

)

Undocumented Method

Code:

GetName()

public scalar Geo::OGR::FeatureDefn::GetName

(

)

Object method.

Returns

the name of this layer or feature definition.

Code:

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:

Undocumented Method

Code:

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:

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:

new() [1/2]

public method Geo::OGR::FeatureDefn::new

(

)

Undocumented Method

Code:

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>$fd = Geo::OGR::FeatureDefn->new(
<br>    Name => "name",
<br>    Fields => [{ Name => 'field1', Type => 'String' },
<br>               { Name => 'geom', GeometryType => 'Point' }] );
<br>

Code:

RELEASE_PARENT()

public method Geo::OGR::FeatureDefn::RELEASE_PARENT

(

)

Undocumented Method

Code:

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:

StyleIgnored()

public method Geo::OGR::FeatureDefn::StyleIgnored

(

)

Undocumented Method

Code:

---

The documentation for this class was generated from the following files:

• all.pm
• OGR.pm