diff options
author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
---|---|---|
committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
commit | 4f20d880c97be1249f8d89ced95f72836dbf3ee0 (patch) | |
tree | 30d8dcb282134b7126b092796f2be00d2d97bd3c /develop/group___f_h5_d_s.html | |
parent | 4e7e457497c948b41c8b0065225875bf10cdf9d4 (diff) | |
download | hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.zip hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.gz hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.bz2 |
deploy: ef39882fa1e13740d2530c7a0637bd1f1a822b68
Diffstat (limited to 'develop/group___f_h5_d_s.html')
-rw-r--r-- | develop/group___f_h5_d_s.html | 622 |
1 files changed, 622 insertions, 0 deletions
diff --git a/develop/group___f_h5_d_s.html b/develop/group___f_h5_d_s.html new file mode 100644 index 0000000..3b802a7 --- /dev/null +++ b/develop/group___f_h5_d_s.html @@ -0,0 +1,622 @@ +<!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.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>HDF5: Fortran High Level Dimension Scales (H5DS) Interface</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> +<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(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="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> +  <span id="projectnumber">1.15.0.ef39882</span> + </div> + <div id="projectbrief">API Reference</div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.svg" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="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.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('group___f_h5_d_s.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"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions/Subroutines</a> </div> + <div class="headertitle"> +<div class="title">Fortran High Level Dimension Scales (H5DS) Interface</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_d_s.html">HDF5 Dimension Scales APIs (H5DS)</a>, C-HL API</dd> +<dd> +<a class="el" href="_h5_d_s__u_g.html">The HDF5 High Level Dimension Scales</a>, User Guide </dd></dl> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions/Subroutines</h2></td></tr> +<tr class="memitem:gadd827eed1f551d9c6cb866f98cbc26c4"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#gadd827eed1f551d9c6cb866f98cbc26c4">h5dsset_scale_f</a> (dsid, errcode, dimname)</td></tr> +<tr class="memdesc:gadd827eed1f551d9c6cb866f98cbc26c4"><td class="mdescLeft"> </td><td class="mdescRight">Convert dataset <code>dsid</code> to a dimension scale, with optional name, <code>dimname</code>. <a href="group___f_h5_d_s.html#gadd827eed1f551d9c6cb866f98cbc26c4">More...</a><br /></td></tr> +<tr class="separator:gadd827eed1f551d9c6cb866f98cbc26c4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga67c5b17ab33106d551f5f7530cde3e8a"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga67c5b17ab33106d551f5f7530cde3e8a">h5dsattach_scale_f</a> (did, dsid, idx, errcode)</td></tr> +<tr class="memdesc:ga67c5b17ab33106d551f5f7530cde3e8a"><td class="mdescLeft"> </td><td class="mdescRight">Attach dimension scale dsid to dimension <code>idx</code> of dataset <code>did</code>. <a href="group___f_h5_d_s.html#ga67c5b17ab33106d551f5f7530cde3e8a">More...</a><br /></td></tr> +<tr class="separator:ga67c5b17ab33106d551f5f7530cde3e8a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga977ccd172622afcfd4a3c37e5cb61523"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga977ccd172622afcfd4a3c37e5cb61523">h5dsdetach_scale_f</a> (did, dsid, idx, errcode)</td></tr> +<tr class="memdesc:ga977ccd172622afcfd4a3c37e5cb61523"><td class="mdescLeft"> </td><td class="mdescRight">Detach dimension scale dsid from the dimension idx of dataset <code>did</code>. <a href="group___f_h5_d_s.html#ga977ccd172622afcfd4a3c37e5cb61523">More...</a><br /></td></tr> +<tr class="separator:ga977ccd172622afcfd4a3c37e5cb61523"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3aec1b97a797c331339884a33f730947"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga3aec1b97a797c331339884a33f730947">h5dsis_attached_f</a> (did, dsid, idx, is_attached, errcode)</td></tr> +<tr class="memdesc:ga3aec1b97a797c331339884a33f730947"><td class="mdescLeft"> </td><td class="mdescRight">Report if dimension scale dsid is currently attached to dimension idx of dataset did. <a href="group___f_h5_d_s.html#ga3aec1b97a797c331339884a33f730947">More...</a><br /></td></tr> +<tr class="separator:ga3aec1b97a797c331339884a33f730947"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3969047e9d807826fa7b7343462fcfd5"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga3969047e9d807826fa7b7343462fcfd5">h5dsis_scale_f</a> (did, is_scale, errcode)</td></tr> +<tr class="memdesc:ga3969047e9d807826fa7b7343462fcfd5"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether <code>did</code> is a Dimension Scale. <a href="group___f_h5_d_s.html#ga3969047e9d807826fa7b7343462fcfd5">More...</a><br /></td></tr> +<tr class="separator:ga3969047e9d807826fa7b7343462fcfd5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5e9d75d18f0300c6934106d90a5aca1a"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga5e9d75d18f0300c6934106d90a5aca1a">h5dsset_label_f</a> (did, idx, label, errcode)</td></tr> +<tr class="memdesc:ga5e9d75d18f0300c6934106d90a5aca1a"><td class="mdescLeft"> </td><td class="mdescRight">Set label for the dimension <code>idx</code> of <code>did</code> to the value <code>label</code>. <a href="group___f_h5_d_s.html#ga5e9d75d18f0300c6934106d90a5aca1a">More...</a><br /></td></tr> +<tr class="separator:ga5e9d75d18f0300c6934106d90a5aca1a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa9a3ae7a6487f00779f323596aa2d859"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#gaa9a3ae7a6487f00779f323596aa2d859">h5dsget_label_f</a> (did, idx, label, size, errcode)</td></tr> +<tr class="memdesc:gaa9a3ae7a6487f00779f323596aa2d859"><td class="mdescLeft"> </td><td class="mdescRight">Read the <code>label</code> for dimension <code>idx</code> of <code>did</code> into buffer <code>label</code>. <a href="group___f_h5_d_s.html#gaa9a3ae7a6487f00779f323596aa2d859">More...</a><br /></td></tr> +<tr class="separator:gaa9a3ae7a6487f00779f323596aa2d859"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabde5f3ba8fc2338e68b3e41b9493c6b6"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#gabde5f3ba8fc2338e68b3e41b9493c6b6">h5dsget_scale_name_f</a> (did, name, size, errcode)</td></tr> +<tr class="memdesc:gabde5f3ba8fc2338e68b3e41b9493c6b6"><td class="mdescLeft"> </td><td class="mdescRight">Read the name of scale <code>did</code> into buffer name. <a href="group___f_h5_d_s.html#gabde5f3ba8fc2338e68b3e41b9493c6b6">More...</a><br /></td></tr> +<tr class="separator:gabde5f3ba8fc2338e68b3e41b9493c6b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4bf470fa8fdcb2a40acf051237df2f7a"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_d_s.html#ga4bf470fa8fdcb2a40acf051237df2f7a">h5dsget_num_scales_f</a> (did, idx, num_scales, errcode)</td></tr> +<tr class="memdesc:ga4bf470fa8fdcb2a40acf051237df2f7a"><td class="mdescLeft"> </td><td class="mdescRight">Determines how many Dimension Scales are attached to dimension idx of <code>did</code>. <a href="group___f_h5_d_s.html#ga4bf470fa8fdcb2a40acf051237df2f7a">More...</a><br /></td></tr> +<tr class="separator:ga4bf470fa8fdcb2a40acf051237df2f7a"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function/Subroutine Documentation</h2> +<a id="ga67c5b17ab33106d551f5f7530cde3e8a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga67c5b17ab33106d551f5f7530cde3e8a">◆ </a></span>h5dsattach_scale_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5ds::h5dsattach_scale_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>did</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>dsid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Attach dimension scale dsid to dimension <code>idx</code> of dataset <code>did</code>. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">did</td><td>The dataset. </td></tr> + <tr><td class="paramname">dsid</td><td>The scale to be attached. </td></tr> + <tr><td class="paramname">idx</td><td>The dimension of <code>did</code> that <code>dsid</code> is associated with. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_d_s.html#ga4149785cd62520d6fc2736489f74e296">H5DSattach_scale()</a> </p> + +</div> +</div> +<a id="ga977ccd172622afcfd4a3c37e5cb61523"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga977ccd172622afcfd4a3c37e5cb61523">◆ </a></span>h5dsdetach_scale_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5ds::h5dsdetach_scale_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>did</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>dsid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Detach dimension scale dsid from the dimension idx of dataset <code>did</code>. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">did</td><td>The dataset. </td></tr> + <tr><td class="paramname">dsid</td><td>The scale to be detached. </td></tr> + <tr><td class="paramname">idx</td><td>The dimension of <code>did</code> to detach. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaa9a3ae7a6487f00779f323596aa2d859"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa9a3ae7a6487f00779f323596aa2d859">◆ </a></span>h5dsget_label_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5ds::h5dsget_label_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>did</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(inout) </td> + <td class="paramname"><em>label</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(inout) </td> + <td class="paramname"><em>size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Read the <code>label</code> for dimension <code>idx</code> of <code>did</code> into buffer <code>label</code>. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">did</td><td>The dataset. </td></tr> + <tr><td class="paramname">idx</td><td>The dimension. </td></tr> + <tr><td class="paramname">label</td><td>The label. </td></tr> + <tr><td class="paramname">size</td><td>The length of the <code>label</code> buffer. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_d_s.html#gaaefa5dcd96a7dba034764b70e2f3aa38">H5DSget_label()</a> </p> + +</div> +</div> +<a id="ga4bf470fa8fdcb2a40acf051237df2f7a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga4bf470fa8fdcb2a40acf051237df2f7a">◆ </a></span>h5dsget_num_scales_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5ds::h5dsget_num_scales_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>did</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(inout) </td> + <td class="paramname"><em>num_scales</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Determines how many Dimension Scales are attached to dimension idx of <code>did</code>. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">did</td><td>The dataset to query. </td></tr> + <tr><td class="paramname">idx</td><td>The dimension of <code>did</code> to query. </td></tr> + <tr><td class="paramname">num_scales</td><td>Number of Dimension Scales associated with <code>did</code>. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_d_s.html#gaa373f8cb78fa2014c50fe8e3dd85ea90">H5DSget_num_scales()</a> </p> + +</div> +</div> +<a id="gabde5f3ba8fc2338e68b3e41b9493c6b6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabde5f3ba8fc2338e68b3e41b9493c6b6">◆ </a></span>h5dsget_scale_name_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5ds::h5dsget_scale_name_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>did</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(inout) </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(size_t), intent(inout) </td> + <td class="paramname"><em>size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Read the name of scale <code>did</code> into buffer name. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">did</td><td>Dimension scale identifier. </td></tr> + <tr><td class="paramname">name</td><td>Buffer to contain the returned name. </td></tr> + <tr><td class="paramname">size</td><td>Size in bytes, of the name buffer. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_d_s.html#ga81de6ce31478c7bc3a9f80b8c600170a">H5DSget_scale_name()</a> </p> + +</div> +</div> +<a id="ga3aec1b97a797c331339884a33f730947"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3aec1b97a797c331339884a33f730947">◆ </a></span>h5dsis_attached_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5ds::h5dsis_attached_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>did</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>dsid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">logical, intent(out) </td> + <td class="paramname"><em>is_attached</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Report if dimension scale dsid is currently attached to dimension idx of dataset did. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">did</td><td>The dataset. </td></tr> + <tr><td class="paramname">dsid</td><td>The scale to be attached. </td></tr> + <tr><td class="paramname">idx</td><td>The dimension of <code>did</code> that <code>dsid</code> is associated with. </td></tr> + <tr><td class="paramname">is_attached</td><td>If dimension scale <code>dsid</code> is currently attached to dimension <code>idx</code> of dataset <code>did</code>. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_d_s.html#ga76884eddb41d52adf4eb3278c135bbe4">H5DSis_attached()</a> </p> + +</div> +</div> +<a id="ga3969047e9d807826fa7b7343462fcfd5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3969047e9d807826fa7b7343462fcfd5">◆ </a></span>h5dsis_scale_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5ds::h5dsis_scale_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>did</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">logical, intent(out) </td> + <td class="paramname"><em>is_scale</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(out) </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Determines whether <code>did</code> is a Dimension Scale. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">did</td><td>The data set to query. </td></tr> + <tr><td class="paramname">is_scale</td><td>If is a Dimension Scale. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_d_s.html#ga06f897270fe32408f40bba69c747fc6b">H5DSis_scale()</a> </p> + +</div> +</div> +<a id="ga5e9d75d18f0300c6934106d90a5aca1a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5e9d75d18f0300c6934106d90a5aca1a">◆ </a></span>h5dsset_label_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5ds::h5dsset_label_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>did</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer, intent(in) </td> + <td class="paramname"><em>idx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in) </td> + <td class="paramname"><em>label</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set label for the dimension <code>idx</code> of <code>did</code> to the value <code>label</code>. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">did</td><td>The data set. </td></tr> + <tr><td class="paramname">idx</td><td>The dimension. </td></tr> + <tr><td class="paramname">label</td><td>The label. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails.</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_d_s.html#gaf3810cf2fde9e8d06d8151a879e081b2">H5DSset_label()</a> </p> + +</div> +</div> +<a id="gadd827eed1f551d9c6cb866f98cbc26c4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gadd827eed1f551d9c6cb866f98cbc26c4">◆ </a></span>h5dsset_scale_f()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">subroutine h5ds::h5dsset_scale_f </td> + <td>(</td> + <td class="paramtype">integer(<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>), intent(in) </td> + <td class="paramname"><em>dsid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">integer </td> + <td class="paramname"><em>errcode</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">character(len=*), intent(in), optional </td> + <td class="paramname"><em>dimname</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Convert dataset <code>dsid</code> to a dimension scale, with optional name, <code>dimname</code>. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">dsid</td><td>The dataset to be made a Dimemsion Scale. </td></tr> + <tr><td class="paramname">errcode</td><td>Returns 0 if successful and -1 if it fails. </td></tr> + <tr><td class="paramname">dimname</td><td>The dimension name</td></tr> + </table> + </dd> +</dl> +<p>See C API: <a class="el" href="group___h5_d_s.html#ga508a06962e9fc11dff32ed356e0a71fa">H5DSset_scale()</a> </p> + +</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="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + </ul> +</div> +</body> +</html> |