Geo::OGR::GeomFieldDefn Class Reference
A definition of a spatial attribute.
More...
Inheritance diagram for Geo::OGR::GeomFieldDefn:
Collaboration diagram for Geo::OGR::GeomFieldDefn:
Public Member Functions | |
| public scalar | GeometryType (scalar type) |
| public method | GetSchema () |
| public scalar | Ignored (scalar ignore) |
| public scalar | Name (scalar name) |
| public scalar | Nullable (scalar nullable) |
| public hash reference | Schema (hash params) |
| public method | SetSchema () |
| public scalar | SpatialReference (scalar sr) |
| public method | Type () |
| public method | Types () |
| public Geo::OGR::GeomFieldDefn | new (hash params) |
| Create a new spatial field definition. More... | |
| Public Member Functions inherited from Geo::OGR | |
| public list | ByteOrders () |
| 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 () |
Detailed Description
Member Function Documentation
| public scalar Geo::OGR::GeomFieldDefn::GeometryType | ( | scalar | type | ) |
Object method.
- Note
- a.k.a. GetType, SetType
- Returns
- the geometry type of the field.
Code:
click to view
| public method Geo::OGR::GeomFieldDefn::GetSchema | ( | ) |
Code:
click to view
| public scalar Geo::OGR::GeomFieldDefn::Ignored | ( | scalar | ignore | ) |
Object method.
- Note
- a.k.a. IsIgnored, SetIgnored
- Returns
- the ignore status of the field.
Code:
click to view
| public scalar Geo::OGR::GeomFieldDefn::Name | ( | scalar | name | ) |
Object method.
- Note
- a.k.a. GetName, GetNameRef, SetName
- Returns
- the name of the field.
Code:
click to view
| public Geo::OGR::GeomFieldDefn Geo::OGR::GeomFieldDefn::new | ( | hash | params | ) |
Create a new spatial field definition.
Class method.
- Parameters
-
params one or more of:
- Name name for the field (default is 'geom').
- GeometryType type for the field type, one of Geo::OGR::GeomFieldDefn::Types (default is 'Unknown').
- SpatialReference a Geo::OSR::SpatialReference object.
- Nullable (default is true)
- Ignored (default is false)
- Note
- Simplified parameters <name> => <type> is also supported.
- Returns
- a new Geo::OGR::GeomFieldDefn object
Code:
click to view
| public scalar Geo::OGR::GeomFieldDefn::Nullable | ( | scalar | nullable | ) |
Object method.
- Note
- a.k.a. IsNullable, SetNullable
- Returns
- the nullable status of the field.
Code:
click to view
| public hash reference Geo::OGR::GeomFieldDefn::Schema | ( | hash | params | ) |
Object method.
Get the schema or set parts of the schema.
- Parameters
-
params [optional] as those in Geo::OGR::GeomFieldDefn::new.
- Returns
- a reference to a hash whose keys are as those in Geo::OGR::GeomFieldDefn::new.
Code:
click to view
| public method Geo::OGR::GeomFieldDefn::SetSchema | ( | ) |
Code:
click to view
| public scalar Geo::OGR::GeomFieldDefn::SpatialReference | ( | scalar | sr | ) |
Object method.
- Note
- a.k.a. GetSpatialRef, SetSpatialRef
- Returns
- the spatial reference of the field as a Geo::OSR::SpatialReference object.
Code:
click to view
| public method Geo::OGR::GeomFieldDefn::Type | ( | ) |
Object method.
- Returns
- the type of this geometry field. One of Geo::OGR::GeomFieldDefn::Types
Code:
click to view
| public method Geo::OGR::GeomFieldDefn::Types | ( | ) |
Package subroutine.
- Returns
- a list of all geometry types, currently:
CircularString, CircularStringM, CircularStringZ, CircularStringZM, CompoundCurve, CompoundCurveM, CompoundCurveZ, CompoundCurveZM, Curve, CurveM, CurvePolygon, CurvePolygonM, CurvePolygonZ, CurvePolygonZM, CurveZ, CurveZM, GeometryCollection, GeometryCollection25D, GeometryCollectionM, GeometryCollectionZM, LineString, LineString25D, LineStringM, LineStringZM, LinearRing, MultiCurve, MultiCurveM, MultiCurveZ, MultiCurveZM, MultiLineString, MultiLineString25D, MultiLineStringM, MultiLineStringZM, MultiPoint, MultiPoint25D, MultiPointM, MultiPointZM, MultiPolygon, MultiPolygon25D, MultiPolygonM, MultiPolygonZM, MultiSurface, MultiSurfaceM, MultiSurfaceZ, MultiSurfaceZM, None, Point, Point25D, PointM, PointZM, Polygon, Polygon25D, PolygonM, PolygonZM, PolyhedralSurface, PolyhedralSurfaceM, PolyhedralSurfaceZ, PolyhedralSurfaceZM, Surface, SurfaceM, SurfaceZ, SurfaceZM, TIN, TINM, TINZ, TINZM, Triangle, TriangleM, TriangleZ, TriangleZM, and Unknown.
Code:
click to view
The documentation for this class was generated from the following file:
- all.dox
