Geo::GDAL 1.8.0

Geo::OGR::FieldDefn Class Reference

Inheritance diagram for Geo::OGR::FieldDefn:
Inheritance graph
[legend]

List of all members.

Public Class Methods

Geo::OGR::FieldDefn new (scalar name="unnamed", scalar field_type=scalar Geo::OGR::OFTString)
Geo::OGR::FieldDefn create (scalar name="unnamed", scalar field_type= 'String')
Geo::OGR::FieldDefn create (hash parameters)

Public Object Methods

hashref Schema (hash parameters)
scalar Name (scalar name)
scalar Type (scalar type)
scalar Justify (scalar justify)
scalar Width (scalar width)
scalar Precision (scalar precision)
scalar GetName ()
scalar GetNameRef ()
 SetName (scalar name)
scalar GetPrecision ()
 SetPrecision (scalar precision)
scalar GetWidth ()
 SetWidth (scalar width)
scalar GetFieldTypeName ()
scalar GetType ()
 SetType (scalar type)
scalar GetJustify ()
 SetJustify (scalar justify)

Member Function Documentation

Geo::OGR::FieldDefn Geo::OGR::FieldDefn::create ( scalar  name = "unnamed",
scalar  field_type = 'String' 
)
Parameters:
name
field_typeone of field types. Optional. Default is String.

Usage:

$fd = Geo::OGR::FieldDefn->create(...arguments...);
Returns:
a new Geo::OGR::FieldDefn object
Geo::OGR::FieldDefn Geo::OGR::FieldDefn::create ( hash  parameters)
Parameters:
parametersnamed parameters: Name, Type, Justify, Width, Precision

Usage:

$fd = Geo::OGR::FieldDefn->create( Name => "name", Type => "FieldType", ...);
Returns:
a new Geo::OGR::FieldDefn object
scalar Geo::OGR::FieldDefn::GetFieldTypeName ( )
Deprecated:
use string type names
scalar Geo::OGR::FieldDefn::GetJustify ( )
Deprecated:
use Geo::OGR::FieldDefn::Justify, which returns a string
Returns:
justify as an integer
scalar Geo::OGR::FieldDefn::GetName ( )
Returns:
scalar Geo::OGR::FieldDefn::GetNameRef ( )

Same as GetName.

Returns:
scalar Geo::OGR::FieldDefn::GetPrecision ( )
Returns:
scalar Geo::OGR::FieldDefn::GetType ( )
Deprecated:
use Geo::OGR::FieldDefn::Type, which returns a string
Returns:
type as integer
scalar Geo::OGR::FieldDefn::GetWidth ( )

return

scalar Geo::OGR::FieldDefn::Justify ( scalar  justify)

Get and/or set the justification

Parameters:
justify[optional] as string: Undefined, Left, or Right
Returns:
one of Undefined Left Right in non-void context
scalar Geo::OGR::FieldDefn::Name ( scalar  name)

Get and/or set the name

Parameters:
name[optional]
Returns:
the name in non-void context
Geo::OGR::FieldDefn Geo::OGR::FieldDefn::new ( scalar  name = "unnamed",
scalar  field_type = scalar Geo::OGR::OFTString 
)
Deprecated:
use Geo::OGR::FieldDefn::create, which accepts type as a string
Parameters:
name
field_typeas integer
Returns:
a new Geo::OGR::FieldDefn object
scalar Geo::OGR::FieldDefn::Precision ( scalar  precision)

Get and/or set the precision

Parameters:
precision[optional]
Returns:
integer in non-void context
hashref Geo::OGR::FieldDefn::Schema ( hash  parameters)

Get the schema or set parts of the schema

Parameters:
parameters[optional] named parameters: Name, Type, Justify, Width, Precision
Returns:
a reference to a hash whose keys are Name, Type, Justify, Width, and Precision
Geo::OGR::FieldDefn::SetJustify ( scalar  justify)
Deprecated:
use Geo::OGR::FieldDefn::Justify, which accepts a string
Parameters:
justifyas an integer
Geo::OGR::FieldDefn::SetName ( scalar  name)
Parameters:
name
Geo::OGR::FieldDefn::SetPrecision ( scalar  precision)
Parameters:
precision
Geo::OGR::FieldDefn::SetType ( scalar  type)
Deprecated:
use Geo::OGR::FieldDefn::Type, which accepts a string
Parameters:
type
Geo::OGR::FieldDefn::SetWidth ( scalar  width)
Parameters:
width
scalar Geo::OGR::FieldDefn::Type ( scalar  type)
Parameters:
type[optional] one of field types: Integer, IntegerList, Real, RealList, String, StringList, WideString, WideStringList, Binary, Date, Time, or DateTime (wide strings are not really supported yet)
Returns:
one of field types in non-void context
scalar Geo::OGR::FieldDefn::Width ( scalar  width)

Get and/or set the field width

Parameters:
width[optional]
Returns:
integer in non-void context

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