Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

[178023]: HDF5 / Group.pm Maximize Restore History

Download this file

Group.pm    149 lines (95 with data), 3.0 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
package PDL::HDF5::Group;
use Carp;
=head1 NAME
PDL::HDF5::Group - PDL::HDF5 Helper Object representing HDF5 groups.
=head1 DESCRIPTION
This is a helper-object used by PDL::HDF5 to interface with HDF5 format's group objects.
Information on the HDF5 Format can be found
at the NCSA's web site at http://hdf.ncsa.uiuc.edu/ .
=head1 SYNOPSIS
See L<PDL::HDF5>
=head1 MEMBER DATA
=over 1
=item groupID
ID number given to the group by the HDF5 library
=item groupname
Name of the group. (Absolute to the root group '/'. e.g. /maingroup/subgroup)
=item fileID
fileID of the HDF file that owns this group.
=item filename
filename of the HDF file that owns this group
=back
=head1 METHODS
####---------------------------------------------------------
=head2 new
=for ref
PDL::HDF5::Group Constructor - creates new object
B<Usage:>
=for usage
This object will usually be created using the calling format detailed in the L<SYNOPSIS>. The
following syntax is used by the L<PDL::HDF5> object to build the object.
$a = new PDL::HDF5:Group( name => $name, filename => $filename, fileID => $fileID );
Args:
$name Name of the group
$filename Filename that owns this group
$fileID FileID of the file that owns this group
=cut
sub new{
my $type = shift;
my %parms = @_;
my $self = {};
my @DataMembers = qw( name filename fileID );
my %DataMembers;
@DataMembers{ @DataMembers } = @DataMembers; # hash for quick lookup
# check for proper supplied names:
my $varName;
foreach $varName(keys %parms){
unless( defined($DataMembers{$varName})){
carp("Error Calling ".__PACKAGE__." Constuctor\n \'$varName\' not a valid data member\n");
return undef;
}
unless( defined($parms{$varName})){
carp("Error Calling ".__PACKAGE__." Constuctor\n \'$varName\' not supplied\n");
return undef;
}
$self->{$varName} = $parms{$varName};
}
my $fileID = $self->{fileID};
my $filename = $self->{filename};
my $name = $self->{name};
# Turn Error Reporting off for the following, so H5 lib doesn't complain
# if the group isn't found.
PDL::HDF5::H5errorOff();
my $rc = PDL::HDF5::H5Gget_objinfo($fileID, $name,1,0);
PDL::HDF5::H5errorOn();
# See if the group exists:
if( $rc >= 0){
#Group Exists open it:
my $groupID = PDL::HDF5::H5Gopen($fileID, $name);
}
else{ # group didn't exist, create it:
$groupID = PDL::HDF5::H5Gcreate($fileID, $name, 0);
}
# Try Opening the Group First (Assume it already exists)
if($groupID < 0 ){
carp "Error Calling ".__PACKAGE__." Constuctor: Can't open or create group '$name'\n";
return undef;
}
$self->{groupID} = $groupID;
bless $self, $type;
return $self;
}
=head2 DESTROY
=for ref
PDL::HDF5 Desctructor - Closes the HDF5 file
B<Usage:>
=for usage
No Usage. Automatically called
=cut
sub DESTROY {
my $self = shift;
if( H5Gclose($self->{groupID}) < 0){
warn("Error closing HDF5 Group '".$self->{name}."' in file '".$self->{filename}."'\n");
}
}
1;