.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Geo::GDAL::FFI::Object 3pm"
.TH Geo::GDAL::FFI::Object 3pm 2024-05-24 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Geo::GDAL::FFI::Object \- A GDAL major object
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The base class for classes Driver, Dataset, Band, and Layer.
.SH METHODS
.IX Header "METHODS"
.SS GetDescription
.IX Subsection "GetDescription"
.Vb 1
\& my $desc = $object\->GetDescription;
.Ve
.SS HasCapability
.IX Subsection "HasCapability"
.Vb 1
\& my $has_cap = $object\->HasCapability($capability);
.Ve
.SS GetMetadataDomainList
.IX Subsection "GetMetadataDomainList"
.Vb 1
\& my @domains = $object\->GetMetadataDomainList;
.Ve
.SS GetMetadata
.IX Subsection "GetMetadata"
.Vb 1
\& my %metadata = $object\->GetMetadata($domain);
.Ve
.PP
Returns the object metadata of a given domain.
.PP
.Vb 1
\& my $metadata = $object\->GetMetadata($domain);
.Ve
.PP
Returns the object metadata of a given domain in an anonymous hash.
.PP
.Vb 1
\& my %metadata = $object\->GetMetadata;
.Ve
.PP
Returns the object metadata.
.PP
.Vb 1
\& my $metadata = $object\->GetMetadata;
.Ve
.PP
Returns the object metadata in an anonymous hash.
.SS SetMetadata
.IX Subsection "SetMetadata"
.Vb 1
\& $object\->SetMetadata($metadata, $domain);
.Ve
.PP
Sets the object metadata in a given domain. The metadata is in an
anonymous hash.
.PP
.Vb 1
\& $object\->SetMetadata($metadata);
.Ve
.PP
Sets the object metadata in the domains that are the keys of the hash
\&\f(CW$metadata\fR references. The values of the hash are the metadata in
anonymous hashes.
.SS GetMetadataItem
.IX Subsection "GetMetadataItem"
.Vb 1
\& my $value = $object\->GetMetadataItem($item, $domain)
.Ve
.PP
Gets the value of the metadata item in a domain (by default an empty
string).
.SS SetMetadataItem
.IX Subsection "SetMetadataItem"
.Vb 1
\& $object\->GetMetadataItem($item, $value, $domain)
.Ve
.PP
Sets the value of the metadata item in a domain (by default an empty
string).
.SH LICENSE
.IX Header "LICENSE"
This software is released under the Artistic License. See
perlartistic.
.SH AUTHOR
.IX Header "AUTHOR"
Ari Jolma \- Ari.Jolma at gmail.com
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Geo::GDAL::FFI
.PP
Alien::gdal, FFI::Platypus, <http://www.gdal.org>