Files
hdf5/develop/struct_h5_f_d__t.html
T
2024-09-17 00:55:21 +00:00

326 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: H5FD_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">var page_layout=1;</script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign">
<div id="projectname">HDF5<span id="projectnumber">&#160;1.15.0.405d1b9</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="_getting_started.html"><span>Getting&#160;started</span></a></li>
<li><a href="_u_g.html"><span>User&#160;Guide</span></a></li>
<li><a href="_r_m.html"><span>Reference&#160;Manual</span></a></li>
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
<li><a href="_t_n.html"><span>Technical&#160;Notes</span></a></li>
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
<li><a href="_about.html"><span>About</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('struct_h5_f_d__t.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">H5FD_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;src/H5FDdevelop.h&gt;</code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The main datatype for each driver. Public fields common to all drivers are declared here and the driver appends private fields in memory. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ad7d72e8794f7fdb2f1a8f82eee045cdc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__t.html#ad7d72e8794f7fdb2f1a8f82eee045cdc">driver_id</a></td></tr>
<tr class="separator:ad7d72e8794f7fdb2f1a8f82eee045cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf5f74803b395b60f3285cb8156b6acb"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_h5_f_d__class__t.html">H5FD_class_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__t.html#aaf5f74803b395b60f3285cb8156b6acb">cls</a></td></tr>
<tr class="separator:aaf5f74803b395b60f3285cb8156b6acb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa056ca8d2414b80b34a00c06cd69d29e"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__t.html#aa056ca8d2414b80b34a00c06cd69d29e">fileno</a></td></tr>
<tr class="separator:aa056ca8d2414b80b34a00c06cd69d29e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fbb398b8bba779c3ef3ba0989970371"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__t.html#a3fbb398b8bba779c3ef3ba0989970371">access_flags</a></td></tr>
<tr class="separator:a3fbb398b8bba779c3ef3ba0989970371"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a793886c37ccb86dadf95c82f67fc97c1"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__t.html#a793886c37ccb86dadf95c82f67fc97c1">feature_flags</a></td></tr>
<tr class="separator:a793886c37ccb86dadf95c82f67fc97c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0028622a56650bdd60174f68b4fbca12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__t.html#a0028622a56650bdd60174f68b4fbca12">maxaddr</a></td></tr>
<tr class="separator:a0028622a56650bdd60174f68b4fbca12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab14a243c86d898a02096b602b0e210bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__t.html#ab14a243c86d898a02096b602b0e210bb">base_addr</a></td></tr>
<tr class="separator:ab14a243c86d898a02096b602b0e210bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb6633836466dc48266b42bd69334042"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__t.html#afb6633836466dc48266b42bd69334042">threshold</a></td></tr>
<tr class="separator:afb6633836466dc48266b42bd69334042"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e0ed111488b8a16fb2b2bf13593abe1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__t.html#a7e0ed111488b8a16fb2b2bf13593abe1">alignment</a></td></tr>
<tr class="separator:a7e0ed111488b8a16fb2b2bf13593abe1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75d6c2b97b2ebdc50c7a4766c25d2f04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_f_d__t.html#a75d6c2b97b2ebdc50c7a4766c25d2f04">paged_aggr</a></td></tr>
<tr class="separator:a75d6c2b97b2ebdc50c7a4766c25d2f04"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a3fbb398b8bba779c3ef3ba0989970371" name="a3fbb398b8bba779c3ef3ba0989970371"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fbb398b8bba779c3ef3ba0989970371">&#9670;&#160;</a></span>access_flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned access_flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>File access flags (from create or open) </p>
</div>
</div>
<a id="a7e0ed111488b8a16fb2b2bf13593abe1" name="a7e0ed111488b8a16fb2b2bf13593abe1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e0ed111488b8a16fb2b2bf13593abe1">&#9670;&#160;</a></span>alignment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> alignment</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocation alignment <br />
</p>
</div>
</div>
<a id="ab14a243c86d898a02096b602b0e210bb" name="ab14a243c86d898a02096b602b0e210bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab14a243c86d898a02096b602b0e210bb">&#9670;&#160;</a></span>base_addr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a> base_addr</td>
</tr>
</table>
</div><div class="memdoc">
<p>Base address for HDF5 data w/in file </p>
</div>
</div>
<a id="aaf5f74803b395b60f3285cb8156b6acb" name="aaf5f74803b395b60f3285cb8156b6acb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf5f74803b395b60f3285cb8156b6acb">&#9670;&#160;</a></span>cls</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="struct_h5_f_d__class__t.html">H5FD_class_t</a>* cls</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant class info <br />
</p>
</div>
</div>
<a id="ad7d72e8794f7fdb2f1a8f82eee045cdc" name="ad7d72e8794f7fdb2f1a8f82eee045cdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7d72e8794f7fdb2f1a8f82eee045cdc">&#9670;&#160;</a></span>driver_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> driver_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Driver ID for this file <br />
</p>
</div>
</div>
<a id="a793886c37ccb86dadf95c82f67fc97c1" name="a793886c37ccb86dadf95c82f67fc97c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a793886c37ccb86dadf95c82f67fc97c1">&#9670;&#160;</a></span>feature_flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long feature_flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>VFL Driver feature Flags </p>
</div>
</div>
<a id="aa056ca8d2414b80b34a00c06cd69d29e" name="aa056ca8d2414b80b34a00c06cd69d29e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa056ca8d2414b80b34a00c06cd69d29e">&#9670;&#160;</a></span>fileno</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long fileno</td>
</tr>
</table>
</div><div class="memdoc">
<p>File 'serial' number <br />
</p>
</div>
</div>
<a id="a0028622a56650bdd60174f68b4fbca12" name="a0028622a56650bdd60174f68b4fbca12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0028622a56650bdd60174f68b4fbca12">&#9670;&#160;</a></span>maxaddr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a> maxaddr</td>
</tr>
</table>
</div><div class="memdoc">
<p>For this file, overrides class </p>
</div>
</div>
<a id="a75d6c2b97b2ebdc50c7a4766c25d2f04" name="a75d6c2b97b2ebdc50c7a4766c25d2f04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75d6c2b97b2ebdc50c7a4766c25d2f04">&#9670;&#160;</a></span>paged_aggr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> paged_aggr</td>
</tr>
</table>
</div><div class="memdoc">
<p>Paged aggregation for file space is enabled or not </p>
</div>
</div>
<a id="afb6633836466dc48266b42bd69334042" name="afb6633836466dc48266b42bd69334042"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb6633836466dc48266b42bd69334042">&#9670;&#160;</a></span>threshold</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> threshold</td>
</tr>
</table>
</div><div class="memdoc">
<p>Threshold for alignment <br />
</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="_h5_f_ddevelop_8h.html">H5FDdevelop.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="struct_h5_f_d__t.html">H5FD_t</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.7 </li>
</ul>
</div>
</body>
</html>