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___j_h5_s.html | |
| parent | 4e7e457497c948b41c8b0065225875bf10cdf9d4 (diff) | |
| download | hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.zip hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.gz hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.bz2 | |
deploy: ef39882fa1e13740d2530c7a0637bd1f1a822b68
Diffstat (limited to 'develop/group___j_h5_s.html')
| -rw-r--r-- | develop/group___j_h5_s.html | 2350 |
1 files changed, 2350 insertions, 0 deletions
diff --git a/develop/group___j_h5_s.html b/develop/group___j_h5_s.html new file mode 100644 index 0000000..7954dc3 --- /dev/null +++ b/develop/group___j_h5_s.html @@ -0,0 +1,2350 @@ +<!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: Java Dataspace (H5S) 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___j_h5_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</a> </div> + <div class="headertitle"> +<div class="title">Java Dataspace (H5S) 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_s.html">Dataspaces (H5S)</a>, C-API</dd> +<dd> +<a class="el" href="_h5_s__u_g.html">Dataspaces and Partial I/O</a>, User Guide </dd></dl> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:gac68bfe5d0d1908e068d3195cbce1a0c2"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gac68bfe5d0d1908e068d3195cbce1a0c2">H5Screate</a> (int type) throws HDF5LibraryException </td></tr> +<tr class="separator:gac68bfe5d0d1908e068d3195cbce1a0c2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac218f1e0de73b3030e9f6c3a9fd7aa76"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gac218f1e0de73b3030e9f6c3a9fd7aa76">H5Screate_simple</a> (int rank, long[] dims, long[] maxdims) throws HDF5Exception, NullPointerException </td></tr> +<tr class="separator:gac218f1e0de73b3030e9f6c3a9fd7aa76"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga62604840228dc27655a192cd5a300555"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga62604840228dc27655a192cd5a300555">H5Sset_extent_simple</a> (long space_id, int rank, long[] current_size, long[] maximum_size) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga62604840228dc27655a192cd5a300555"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaba1a98814211dbfdf4215bf9121a23a2"><td class="memItemLeft" align="right" valign="top">static synchronized long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gaba1a98814211dbfdf4215bf9121a23a2">H5Sset_extent_simple</a> (long space_id, int rank, byte[] current_size, byte[] maximum_size) throws HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gaba1a98814211dbfdf4215bf9121a23a2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac71b1379b6bb70b44922e77919982618"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gac71b1379b6bb70b44922e77919982618">H5Scopy</a> (long space_id) throws HDF5LibraryException </td></tr> +<tr class="separator:gac71b1379b6bb70b44922e77919982618"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga44b145f5c6977c082ac2c2dc121641fa"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga44b145f5c6977c082ac2c2dc121641fa">H5Sclose</a> (long space_id) throws HDF5LibraryException </td></tr> +<tr class="separator:ga44b145f5c6977c082ac2c2dc121641fa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0877556ae3005394df5b7ad92d04ff0c"><td class="memItemLeft" align="right" valign="top">static synchronized native byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga0877556ae3005394df5b7ad92d04ff0c">H5Sencode</a> (long obj_id) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga0877556ae3005394df5b7ad92d04ff0c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga59e8ee2d4af576d0583059e5b8c0daac"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga59e8ee2d4af576d0583059e5b8c0daac">H5Sdecode</a> (byte[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga59e8ee2d4af576d0583059e5b8c0daac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa28e8a692e81522c86bb333a8f4218c1"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gaa28e8a692e81522c86bb333a8f4218c1">H5Sget_simple_extent_npoints</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gaa28e8a692e81522c86bb333a8f4218c1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6f209df592e689994410a985e8e589d9"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga6f209df592e689994410a985e8e589d9">H5Sget_simple_extent_ndims</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga6f209df592e689994410a985e8e589d9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga614f8c7dd6efb4e19eaf72eb98c16bfa"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga614f8c7dd6efb4e19eaf72eb98c16bfa">H5Sget_simple_extent_dims</a> (long space_id, long[] dims, long[] maxdims) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga614f8c7dd6efb4e19eaf72eb98c16bfa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gae2f182e245b2671dcc663a950095ce6a"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gae2f182e245b2671dcc663a950095ce6a">H5Sis_simple</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gae2f182e245b2671dcc663a950095ce6a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac86a5a8512e2bb2d30fea4326c232e91"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gac86a5a8512e2bb2d30fea4326c232e91">H5Sget_simple_extent_type</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gac86a5a8512e2bb2d30fea4326c232e91"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga60e3c3978f0922e98d0570276f3d9d14"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga60e3c3978f0922e98d0570276f3d9d14">H5Sset_extent_none</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga60e3c3978f0922e98d0570276f3d9d14"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gada935bae1c757e30b622c763b0d37989"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gada935bae1c757e30b622c763b0d37989">H5Sextent_copy</a> (long dest_space_id, long source_space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gada935bae1c757e30b622c763b0d37989"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaad5717635c3436220a048dc708660229"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gaad5717635c3436220a048dc708660229">H5Sextent_equal</a> (long first_space_id, long second_space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gaad5717635c3436220a048dc708660229"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7c596592c53df4822bdbfbb136deb0a6"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga7c596592c53df4822bdbfbb136deb0a6">H5Sget_select_type</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga7c596592c53df4822bdbfbb136deb0a6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9a000ab27396eb7915eb4e80596a6568"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga9a000ab27396eb7915eb4e80596a6568">H5Sget_select_npoints</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga9a000ab27396eb7915eb4e80596a6568"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf60022ebf0dc60b2977487e6e65c36db"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gaf60022ebf0dc60b2977487e6e65c36db">H5Sselect_copy</a> (long dst_id, long src_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gaf60022ebf0dc60b2977487e6e65c36db"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0e952ca42ea362722bcbec0b2a449b44"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga0e952ca42ea362722bcbec0b2a449b44">H5Sselect_valid</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga0e952ca42ea362722bcbec0b2a449b44"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5665d54df4c44293dd69be370e8f0587"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga5665d54df4c44293dd69be370e8f0587">H5Sselect_adjust</a> (long space_id, long[][] offset) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga5665d54df4c44293dd69be370e8f0587"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0c33054801e3bfb81bfa54d6f221ca7d"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga0c33054801e3bfb81bfa54d6f221ca7d">H5Sget_select_bounds</a> (long space_id, long[] start, long[] end) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga0c33054801e3bfb81bfa54d6f221ca7d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga58b042bb96cb58ad68310a3ac33442f4"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga58b042bb96cb58ad68310a3ac33442f4">H5Sselect_shape_same</a> (long space1_id, long space2_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga58b042bb96cb58ad68310a3ac33442f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga692f21b8ac83bb691854b05d50cebd5f"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga692f21b8ac83bb691854b05d50cebd5f">H5Sselect_intersect_block</a> (long space_id, long[] start, long[] end) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga692f21b8ac83bb691854b05d50cebd5f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9d6693e01e9fa8ed222e7f249b509bce"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga9d6693e01e9fa8ed222e7f249b509bce">H5Soffset_simple</a> (long space_id, byte[] offset) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga9d6693e01e9fa8ed222e7f249b509bce"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5c565a466431f21a585346bf9e6ea60a"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga5c565a466431f21a585346bf9e6ea60a">H5Soffset_simple</a> (long space_id, long[] offset) throws HDF5Exception, NullPointerException </td></tr> +<tr class="separator:ga5c565a466431f21a585346bf9e6ea60a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga54bbdb68dc94192c2e81e30c3acc5c0f"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga54bbdb68dc94192c2e81e30c3acc5c0f">H5Sselect_all</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga54bbdb68dc94192c2e81e30c3acc5c0f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7ff426a847637ee4d76c35cadd3db2e7"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga7ff426a847637ee4d76c35cadd3db2e7">H5Sselect_none</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga7ff426a847637ee4d76c35cadd3db2e7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gacbe6a9818fe0027974c8b8d5be28f7b1"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gacbe6a9818fe0027974c8b8d5be28f7b1">H5Sselect_elements</a> (long space_id, int op, int num_elements, long[][] coord2D) throws HDF5Exception, HDF5LibraryException, NullPointerException </td></tr> +<tr class="separator:gacbe6a9818fe0027974c8b8d5be28f7b1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga82a4c4e96511d68c158d3c98c02e1047"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga82a4c4e96511d68c158d3c98c02e1047">H5Sget_select_elem_npoints</a> (long spaceid) throws HDF5LibraryException</td></tr> +<tr class="separator:ga82a4c4e96511d68c158d3c98c02e1047"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac857ca6a8d083e0a9193a2393f6ddf2e"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gac857ca6a8d083e0a9193a2393f6ddf2e">H5Sget_select_elem_pointlist</a> (long spaceid, long startpoint, long numpoints, long[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:gac857ca6a8d083e0a9193a2393f6ddf2e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga53b3c4e59745615f8820693e06b4e995"><td class="memItemLeft" align="right" valign="top">static synchronized int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga53b3c4e59745615f8820693e06b4e995">H5Sselect_hyperslab</a> (long space_id, int op, byte[] start, byte[] stride, byte[] count, byte[] block) throws HDF5LibraryException, NullPointerException, IllegalArgumentException </td></tr> +<tr class="separator:ga53b3c4e59745615f8820693e06b4e995"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf282f746c637aac32f13893a3d0d8a28"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gaf282f746c637aac32f13893a3d0d8a28">H5Sselect_hyperslab</a> (long space_id, int op, long[] start, long[] stride, long[] count, long[] block) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:gaf282f746c637aac32f13893a3d0d8a28"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2c791ebfb610b1e9ffb58c98b8fdd767"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga2c791ebfb610b1e9ffb58c98b8fdd767">H5Scombine_hyperslab</a> (long space_id, int op, long[] start, long[] stride, long[] count, long[] block) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:ga2c791ebfb610b1e9ffb58c98b8fdd767"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga814b2cb29fcdfe79892737f4337d0ef9"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga814b2cb29fcdfe79892737f4337d0ef9">H5Smodify_select</a> (long space1_id, int op, long space2_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga814b2cb29fcdfe79892737f4337d0ef9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga949ea42a300e23747d5e5d118edb4d6a"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga949ea42a300e23747d5e5d118edb4d6a">H5Scombine_select</a> (long space1_id, int op, long space2_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga949ea42a300e23747d5e5d118edb4d6a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga304768df8054389de063f5e31d39e5a6"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga304768df8054389de063f5e31d39e5a6">H5Sis_regular_hyperslab</a> (long space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:ga304768df8054389de063f5e31d39e5a6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0c1eba9dc9ce1a722cd04fbb55b2baa9"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga0c1eba9dc9ce1a722cd04fbb55b2baa9">H5Sget_regular_hyperslab</a> (long space_id, long[] start, long[] stride, long[] count, long[] block) throws HDF5LibraryException, NullPointerException, IllegalArgumentException</td></tr> +<tr class="separator:ga0c1eba9dc9ce1a722cd04fbb55b2baa9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab6049c2e10acc3f5d7a1757ec3ddf0ea"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gab6049c2e10acc3f5d7a1757ec3ddf0ea">H5Sget_select_hyper_nblocks</a> (long spaceid) throws HDF5LibraryException</td></tr> +<tr class="separator:gab6049c2e10acc3f5d7a1757ec3ddf0ea"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9eac2ae4f81d7c3707bb143303e7e8ca"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#ga9eac2ae4f81d7c3707bb143303e7e8ca">H5Sget_select_hyper_blocklist</a> (long spaceid, long startblock, long numblocks, long[] buf) throws HDF5LibraryException, NullPointerException</td></tr> +<tr class="separator:ga9eac2ae4f81d7c3707bb143303e7e8ca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac03a31452b876ba28a900a76780d02fd"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_s.html#gac03a31452b876ba28a900a76780d02fd">H5Sselect_project_intersection</a> (long src_space_id, long dst_space_id, long src_intersect_space_id) throws HDF5LibraryException</td></tr> +<tr class="separator:gac03a31452b876ba28a900a76780d02fd"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="ga44b145f5c6977c082ac2c2dc121641fa"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga44b145f5c6977c082ac2c2dc121641fa">◆ </a></span>H5Sclose()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static int H5Sclose </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sclose releases a dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>Identifier of dataspace to release.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga2c791ebfb610b1e9ffb58c98b8fdd767"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2c791ebfb610b1e9ffb58c98b8fdd767">◆ </a></span>H5Scombine_hyperslab()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Scombine_hyperslab </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>stride</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>count</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>block</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Scombine_hyperslab combines a hyperslab selection with the current selection for a dataspace, creating a new dataspace to return the generated selection. If the current selection is not a hyperslab, it is freed and the hyperslab parameters passed in are combined with the H5S_SEL_ALL hyperslab (ie. a selection composing the entire current extent). If STRIDE or BLOCK is NULL, they are assumed to be set to all '1'.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: Dataspace ID of selection to use </td></tr> + <tr><td class="paramname">op</td><td>IN: Operation to perform on current selection. </td></tr> + <tr><td class="paramname">start</td><td>IN: Offset of start of hyperslab </td></tr> + <tr><td class="paramname">stride</td><td>IN: Hyperslab stride. </td></tr> + <tr><td class="paramname">count</td><td>IN: Number of blocks included in hyperslab. </td></tr> + <tr><td class="paramname">block</td><td>IN: Size of block in hyperslab.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a dataspace ID on success / H5I_INVALID_HID on failure</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga949ea42a300e23747d5e5d118edb4d6a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga949ea42a300e23747d5e5d118edb4d6a">◆ </a></span>H5Scombine_select()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Scombine_select </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space1_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>space2_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Scombine_select combines two existing hyperslab selections with an operation, returning a new dataspace with the resulting selection. The dataspace extent from space1 is copied for the dataspace extent of the newly created dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space1_id</td><td>ID of the first dataspace </td></tr> + <tr><td class="paramname">op</td><td>Operation to perform on current selection. </td></tr> + <tr><td class="paramname">space2_id</td><td>ID of the second dataspace</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a dataspace ID on success / H5I_INVALID_HID on failure</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac71b1379b6bb70b44922e77919982618"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac71b1379b6bb70b44922e77919982618">◆ </a></span>H5Scopy()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Scopy </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Scopy creates a new dataspace which is an exact copy of the dataspace identified by space_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>Identifier of dataspace to copy. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a dataspace identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac68bfe5d0d1908e068d3195cbce1a0c2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac68bfe5d0d1908e068d3195cbce1a0c2">◆ </a></span>H5Screate()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Screate </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>type</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Screate creates a new dataspace of a particular type.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type</td><td>IN: The type of dataspace to be created.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a dataspace identifier</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac218f1e0de73b3030e9f6c3a9fd7aa76"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac218f1e0de73b3030e9f6c3a9fd7aa76">◆ </a></span>H5Screate_simple()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static long H5Screate_simple </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>rank</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>dims</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>maxdims</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_exception.html">HDF5Exception</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Screate_simple creates a new simple data space and opens it for access.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">rank</td><td>IN: Number of dimensions of dataspace. </td></tr> + <tr><td class="paramname">dims</td><td>IN: An array of the size of each dimension. </td></tr> + <tr><td class="paramname">maxdims</td><td>IN: An array of the maximum size of each dimension.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a dataspace identifier</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5Exception</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>dims or maxdims is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga59e8ee2d4af576d0583059e5b8c0daac"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga59e8ee2d4af576d0583059e5b8c0daac">◆ </a></span>H5Sdecode()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Sdecode </td> + <td>(</td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>buf</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sdecode reconstructs the HDF5 data space object and returns a new object handle for it.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">buf</td><td>IN: Buffer for the data space object to be decoded.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a new object handle</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>buf is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0877556ae3005394df5b7ad92d04ff0c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0877556ae3005394df5b7ad92d04ff0c">◆ </a></span>H5Sencode()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native byte [] H5Sencode </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sencode converts a data space description into binary form in a buffer.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">obj_id</td><td>IN: Identifier of the object to be encoded.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the buffer for the object to be encoded into.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gada935bae1c757e30b622c763b0d37989"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gada935bae1c757e30b622c763b0d37989">◆ </a></span>H5Sextent_copy()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sextent_copy </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>dest_space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>source_space_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sextent_copy copies the extent from source_space_id to dest_space_id. This action may change the type of the dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">dest_space_id</td><td>IN: The identifier for the dataspace from which the extent is copied. </td></tr> + <tr><td class="paramname">source_space_id</td><td>IN: The identifier for the dataspace to which the extent is copied.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaad5717635c3436220a048dc708660229"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaad5717635c3436220a048dc708660229">◆ </a></span>H5Sextent_equal()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Sextent_equal </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>first_space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>second_space_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sextent_equal determines whether the dataspace extents of two dataspaces, space1_id and space2_id, are equal.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">first_space_id</td><td>IN: The identifier for the first dataspace. </td></tr> + <tr><td class="paramname">second_space_id</td><td>IN: The identifier for the seconddataspace.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if successful, else false</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0c1eba9dc9ce1a722cd04fbb55b2baa9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0c1eba9dc9ce1a722cd04fbb55b2baa9">◆ </a></span>H5Sget_regular_hyperslab()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Sget_regular_hyperslab </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>stride</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>count</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>block</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_regular_hyperslab determines if a hyperslab selection is regular for the dataspace specified by space_id. The start, stride, count, and block arrays must be the same size as the rank of the dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: Identifier of dataspace selection to modify </td></tr> + <tr><td class="paramname">start</td><td>OUT: Offset of start of hyperslab </td></tr> + <tr><td class="paramname">stride</td><td>OUT: Hyperslab stride. </td></tr> + <tr><td class="paramname">count</td><td>OUT: Number of blocks included in hyperslab. </td></tr> + <tr><td class="paramname">block</td><td>OUT: Size of block in hyperslab.</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>an output array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an output array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0c33054801e3bfb81bfa54d6f221ca7d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0c33054801e3bfb81bfa54d6f221ca7d">◆ </a></span>H5Sget_select_bounds()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sget_select_bounds </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>end</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_select_bounds retrieves the coordinates of the bounding box containing the current selection and places them into user-supplied buffers. </p> +<p>The start and end buffers must be large enough to hold the dataspace rank number of coordinates.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>Identifier of dataspace to release. </td></tr> + <tr><td class="paramname">start</td><td>coordinates of lowest corner of bounding box. </td></tr> + <tr><td class="paramname">end</td><td>coordinates of highest corner of bounding box.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful,with start and end initialized.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>start or end is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga82a4c4e96511d68c158d3c98c02e1047"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga82a4c4e96511d68c158d3c98c02e1047">◆ </a></span>H5Sget_select_elem_npoints()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Sget_select_elem_npoints </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>spaceid</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_select_elem_npoints returns the number of element points in the current dataspace selection.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">spaceid</td><td>Identifier of dataspace to release.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac857ca6a8d083e0a9193a2393f6ddf2e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac857ca6a8d083e0a9193a2393f6ddf2e">◆ </a></span>H5Sget_select_elem_pointlist()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sget_select_elem_pointlist </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>spaceid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>startpoint</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>numpoints</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>buf</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_select_elem_pointlist returns an array of of element points in the current dataspace selection. The point coordinates have the same dimensionality (rank) as the dataspace they are located within, one coordinate per point.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">spaceid</td><td>Identifier of dataspace to release. </td></tr> + <tr><td class="paramname">startpoint</td><td>first point to retrieve </td></tr> + <tr><td class="paramname">numpoints</td><td>number of points to retrieve </td></tr> + <tr><td class="paramname">buf</td><td>returns points startblock to startblock+num-1, each points is <em>rank</em> longs.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>buf is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga9eac2ae4f81d7c3707bb143303e7e8ca"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9eac2ae4f81d7c3707bb143303e7e8ca">◆ </a></span>H5Sget_select_hyper_blocklist()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sget_select_hyper_blocklist </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>spaceid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>startblock</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>numblocks</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>buf</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_select_hyper_blocklist returns an array of hyperslab blocks. The block coordinates have the same dimensionality (rank) as the dataspace they are located within. The list of blocks is formatted as follows:</p> +<pre> + <"start" coordinate>, immediately followed by + <"opposite" corner coordinate>, followed by + the next "start" and "opposite" coordinates, + etc. + until all of the selected blocks have been listed. +</pre><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">spaceid</td><td>Identifier of dataspace to release. </td></tr> + <tr><td class="paramname">startblock</td><td>first block to retrieve </td></tr> + <tr><td class="paramname">numblocks</td><td>number of blocks to retrieve </td></tr> + <tr><td class="paramname">buf</td><td>returns blocks startblock to startblock+num-1, each block is <em>rank</em> * 2 (corners) longs.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>buf is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gab6049c2e10acc3f5d7a1757ec3ddf0ea"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gab6049c2e10acc3f5d7a1757ec3ddf0ea">◆ </a></span>H5Sget_select_hyper_nblocks()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Sget_select_hyper_nblocks </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>spaceid</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_select_hyper_nblocks returns the number of hyperslab blocks in the current dataspace selection.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">spaceid</td><td>Identifier of dataspace to release.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga9a000ab27396eb7915eb4e80596a6568"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9a000ab27396eb7915eb4e80596a6568">◆ </a></span>H5Sget_select_npoints()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Sget_select_npoints </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_select_npoints determines the number of elements in the current selection of a dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: Identifier of the dataspace object to query</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of elements in the selection if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga7c596592c53df4822bdbfbb136deb0a6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7c596592c53df4822bdbfbb136deb0a6">◆ </a></span>H5Sget_select_type()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sget_select_type </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_select_type retrieves the type of selection currently defined for the dataspace space_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: Identifier of the dataspace object to query</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the dataspace selection type if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga614f8c7dd6efb4e19eaf72eb98c16bfa"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga614f8c7dd6efb4e19eaf72eb98c16bfa">◆ </a></span>H5Sget_simple_extent_dims()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sget_simple_extent_dims </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>dims</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>maxdims</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_simple_extent_dims returns the size and maximum sizes of each dimension of a dataspace through the dims and maxdims parameters.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: Identifier of the dataspace object to query </td></tr> + <tr><td class="paramname">dims</td><td>OUT: Pointer to array to store the size of each dimension. </td></tr> + <tr><td class="paramname">maxdims</td><td>OUT: Pointer to array to store the maximum size of each dimension.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of dimensions in the dataspace if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>dims or maxdims is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga6f209df592e689994410a985e8e589d9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga6f209df592e689994410a985e8e589d9">◆ </a></span>H5Sget_simple_extent_ndims()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sget_simple_extent_ndims </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_simple_extent_ndims determines the dimensionality (or rank) of a dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: Identifier of the dataspace</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of dimensions in the dataspace if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaa28e8a692e81522c86bb333a8f4218c1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa28e8a692e81522c86bb333a8f4218c1">◆ </a></span>H5Sget_simple_extent_npoints()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Sget_simple_extent_npoints </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_simple_extent_npoints determines the number of elements in a dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>ID of the dataspace object to query</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>the number of elements in the dataspace if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac86a5a8512e2bb2d30fea4326c232e91"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac86a5a8512e2bb2d30fea4326c232e91">◆ </a></span>H5Sget_simple_extent_type()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sget_simple_extent_type </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sget_simple_extent_type queries a dataspace to determine the current class of a dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>Dataspace identifier.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a dataspace class name if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga304768df8054389de063f5e31d39e5a6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga304768df8054389de063f5e31d39e5a6">◆ </a></span>H5Sis_regular_hyperslab()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Sis_regular_hyperslab </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sis_regular_hyperslab retrieves a regular hyperslab selection for the dataspace specified by space_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: Identifier of dataspace selection to query</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a TRUE/FALSE for hyperslab selection if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gae2f182e245b2671dcc663a950095ce6a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gae2f182e245b2671dcc663a950095ce6a">◆ </a></span>H5Sis_simple()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Sis_simple </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sis_simple determines whether a dataspace is a simple dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>Identifier of the dataspace to query</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if is a simple dataspace</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga814b2cb29fcdfe79892737f4337d0ef9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga814b2cb29fcdfe79892737f4337d0ef9">◆ </a></span>H5Smodify_select()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Smodify_select </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space1_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>space2_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Smodify_select refine an existing hyperslab selection with an operation, using a second hyperslab. The first selection is modified to contain the result of space1 operated on by space2.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space1_id</td><td>ID of the destination dataspace </td></tr> + <tr><td class="paramname">op</td><td>Operation to perform on current selection. </td></tr> + <tr><td class="paramname">space2_id</td><td>ID of the source dataspace</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga9d6693e01e9fa8ed222e7f249b509bce"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9d6693e01e9fa8ed222e7f249b509bce">◆ </a></span>H5Soffset_simple() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Soffset_simple </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>offset</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Soffset_simple sets the offset of a simple dataspace space_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: The identifier for the dataspace object to reset. </td></tr> + <tr><td class="paramname">offset</td><td>IN: The offset at which to position the selection.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>offset array is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga5c565a466431f21a585346bf9e6ea60a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5c565a466431f21a585346bf9e6ea60a">◆ </a></span>H5Soffset_simple() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Soffset_simple </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>offset</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_exception.html">HDF5Exception</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Soffset_simple sets the offset of a simple dataspace space_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: The identifier for the dataspace object to reset. </td></tr> + <tr><td class="paramname">offset</td><td>IN: The offset at which to position the selection.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>offset array is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga5665d54df4c44293dd69be370e8f0587"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5665d54df4c44293dd69be370e8f0587">◆ </a></span>H5Sselect_adjust()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Sselect_adjust </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>offset</em>[][] </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_adjust moves a selection by subtracting an offset from it.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>ID of dataspace to adjust </td></tr> + <tr><td class="paramname">offset</td><td>Offset to subtract</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>offset is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga54bbdb68dc94192c2e81e30c3acc5c0f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga54bbdb68dc94192c2e81e30c3acc5c0f">◆ </a></span>H5Sselect_all()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sselect_all </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_all selects the entire extent of the dataspace space_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: The identifier of the dataspace to be selected.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaf60022ebf0dc60b2977487e6e65c36db"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf60022ebf0dc60b2977487e6e65c36db">◆ </a></span>H5Sselect_copy()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native void H5Sselect_copy </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>dst_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>src_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_copy copies all the selection information (including offset) from the source dataspace to the destination dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">dst_id</td><td>ID of the destination dataspace </td></tr> + <tr><td class="paramname">src_id</td><td>ID of the source dataspace</td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gacbe6a9818fe0027974c8b8d5be28f7b1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gacbe6a9818fe0027974c8b8d5be28f7b1">◆ </a></span>H5Sselect_elements()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Sselect_elements </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>num_elements</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>coord2D</em>[][] </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_exception.html">HDF5Exception</a>, <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_elements selects array elements to be included in the selection for the space_id dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>Identifier of the dataspace. </td></tr> + <tr><td class="paramname">op</td><td>operator specifying how the new selection is combined. </td></tr> + <tr><td class="paramname">num_elements</td><td>Number of elements to be selected. </td></tr> + <tr><td class="paramname">coord2D</td><td>A 2-dimensional array specifying the coordinates of the elements.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5Exception</td><td>Error in the data conversion </td></tr> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>cord array is </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga53b3c4e59745615f8820693e06b4e995"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga53b3c4e59745615f8820693e06b4e995">◆ </a></span>H5Sselect_hyperslab() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized int H5Sselect_hyperslab </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>stride</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>count</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>block</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_hyperslab selects a hyperslab region to add to the current selected region for the dataspace specified by space_id. The start, stride, count, and block arrays must be the same size as the rank of the dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: Identifier of dataspace selection to modify </td></tr> + <tr><td class="paramname">op</td><td>IN: Operation to perform on current selection. </td></tr> + <tr><td class="paramname">start</td><td>IN: Offset of start of hyperslab </td></tr> + <tr><td class="paramname">stride</td><td>IN: Hyperslab stride. </td></tr> + <tr><td class="paramname">count</td><td>IN: Number of blocks included in hyperslab. </td></tr> + <tr><td class="paramname">block</td><td>IN: Size of block in hyperslab.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaf282f746c637aac32f13893a3d0d8a28"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf282f746c637aac32f13893a3d0d8a28">◆ </a></span>H5Sselect_hyperslab() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sselect_hyperslab </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>stride</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>count</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>block</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_hyperslab selects a hyperslab region to add to the current selected region for the dataspace specified by space_id. The start, stride, count, and block arrays must be the same size as the rank of the dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: Identifier of dataspace selection to modify </td></tr> + <tr><td class="paramname">op</td><td>IN: Operation to perform on current selection. </td></tr> + <tr><td class="paramname">start</td><td>IN: Offset of start of hyperslab </td></tr> + <tr><td class="paramname">stride</td><td>IN: Hyperslab stride. </td></tr> + <tr><td class="paramname">count</td><td>IN: Number of blocks included in hyperslab. </td></tr> + <tr><td class="paramname">block</td><td>IN: Size of block in hyperslab.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>an input array is null. </td></tr> + <tr><td class="paramname">IllegalArgumentException</td><td>an input array is invalid. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga692f21b8ac83bb691854b05d50cebd5f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga692f21b8ac83bb691854b05d50cebd5f">◆ </a></span>H5Sselect_intersect_block()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Sselect_intersect_block </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>end</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_intersect_block checks to see if the current selection in the dataspace intersects with the block given.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>ID of dataspace pointer to compare </td></tr> + <tr><td class="paramname">start</td><td>Starting coordinate of block </td></tr> + <tr><td class="paramname">end</td><td>Opposite ("ending") coordinate of block</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a TRUE if the current selection in the dataspace intersects with the block given FALSE otherwise</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + <tr><td class="paramname">NullPointerException</td><td>offset is null. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga7ff426a847637ee4d76c35cadd3db2e7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7ff426a847637ee4d76c35cadd3db2e7">◆ </a></span>H5Sselect_none()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sselect_none </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_none resets the selection region for the dataspace space_id to include no elements.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>IN: The identifier of the dataspace to be reset.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gac03a31452b876ba28a900a76780d02fd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gac03a31452b876ba28a900a76780d02fd">◆ </a></span>H5Sselect_project_intersection()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Sselect_project_intersection </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>src_space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>dst_space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>src_intersect_space_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_project_intersection projects the intersection of the selections of src_space_id and src_intersect_space_id within the selection of src_space_id as a selection within the selection of dst_space_id.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">src_space_id</td><td>Selection that is mapped to dst_space_id, and intersected with src_intersect_space_id </td></tr> + <tr><td class="paramname">dst_space_id</td><td>Selection that is mapped to src_space_id </td></tr> + <tr><td class="paramname">src_intersect_space_id</td><td>Selection whose intersection with src_space_id is projected to dst_space_id to obtain the result</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a dataspace with a selection equal to the intersection of src_intersect_space_id and src_space_id projected from src_space to dst_space on success</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga58b042bb96cb58ad68310a3ac33442f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga58b042bb96cb58ad68310a3ac33442f4">◆ </a></span>H5Sselect_shape_same()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Sselect_shape_same </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space1_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long </td> + <td class="paramname"><em>space2_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_shape_same checks to see if the current selection in the dataspaces are the same dimensionality and shape. This is primarily used for reading the entire selection in one swoop.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space1_id</td><td>ID of 1st Dataspace pointer to compare </td></tr> + <tr><td class="paramname">space2_id</td><td>ID of 2nd Dataspace pointer to compare</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the selection is the same dimensionality and shape; false otherwise</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga0e952ca42ea362722bcbec0b2a449b44"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga0e952ca42ea362722bcbec0b2a449b44">◆ </a></span>H5Sselect_valid()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native boolean H5Sselect_valid </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sselect_valid verifies that the selection for the dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>The identifier for the dataspace in which the selection is being reset.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>true if the selection is contained within the extent and FALSE if it is not or is an error.</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga60e3c3978f0922e98d0570276f3d9d14"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga60e3c3978f0922e98d0570276f3d9d14">◆ </a></span>H5Sset_extent_none()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native int H5Sset_extent_none </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em></td><td>)</td> + <td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sset_extent_none removes the extent from a dataspace and sets the type to H5S_NONE.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>The identifier for the dataspace from which the extent is to be removed.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="gaba1a98814211dbfdf4215bf9121a23a2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaba1a98814211dbfdf4215bf9121a23a2">◆ </a></span>H5Sset_extent_simple() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized long H5Sset_extent_simple </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>rank</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>current_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">byte[] </td> + <td class="paramname"><em>maximum_size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sset_extent_simple sets or resets the size of an existing dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>Dataspace identifier. </td></tr> + <tr><td class="paramname">rank</td><td>Rank, or dimensionality, of the dataspace. </td></tr> + <tr><td class="paramname">current_size</td><td>Array containing current size of dataspace. </td></tr> + <tr><td class="paramname">maximum_size</td><td>Array containing maximum size of dataspace.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a dataspace identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ga62604840228dc27655a192cd5a300555"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga62604840228dc27655a192cd5a300555">◆ </a></span>H5Sset_extent_simple() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">static synchronized native long H5Sset_extent_simple </td> + <td>(</td> + <td class="paramtype">long </td> + <td class="paramname"><em>space_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>rank</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>current_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">long[] </td> + <td class="paramname"><em>maximum_size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>H5Sset_extent_simple sets or resets the size of an existing dataspace.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space_id</td><td>Dataspace identifier. </td></tr> + <tr><td class="paramname">rank</td><td>Rank, or dimensionality, of the dataspace. </td></tr> + <tr><td class="paramname">current_size</td><td>Array containing current size of dataspace. </td></tr> + <tr><td class="paramname">maximum_size</td><td>Array containing maximum size of dataspace.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>a dataspace identifier if successful</dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr> + </table> + </dd> +</dl> + +</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> |