.\" -*- 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 "HDF5::Group 3pm"
.TH HDF5::Group 3pm 2024-01-10 "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
PDL::IO::HDF5::Group \- PDL::IO::HDF5 Helper Object representing HDF5 groups.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a helper-object used by PDL::IO::HDF5 to interface with HDF5 format's group objects.
Information on the HDF5 Format can be found
at the HDF Group's web site at http://www.hdfgroup.org .
.SH SYNOPSIS
.IX Header "SYNOPSIS"
See PDL::IO::HDF5
.SH "MEMBER DATA"
.IX Header "MEMBER DATA"
.IP ID 1
.IX Item "ID"
ID number given to the group by the HDF5 library
.IP name 1
.IX Item "name"
Name of the group. (Absolute to the root group '/'. e.g. /maingroup/subgroup)
.IP parent 1
.IX Item "parent"
Ref to parent object (file or group) that owns this group.
.IP fileObj 1
.IX Item "fileObj"
Ref to the PDL::IO::HDF5 object that owns this object.
.SH METHODS
.IX Header "METHODS"
####\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.SS new
.IX Subsection "new"
PDL::IO::HDF5::Group Constructor \- creates new object
.PP
\&\fBUsage:\fR
.PP
This object will usually be created using the calling format detailed in the SYNOPSIS. The 
following syntax is used by the PDL::IO::HDF5 object to build the object.
.PP
.Vb 6
\&   $a = new PDL::IO::HDF5:Group( name => $name, parent => $parent,
\&                              fileObj => $fileObj );
\&        Args:
\&        $name                           Name of the group (relative to the parent)
\&        $parent                         Parent Object that owns this group
\&        $fileObj                        PDL::HDF (Top Level) object that owns this group.
.Ve
.SS DESTROY
.IX Subsection "DESTROY"
PDL::IO::HDF5 Destructor \- Closes the HDF5::Group Object.
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\&   No Usage. Automatically called
.Ve
.SS attrSet
.IX Subsection "attrSet"
Set the value of an attribute(s)
.PP
Supports null-terminated strings, integers and floating point scalar and 1D array attributes.
.PP
\&\fBUsage:\fR
.PP
.Vb 7
\&   $group\->attrSet( \*(Aqattr1\*(Aq => \*(Aqattr1Value\*(Aq,
\&                    \*(Aqattr2\*(Aq => \*(Aqattr2 value\*(Aq, 
\&                    \*(Aqattr3\*(Aq => $pdl,
\&                    .
\&                    .
\&                    .
\&                   );
.Ve
.PP
Returns undef on failure, 1 on success.
.SS attrGet
.IX Subsection "attrGet"
Get the value of an attribute(s)
.PP
Supports null-terminated strings, integer and floating point scalar and 1D array attributes.
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\&   my @attrs = $group\->attrGet( \*(Aqattr1\*(Aq, \*(Aqattr2\*(Aq);
.Ve
.SS attrDel
.IX Subsection "attrDel"
Delete attribute(s)
.PP
\&\fBUsage:\fR
.PP
.Vb 6
\&   $group\->attrDel( \*(Aqattr1\*(Aq, 
\&                    \*(Aqattr2\*(Aq,
\&                    .
\&                    .
\&                    .
\&                   );
.Ve
.PP
Returns undef on failure, 1 on success.
.SS attrs
.IX Subsection "attrs"
Get a list of all attribute names in a group
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\&   @attrs = $group\->attrs;
.Ve
.SS dataset
.IX Subsection "dataset"
Open an existing or create a new dataset in a group.
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\&   $dataset = $group\->dataset(\*(Aqnewdataset\*(Aq);
.Ve
.PP
Returns undef on failure, 1 on success.
.SS datasets
.IX Subsection "datasets"
Get a list of all dataset names in a group. (Relative to the current group)
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\&   @datasets = $group\->datasets;
.Ve
.SS group
.IX Subsection "group"
Open an existing or create a new group in an existing group.
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\&   $newgroup = $oldgroup\->group("newgroup");
.Ve
.PP
Returns undef on failure, 1 on success.
.SS groups
.IX Subsection "groups"
Get a list of all group names in a group. (Relative to the current group)
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\&   @groupNames = $group\->groups;
.Ve
.SS _buildAttrIndex
.IX Subsection "_buildAttrIndex"
Internal Recursive Method to build the attribute index hash
for the object
.PP
For the purposes of indexing groups by their attributes, the attributes are 
applied hierarchial. i.e. any attributes of the higher level groups are assumed to be 
apply for the lower level groups.
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\&   $group\->_buildAttrIndex($index, $currentAttrs);
\&
\&    
\& Input/Output:
\&
\&         $index:        Total Index hash ref
\&         $currentAttrs: Hash refs of the attributes valid 
\&                        for the current group.
.Ve
.SS IDget
.IX Subsection "IDget"
Returns the HDF5 library ID for this object
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\& my $ID = $groupObj\->IDget;
.Ve
.SS nameGet
.IX Subsection "nameGet"
Returns the HDF5 Group Name for this object. (Relative to the root group)
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\& my $name = $groupObj\->nameGet;
.Ve
.SS reference
.IX Subsection "reference"
Creates a reference to a region of a dataset.
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\&  $groupObj\->reference($referenceName,$datasetObj,@regionStart,@regionCount);
.Ve
.PP
Create a reference named \f(CW$referenceName\fR within the group \f(CW$groupObj\fR to a subroutine of
the dataset \f(CW$datasetObj\fR. The region to be referenced is defined by the \f(CW@regionStart\fR
and \f(CW@regionCount\fR arrays.
.SS unlink
.IX Subsection "unlink"
Unlink an object from a group.
.PP
\&\fBUsage:\fR
.PP
.Vb 1
\&  $groupObj\->unlink($objectName);
.Ve
.PP
Unlink the named object from the group.