summaryrefslogtreecommitdiffstats
path: root/doc/html/TechNotes/TestReview/H5Dget_offset.html
blob: 0056f00934e19bb12f9bf0d5a0febb80e277b158 (plain)
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
  <TITLE>H5Dget_offset Test Review</TITLE>
  <META http-equiv="content-type" content="text/html; charset=ISO-8859-1">
  <META name="author" content="Quincey Koziol">
</HEAD>
<body text="#000000" bgcolor="#FFFFFF">
<STYLE type="text/css">
OL.loweralpha { list-style-type: lower-alpha }
OL.upperroman { list-style-type: upper-roman }
</STYLE>
       
<CENTER><H1>H5Dget_offset Test Review</H1></CENTER>

<OL class="upperroman">

<LI><H3><U>Purpose:</U></H3>
<P>This document describes the API test review results for <a href="../../RM_H5D.html#Dataset-GetOffset">H5Dget_offset</a>().
</P>

<LI><H3><U>Serial Review:</U></H3>
<TABLE border="1">
<TR>
<TH>Test case
</TH>

<TH>Test source file
</TH>

<TH>Test method
</TH>

<TH>Expected test results
</TH>

<TH>Notes
</TH>

<TR>
<TD>Chunked dataset
</TD>

<TD>dsets.c
</TD>

<TD>
<OL>
<LI>Create chunked dataset
<LI>Query dataset offset
</OL>
</TD>

<TD>FAIL
</TD>

<TD>
<P>Because dataset is stored in chunks that are indexed by a B-tree, there is
no single piece of data to query the offset of.
</P>
<P>It may be possible in the future to
enhance this function by querying the offset of a particular chunk (or chunks),
but that has limited use because chunks could be compressed, etc. with an I/O
filter.
</P>
</TD>

</TR>

<TR>
<TD>Compact dataset
</TD>

<TD>dsets.c
</TD>

<TD>
<OL>
<LI>Create chunked dataset
<LI>Query dataset offset
</OL>
</TD>

<TD>FAIL
</TD>

<TD>
<P>Because dataset is stored in the object header of the dataset, there is
no separate piece of data to query the offset of.
</P>
<P>It may be possible in the future to get the offset of the data in the object
header, but this is problematic due to the fact that the messages in the object
header can get relocated in the file when changes (like adding attributes, etc.)
are made to the dataset, invalidating the address given to the user.
filter.
</P>
</TD>

</TR>

<TR>
<TD>Contiguous dataset, [user block size] == 0, not external
</TD>

<TD>dsets.c
</TD>

<TD>
<OL>
<LI>Create file with 0 sized user-block (the default)
<LI>Create contigous dataset
<LI>Query dataset offset
</OL>
</TD>

<TD>
<P>Succeed in getting the proper address and be able to verify
that the data at that address in the file is what was written out.
</P>
<P>When data storage allocation is "late" (the default), querying the offset
should fail if performed before data is written to the dataset.
</P>
</TD>

<TD>Needs additional test to verify that the data written out is located at the
correct offset in the file.
</TD>

</TR>

<TR>
<TD>Contiguous dataset, [user block size] != 0, not external
</TD>

<TD>dsets.c
</TD>

<TD>
<OL>
<LI>Create file with non-0 sized user-block
<LI>Create contigous dataset
<LI>Query dataset offset
</OL>
</TD>

<TD>
<P>Succeed in getting the proper address and be able to verify
that the data at that address in the file is what was written out.
</P>
<P>When data storage allocation is "late" (the default), querying the offset
should fail if performed before data is written to the dataset.
</P>
</TD>

<TD>Needs test for this case.
</TD>

</TR>

<TR>
<TD>Contiguous dataset, [user block size] == 0, external data storage
</TD>

<TD>external.c
</TD>

<TD>
<OL>
<LI>Create contigous dataset with external storage
<LI>Query dataset offset
</OL>
</TD>

<TD>FAIL
</TD>

<TD>
<P>In theory, it's easy to return the offset of the data in the external file,
but this wasn't done because it would be too easy for users to assume that the
offset returned was in the HDF5 file instead of the external file.
</P>
</TD>

</TR>

</TABLE>
<BR>

<LI><H3><U>Parallel Review:</U></H3>
<P>The H5Dget_offset() function is not tested in parallel.  Currently, there
does not appear to be a need for this.
</P>

         
</OL>

</BODY>
</HTML>