Files
hdf5/develop/_h5_tdevelop_8h.html
T
2024-02-09 17:39:10 +00:00

266 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: src/H5Tdevelop.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<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>
<script type="text/javascript" src="cookie.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 */
$(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="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<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>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
&#160;<span id="projectnumber">1.15.0.33bb197</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <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>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<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><!-- 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 */
$(function(){initNavTree('_h5_tdevelop_8h.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="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">H5Tdevelop.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="_h5_tpublic_8h.html">H5Tpublic.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_h5_t__cdata__t.html">H5T_cdata_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a5dcae1e3122cc65cb9553ce72d9ddc54" id="r_a5dcae1e3122cc65cb9553ce72d9ddc54"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5dcae1e3122cc65cb9553ce72d9ddc54">H5T_conv_t</a>) (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_id, <a class="el" href="struct_h5_t__cdata__t.html">H5T_cdata_t</a> *cdata, size_t nelmts, size_t buf_stride, size_t bkg_stride, void *buf, void *bkg, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dset_xfer_plist)</td></tr>
<tr class="separator:a5dcae1e3122cc65cb9553ce72d9ddc54"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a9bde6125943ed5565062a4c12c7be8bd" id="r_a9bde6125943ed5565062a4c12c7be8bd"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9bde6125943ed5565062a4c12c7be8bd">H5T_cmd_t</a> { <a class="el" href="#a9bde6125943ed5565062a4c12c7be8bda43f5846102734a89ee10fcfb1b8ac7ec">H5T_CONV_INIT</a> = 0
, <a class="el" href="#a9bde6125943ed5565062a4c12c7be8bda7b8bda43d3de1a54abee40a011e2fadb">H5T_CONV_CONV</a> = 1
, <a class="el" href="#a9bde6125943ed5565062a4c12c7be8bdafcb2a3600f4d1fc8197ae1e854d1ee49">H5T_CONV_FREE</a> = 2
}</td></tr>
<tr class="separator:a9bde6125943ed5565062a4c12c7be8bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d9a04bf7a35625abc25f1bae32c8334" id="r_a6d9a04bf7a35625abc25f1bae32c8334"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6d9a04bf7a35625abc25f1bae32c8334">H5T_bkg_t</a> { <a class="el" href="#a6d9a04bf7a35625abc25f1bae32c8334ad7354fded5cfc4459b0d46785f74cf61">H5T_BKG_NO</a> = 0
, <a class="el" href="#a6d9a04bf7a35625abc25f1bae32c8334a3feb3ee3c4a4b6c513890f8b26303794">H5T_BKG_TEMP</a> = 1
, <a class="el" href="#a6d9a04bf7a35625abc25f1bae32c8334a25d7d39f18fbdb54ec77202fbbc9dd9d">H5T_BKG_YES</a> = 2
}</td></tr>
<tr class="separator:a6d9a04bf7a35625abc25f1bae32c8334"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade8bfa5625e0b17bae72f10246be3c7e" id="r_ade8bfa5625e0b17bae72f10246be3c7e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ade8bfa5625e0b17bae72f10246be3c7e">H5T_pers_t</a> { <a class="el" href="#ade8bfa5625e0b17bae72f10246be3c7ea81e8646fa76e0bba07322d04a584a438">H5T_PERS_DONTCARE</a> = -1
, <a class="el" href="#ade8bfa5625e0b17bae72f10246be3c7eaa4f363fa661ce571b050873e7e653b98">H5T_PERS_HARD</a> = 0
, <a class="el" href="#ade8bfa5625e0b17bae72f10246be3c7ea9f5fe7567029ac797b118d4ef16f206c">H5T_PERS_SOFT</a> = 1
}</td></tr>
<tr class="separator:ade8bfa5625e0b17bae72f10246be3c7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0a23a3cb9f24bd79fae7d2d8c412a25a" id="r_ga0a23a3cb9f24bd79fae7d2d8c412a25a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_n_v.html#ga0a23a3cb9f24bd79fae7d2d8c412a25a">H5Tregister</a> (<a class="el" href="#ade8bfa5625e0b17bae72f10246be3c7e">H5T_pers_t</a> pers, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_id, <a class="el" href="#a5dcae1e3122cc65cb9553ce72d9ddc54">H5T_conv_t</a> func)</td></tr>
<tr class="memdesc:ga0a23a3cb9f24bd79fae7d2d8c412a25a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a datatype conversion function. <br /></td></tr>
<tr class="separator:ga0a23a3cb9f24bd79fae7d2d8c412a25a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc791af473dd1de512dacf0e8d6554f1" id="r_gacc791af473dd1de512dacf0e8d6554f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_n_v.html#gacc791af473dd1de512dacf0e8d6554f1">H5Tunregister</a> (<a class="el" href="#ade8bfa5625e0b17bae72f10246be3c7e">H5T_pers_t</a> pers, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_id, <a class="el" href="#a5dcae1e3122cc65cb9553ce72d9ddc54">H5T_conv_t</a> func)</td></tr>
<tr class="memdesc:gacc791af473dd1de512dacf0e8d6554f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes a conversion function. <br /></td></tr>
<tr class="separator:gacc791af473dd1de512dacf0e8d6554f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga71940c1637a309748fe93b6dceabd02f" id="r_ga71940c1637a309748fe93b6dceabd02f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a5dcae1e3122cc65cb9553ce72d9ddc54">H5T_conv_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_n_v.html#ga71940c1637a309748fe93b6dceabd02f">H5Tfind</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_id, <a class="el" href="struct_h5_t__cdata__t.html">H5T_cdata_t</a> **pcdata)</td></tr>
<tr class="memdesc:ga71940c1637a309748fe93b6dceabd02f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds a conversion function. <br /></td></tr>
<tr class="separator:ga71940c1637a309748fe93b6dceabd02f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga13fc42ad63ffd1e40e6672d30c8dd1cf" id="r_ga13fc42ad63ffd1e40e6672d30c8dd1cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_n_v.html#ga13fc42ad63ffd1e40e6672d30c8dd1cf">H5Tcompiler_conv</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_id)</td></tr>
<tr class="memdesc:ga13fc42ad63ffd1e40e6672d30c8dd1cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether the library's default conversion is hard conversion. <br /></td></tr>
<tr class="separator:ga13fc42ad63ffd1e40e6672d30c8dd1cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a5dcae1e3122cc65cb9553ce72d9ddc54" name="a5dcae1e3122cc65cb9553ce72d9ddc54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dcae1e3122cc65cb9553ce72d9ddc54">&#9670;&#160;</a></span>H5T_conv_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a>(* H5T_conv_t) (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_id, <a class="el" href="struct_h5_t__cdata__t.html">H5T_cdata_t</a> *cdata, size_t nelmts, size_t buf_stride, size_t bkg_stride, void *buf, void *bkg, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dset_xfer_plist)</td>
</tr>
</table>
</div><div class="memdoc">
<p>All datatype conversion functions are... </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a6d9a04bf7a35625abc25f1bae32c8334" name="a6d9a04bf7a35625abc25f1bae32c8334"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d9a04bf7a35625abc25f1bae32c8334">&#9670;&#160;</a></span>H5T_bkg_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#a6d9a04bf7a35625abc25f1bae32c8334">H5T_bkg_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>How is the &lsquo;bkg&rsquo; buffer used by the conversion function? </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a6d9a04bf7a35625abc25f1bae32c8334ad7354fded5cfc4459b0d46785f74cf61" name="a6d9a04bf7a35625abc25f1bae32c8334ad7354fded5cfc4459b0d46785f74cf61"></a>H5T_BKG_NO&#160;</td><td class="fielddoc"><p>background buffer is not needed, send NULL </p>
</td></tr>
<tr><td class="fieldname"><a id="a6d9a04bf7a35625abc25f1bae32c8334a3feb3ee3c4a4b6c513890f8b26303794" name="a6d9a04bf7a35625abc25f1bae32c8334a3feb3ee3c4a4b6c513890f8b26303794"></a>H5T_BKG_TEMP&#160;</td><td class="fielddoc"><p>bkg buffer used as temp storage only <br />
</p>
</td></tr>
<tr><td class="fieldname"><a id="a6d9a04bf7a35625abc25f1bae32c8334a25d7d39f18fbdb54ec77202fbbc9dd9d" name="a6d9a04bf7a35625abc25f1bae32c8334a25d7d39f18fbdb54ec77202fbbc9dd9d"></a>H5T_BKG_YES&#160;</td><td class="fielddoc"><p>init bkg buf with data before conversion <br />
</p>
</td></tr>
</table>
</div>
</div>
<a id="a9bde6125943ed5565062a4c12c7be8bd" name="a9bde6125943ed5565062a4c12c7be8bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bde6125943ed5565062a4c12c7be8bd">&#9670;&#160;</a></span>H5T_cmd_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#a9bde6125943ed5565062a4c12c7be8bd">H5T_cmd_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Commands sent to conversion functions </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9bde6125943ed5565062a4c12c7be8bda43f5846102734a89ee10fcfb1b8ac7ec" name="a9bde6125943ed5565062a4c12c7be8bda43f5846102734a89ee10fcfb1b8ac7ec"></a>H5T_CONV_INIT&#160;</td><td class="fielddoc"><p>query and/or initialize private data <br />
</p>
</td></tr>
<tr><td class="fieldname"><a id="a9bde6125943ed5565062a4c12c7be8bda7b8bda43d3de1a54abee40a011e2fadb" name="a9bde6125943ed5565062a4c12c7be8bda7b8bda43d3de1a54abee40a011e2fadb"></a>H5T_CONV_CONV&#160;</td><td class="fielddoc"><p>convert data from source to dest datatype </p>
</td></tr>
<tr><td class="fieldname"><a id="a9bde6125943ed5565062a4c12c7be8bdafcb2a3600f4d1fc8197ae1e854d1ee49" name="a9bde6125943ed5565062a4c12c7be8bdafcb2a3600f4d1fc8197ae1e854d1ee49"></a>H5T_CONV_FREE&#160;</td><td class="fielddoc"><p>function is being removed from path <br />
</p>
</td></tr>
</table>
</div>
</div>
<a id="ade8bfa5625e0b17bae72f10246be3c7e" name="ade8bfa5625e0b17bae72f10246be3c7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade8bfa5625e0b17bae72f10246be3c7e">&#9670;&#160;</a></span>H5T_pers_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#ade8bfa5625e0b17bae72f10246be3c7e">H5T_pers_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Conversion function persistence </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ade8bfa5625e0b17bae72f10246be3c7ea81e8646fa76e0bba07322d04a584a438" name="ade8bfa5625e0b17bae72f10246be3c7ea81e8646fa76e0bba07322d04a584a438"></a>H5T_PERS_DONTCARE&#160;</td><td class="fielddoc"><p>wild card <br />
</p>
</td></tr>
<tr><td class="fieldname"><a id="ade8bfa5625e0b17bae72f10246be3c7eaa4f363fa661ce571b050873e7e653b98" name="ade8bfa5625e0b17bae72f10246be3c7eaa4f363fa661ce571b050873e7e653b98"></a>H5T_PERS_HARD&#160;</td><td class="fielddoc"><p>hard conversion function <br />
</p>
</td></tr>
<tr><td class="fieldname"><a id="ade8bfa5625e0b17bae72f10246be3c7ea9f5fe7567029ac797b118d4ef16f206c" name="ade8bfa5625e0b17bae72f10246be3c7ea9f5fe7567029ac797b118d4ef16f206c"></a>H5T_PERS_SOFT&#160;</td><td class="fielddoc"><p>soft conversion function <br />
</p>
</td></tr>
</table>
</div>
</div>
</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_h5_tdevelop_8h.html">H5Tdevelop.h</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.10.0 </li>
</ul>
</div>
</body>
</html>