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
148
149
150
151
152
153
|
/*
* Copyright 2015 ETH Zuerich, SIS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ch.systemsx.cisd.hdf5;
import static hdf.hdf5lib.H5.H5Pclose;
import static hdf.hdf5lib.H5.H5Sclose;
/**
* An object to represent a template of an HDF5 data set.
* <p>
* <i>Close it after usage is finished as otherwise you will leak resources from the HDF5
* library.</i>
* <p>
* Open the object using the method <code>createArrayTemplate()</code> from one of the primitive writers and use it
* in that writer to specify the parameters of a new data set. As it caches HDF5 objects, it will speed up the creation
* process for repeated creation of data sets with the same template parameters.
* <p>
* A typical pattern for using this class is:
* <pre>
* try (final HDF5DataSetTemplate tmpl =
* writer.float32().createArrayTemplate(length, length, HDF5IntStorageFeatures.INT_CONTIGUOUS))
* {
* for (int i = 0; i < num; ++i)
* {
* writer.float32().writeArray("ds" + i, array[i], tmpl);
* }
* }
* </pre>
* Assigning the <code>HDF5DataSetTemplate</code> object in a <code>try()</code> block is a recommened practice to
* ensure that the underlying HDF5 objects are properly closed at the end.
*
* @author Bernd Rinn
*/
public class HDF5DataSetTemplate implements AutoCloseable
{
private final HDF5StorageLayout layout;
private final long[] dimensions;
private final long[] maxDimensions;
private final long dataSetCreationPropertyListId;
private final boolean closeCreationPropertyListId;
private final long storageDataTypeId;
private long dataspaceId;
HDF5DataSetTemplate(long dataspaceId, long dataSetCreationPropertyListId,
boolean closeCreationPropertyListId, long storageDataTypeId, long[] dimensions,
long[] maxDimensions, HDF5StorageLayout layout)
{
this.dataspaceId = dataspaceId;
this.dataSetCreationPropertyListId = dataSetCreationPropertyListId;
this.closeCreationPropertyListId = closeCreationPropertyListId;
this.storageDataTypeId = storageDataTypeId;
this.dimensions = dimensions;
this.maxDimensions = maxDimensions;
this.layout = layout;
}
long getDataspaceId()
{
return dataspaceId;
}
long getDataSetCreationPropertyListId()
{
return dataSetCreationPropertyListId;
}
long getStorageDataTypeId()
{
return storageDataTypeId;
}
long[] getDimensions()
{
return dimensions;
}
long[] getMaxDimensions()
{
return maxDimensions;
}
HDF5StorageLayout getLayout()
{
return layout;
}
@Override
public void close()
{
if (dataspaceId > 0)
{
H5Sclose(dataspaceId);
dataspaceId = -1;
if (closeCreationPropertyListId)
{
H5Pclose(dataSetCreationPropertyListId);
}
}
}
@Override
public int hashCode()
{
final int prime = 31;
int result = 1;
result = prime * result + (int) dataspaceId;
return result;
}
@Override
public boolean equals(Object obj)
{
if (this == obj)
{
return true;
}
if (obj == null)
{
return false;
}
if (getClass() != obj.getClass())
{
return false;
}
HDF5DataSetTemplate other = (HDF5DataSetTemplate) obj;
if (dataspaceId != other.dataspaceId)
{
return false;
}
return true;
}
}
|
