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

295 lines
14 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: H5Z_class2_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_z__class2__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">H5Z_class2_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;src/H5Zdevelop.h&gt;</code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The filter table maps filter identification numbers to structs that contain a pointers to the filter function and timing statistics. </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:aad880fc4455c253781e8968f2239d56f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__class2__t.html#aad880fc4455c253781e8968f2239d56f">version</a></td></tr>
<tr class="separator:aad880fc4455c253781e8968f2239d56f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f3027958c7ad4552356a1e47e4db2ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_zpublic_8h.html#afae8461c70d47e63be2163af23362237">H5Z_filter_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__class2__t.html#a6f3027958c7ad4552356a1e47e4db2ce">id</a></td></tr>
<tr class="separator:a6f3027958c7ad4552356a1e47e4db2ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1622cd6083cfb9a6c4efb5d5bf67b143"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__class2__t.html#a1622cd6083cfb9a6c4efb5d5bf67b143">encoder_present</a></td></tr>
<tr class="separator:a1622cd6083cfb9a6c4efb5d5bf67b143"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3f8cbfa487cb4c06ad2210d0b81a271"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__class2__t.html#af3f8cbfa487cb4c06ad2210d0b81a271">decoder_present</a></td></tr>
<tr class="separator:af3f8cbfa487cb4c06ad2210d0b81a271"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f8f80d37794cde9472343e4487ba3eb"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__class2__t.html#a8f8f80d37794cde9472343e4487ba3eb">name</a></td></tr>
<tr class="separator:a8f8f80d37794cde9472343e4487ba3eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10d4a5417743a68aafc95160c5152601"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_zdevelop_8h.html#af2d1e20aeb92b2712ebc2d9b5fcbf510">H5Z_can_apply_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__class2__t.html#a10d4a5417743a68aafc95160c5152601">can_apply</a></td></tr>
<tr class="separator:a10d4a5417743a68aafc95160c5152601"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d89ab9372734010a5c500ea3e694a03"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_zdevelop_8h.html#a32591ae9c5164edd548c9885f430b15e">H5Z_set_local_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__class2__t.html#a5d89ab9372734010a5c500ea3e694a03">set_local</a></td></tr>
<tr class="separator:a5d89ab9372734010a5c500ea3e694a03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a995507f1980f1e7f971fda7c362a213b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_zdevelop_8h.html#a130d8964a46667029c7d3c14572577c6">H5Z_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_z__class2__t.html#a995507f1980f1e7f971fda7c362a213b">filter</a></td></tr>
<tr class="separator:a995507f1980f1e7f971fda7c362a213b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a10d4a5417743a68aafc95160c5152601" name="a10d4a5417743a68aafc95160c5152601"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10d4a5417743a68aafc95160c5152601">&#9670;&#160;</a></span>can_apply</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_zdevelop_8h.html#af2d1e20aeb92b2712ebc2d9b5fcbf510">H5Z_can_apply_func_t</a> can_apply</td>
</tr>
</table>
</div><div class="memdoc">
<p>The "can apply" callback for a filter <br />
</p>
</div>
</div>
<a id="af3f8cbfa487cb4c06ad2210d0b81a271" name="af3f8cbfa487cb4c06ad2210d0b81a271"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3f8cbfa487cb4c06ad2210d0b81a271">&#9670;&#160;</a></span>decoder_present</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned decoder_present</td>
</tr>
</table>
</div><div class="memdoc">
<p>Does this filter have a decoder? <br />
</p>
</div>
</div>
<a id="a1622cd6083cfb9a6c4efb5d5bf67b143" name="a1622cd6083cfb9a6c4efb5d5bf67b143"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1622cd6083cfb9a6c4efb5d5bf67b143">&#9670;&#160;</a></span>encoder_present</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned encoder_present</td>
</tr>
</table>
</div><div class="memdoc">
<p>Does this filter have an encoder? <br />
</p>
</div>
</div>
<a id="a995507f1980f1e7f971fda7c362a213b" name="a995507f1980f1e7f971fda7c362a213b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a995507f1980f1e7f971fda7c362a213b">&#9670;&#160;</a></span>filter</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_zdevelop_8h.html#a130d8964a46667029c7d3c14572577c6">H5Z_func_t</a> filter</td>
</tr>
</table>
</div><div class="memdoc">
<p>The actual filter function <br />
</p>
</div>
</div>
<a id="a6f3027958c7ad4552356a1e47e4db2ce" name="a6f3027958c7ad4552356a1e47e4db2ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f3027958c7ad4552356a1e47e4db2ce">&#9670;&#160;</a></span>id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_zpublic_8h.html#afae8461c70d47e63be2163af23362237">H5Z_filter_t</a> id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Filter ID number <br />
</p>
</div>
</div>
<a id="a8f8f80d37794cde9472343e4487ba3eb" name="a8f8f80d37794cde9472343e4487ba3eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f8f80d37794cde9472343e4487ba3eb">&#9670;&#160;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Comment for debugging <br />
</p>
</div>
</div>
<a id="a5d89ab9372734010a5c500ea3e694a03" name="a5d89ab9372734010a5c500ea3e694a03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d89ab9372734010a5c500ea3e694a03">&#9670;&#160;</a></span>set_local</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_zdevelop_8h.html#a32591ae9c5164edd548c9885f430b15e">H5Z_set_local_func_t</a> set_local</td>
</tr>
</table>
</div><div class="memdoc">
<p>The "set local" callback for a filter <br />
</p>
</div>
</div>
<a id="aad880fc4455c253781e8968f2239d56f" name="aad880fc4455c253781e8968f2239d56f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad880fc4455c253781e8968f2239d56f">&#9670;&#160;</a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Version number of the H5Z_class_t struct <br />
</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="_h5_zdevelop_8h.html">H5Zdevelop.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_z__class2__t.html">H5Z_class2_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>