Geo::GDAL::Driver Class Reference

Inherits Geo::GDAL::MajorObject, and Geo::GDAL.

Inheritance diagram for Geo::GDAL::Driver:

[legend]List of all members.

Public Class Methods
list	Capabilities ()
Public Object Methods
	Rename (scalar NewName, scalar OldName)
scalar	TestCapability (scalar cap)
scalar	Extension ()
scalar	MIMEType ()
list	CreationOptionList ()
list	CreationDataTypes ()
Geo::GDAL::Dataset	Create (scalar name, scalar xsize, scalar ysize, scalar bands=1, scalar type= 'Byte', hashref options=undef)
Geo::GDAL::Dataset	Copy (scalar name, scalar src, scalar strict=1, hashref options=undef)
	Delete (scalar name)
Public Attributes
	ShortName
	LongName
	HelpTopic

---

Member Function Documentation

list Geo::GDAL::Driver::Capabilities

(

)

Returns:

A list of capabilities. The class method returns a list of all potential capabilities a driver may have; the object method returns a list of all capabilities the driver has. Currently capabilities are 'Create' and 'CreateCopy'. Examples.

@all_capabilities = Geo::GDAL::Driver::Capabilities;
@capabilities_of_the_geotiff_driver = Geo::GDAL::Driver('GTiff')->Capabilities;

Geo::GDAL::Dataset Geo::GDAL::Driver::Copy	(	scalar	name,
		scalar	src,
		scalar	strict = 1,
		hashref	options = undef
	)

Create a new Geo::GDAL::Dataset as a copy of an existing dataset.

Note:

a.k.a. CreateCopy

Parameters:

	name
	src	A Geo::GDAL::Dataset object.
	strict
	options	An anonymous hash of driver specific parameters.

Returns:

a new Geo::GDAL::Dataset object.

Geo::GDAL::Dataset Geo::GDAL::Driver::Create	(	scalar	name,
		scalar	xsize,
		scalar	ysize,
		scalar	bands = 1,
		scalar	type = 'Byte',
		hashref	options = undef
	)

Create a GDAL dataset using this driver.

Note:

a.k.a. CreateDataset

Create a new Geo::GDAL::Dataset

Parameters:

	name
	xsize
	ysize
	bands
	type	One of the data types this driver supports.
	options	An anonymous hash of driver specific parameters.

Usage:

$ds = Geo::GDAL::Dataset::Create(...arguments...);

Returns:

a new Geo::GDAL::Dataset object

list Geo::GDAL::Driver::CreationDataTypes

(

)

Returns:

a list of data types (strings) that can be used for new datasets.

list Geo::GDAL::Driver::CreationOptionList

(

)

Returns:

a list of options, each option is a hashref, the keys are name, type and description or Value. Value is a listref.

Geo::GDAL::Driver::Delete

(

scalar

name

)

Parameters:

name

scalar Geo::GDAL::Driver::Extension

(

)

Returns:

a suggested extension or extensions (e.g., ext1/ext2) for datasets.

scalar Geo::GDAL::Driver::MIMEType

(

)

Returns:

a suggested MIME type for datasets.

Geo::GDAL::Driver::Rename	(	scalar	NewName,
		scalar	OldName
	)

Rename (move) a GDAL dataset.

Parameters:

	NewName	String.
	OldName	String.

scalar Geo::GDAL::Driver::TestCapability

(

scalar

cap

)

Test whether the driver has the specified capability.

Parameters:

cap

A capability string (one of those returned by Capabilities).

Returns:

a boolean value.

---

Member Data Documentation

Geo::GDAL::Driver::HelpTopic

$driver->{HelpTopic}

Geo::GDAL::Driver::LongName

$driver->{LongName}

Geo::GDAL::Driver::ShortName

$driver->{ShortName}

---

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

• lib/Geo/GDAL.pm

---