diff options
Diffstat (limited to 'c++/src/cpplus_RM/class_h5_1_1_data_space.html')
-rw-r--r-- | c++/src/cpplus_RM/class_h5_1_1_data_space.html | 1253 |
1 files changed, 1253 insertions, 0 deletions
diff --git a/c++/src/cpplus_RM/class_h5_1_1_data_space.html b/c++/src/cpplus_RM/class_h5_1_1_data_space.html new file mode 100644 index 0000000..c1f1326 --- /dev/null +++ b/c++/src/cpplus_RM/class_h5_1_1_data_space.html @@ -0,0 +1,1253 @@ +<!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.8.5"/> +<title>HDF5 C++ API: H5::DataSpace Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectlogo"><img alt="Logo" src="hdf_logo.jpg"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">HDF5 C++ API +  <span id="projectnumber">1.8.13</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.5 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="examples.html"><span>Examples</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + 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.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</a></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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespace_h5.html">H5</a></li><li class="navelem"><a class="el" href="class_h5_1_1_data_space.html">DataSpace</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-attribs">Static Public Attributes</a> | +<a href="class_h5_1_1_data_space-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">H5::DataSpace Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Class <a class="el" href="class_h5_1_1_data_space.html" title="Class DataSpace operates on HDF5 dataspaces. ">DataSpace</a> operates on HDF5 dataspaces. + <a href="class_h5_1_1_data_space.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_h5_data_space_8h_source.html">H5DataSpace.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for H5::DataSpace:</div> +<div class="dyncontent"> + <div class="center"> + <img src="class_h5_1_1_data_space.png" usemap="#H5::DataSpace_map" alt=""/> + <map id="H5::DataSpace_map" name="H5::DataSpace_map"> +<area href="class_h5_1_1_id_component.html" title="Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier. " alt="H5::IdComponent" shape="rect" coords="0,0,107,24"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:ad56d9dd51af4ece3e7269404903bc4a9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#ad56d9dd51af4ece3e7269404903bc4a9">DataSpace</a> (H5S_class_t type=H5S_SCALAR)</td></tr> +<tr class="memdesc:ad56d9dd51af4ece3e7269404903bc4a9"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new dataspace given a dataspace type. <a href="#ad56d9dd51af4ece3e7269404903bc4a9">More...</a><br/></td></tr> +<tr class="separator:ad56d9dd51af4ece3e7269404903bc4a9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3147799b3cd1e741e591175e61785854"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a3147799b3cd1e741e591175e61785854">DataSpace</a> (int rank, const hsize_t *dims, const hsize_t *maxdims=NULL)</td></tr> +<tr class="memdesc:a3147799b3cd1e741e591175e61785854"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new simple dataspace. <a href="#a3147799b3cd1e741e591175e61785854">More...</a><br/></td></tr> +<tr class="separator:a3147799b3cd1e741e591175e61785854"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2ced8f3ed4668656d1a9b811e9cce9e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a2ced8f3ed4668656d1a9b811e9cce9e5">operator=</a> (const <a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> &rhs)</td></tr> +<tr class="memdesc:a2ced8f3ed4668656d1a9b811e9cce9e5"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a2ced8f3ed4668656d1a9b811e9cce9e5">More...</a><br/></td></tr> +<tr class="separator:a2ced8f3ed4668656d1a9b811e9cce9e5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac0b162ae2a09816c8e5499f02ec25f27"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#ac0b162ae2a09816c8e5499f02ec25f27">close</a> ()</td></tr> +<tr class="memdesc:ac0b162ae2a09816c8e5499f02ec25f27"><td class="mdescLeft"> </td><td class="mdescRight">Closes this dataspace. <a href="#ac0b162ae2a09816c8e5499f02ec25f27">More...</a><br/></td></tr> +<tr class="separator:ac0b162ae2a09816c8e5499f02ec25f27"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aec8ac009d4284d786c26e1f7a109e635"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#aec8ac009d4284d786c26e1f7a109e635">copy</a> (const <a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> &like_space)</td></tr> +<tr class="memdesc:aec8ac009d4284d786c26e1f7a109e635"><td class="mdescLeft"> </td><td class="mdescRight">Makes a copy of an existing dataspace. <a href="#aec8ac009d4284d786c26e1f7a109e635">More...</a><br/></td></tr> +<tr class="separator:aec8ac009d4284d786c26e1f7a109e635"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8e744978be229fa68c46db8eafe54e33"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a8e744978be229fa68c46db8eafe54e33">extentCopy</a> (const <a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> &dest_space) const </td></tr> +<tr class="memdesc:a8e744978be229fa68c46db8eafe54e33"><td class="mdescLeft"> </td><td class="mdescRight">Copies the extent of a dataspace. <a href="#a8e744978be229fa68c46db8eafe54e33">More...</a><br/></td></tr> +<tr class="separator:a8e744978be229fa68c46db8eafe54e33"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af1bafda4d3c9ac76bacb1cd5bcc12381"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#af1bafda4d3c9ac76bacb1cd5bcc12381">extentCopy</a> (<a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> &dest_space) const </td></tr> +<tr class="memdesc:af1bafda4d3c9ac76bacb1cd5bcc12381"><td class="mdescLeft"> </td><td class="mdescRight">This is an overloaded member function, kept for backward compatibility. It differs from the above function in that it misses const. This wrapper will be removed in future release. <a href="#af1bafda4d3c9ac76bacb1cd5bcc12381">More...</a><br/></td></tr> +<tr class="separator:af1bafda4d3c9ac76bacb1cd5bcc12381"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a14c83212d4bf9158c44edbc272b5e410"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a14c83212d4bf9158c44edbc272b5e410">getSelectBounds</a> (hsize_t *start, hsize_t *end) const </td></tr> +<tr class="memdesc:a14c83212d4bf9158c44edbc272b5e410"><td class="mdescLeft"> </td><td class="mdescRight">Gets the bounding box containing the current selection. <a href="#a14c83212d4bf9158c44edbc272b5e410">More...</a><br/></td></tr> +<tr class="separator:a14c83212d4bf9158c44edbc272b5e410"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa95e5ddeeb38aef326d4488d37f5a292"><td class="memItemLeft" align="right" valign="top">hssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#aa95e5ddeeb38aef326d4488d37f5a292">getSelectElemNpoints</a> () const </td></tr> +<tr class="memdesc:aa95e5ddeeb38aef326d4488d37f5a292"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of element points in the current selection. <a href="#aa95e5ddeeb38aef326d4488d37f5a292">More...</a><br/></td></tr> +<tr class="separator:aa95e5ddeeb38aef326d4488d37f5a292"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a73520e41e66080b38ee2eee16758b956"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a73520e41e66080b38ee2eee16758b956">getSelectElemPointlist</a> (hsize_t startpoint, hsize_t numpoints, hsize_t *buf) const </td></tr> +<tr class="memdesc:a73520e41e66080b38ee2eee16758b956"><td class="mdescLeft"> </td><td class="mdescRight">Gets the list of element points currently selected. <a href="#a73520e41e66080b38ee2eee16758b956">More...</a><br/></td></tr> +<tr class="separator:a73520e41e66080b38ee2eee16758b956"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3f2f5d44143e027757845e06d76fc2c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a3f2f5d44143e027757845e06d76fc2c2">getSelectHyperBlocklist</a> (hsize_t startblock, hsize_t numblocks, hsize_t *buf) const </td></tr> +<tr class="memdesc:a3f2f5d44143e027757845e06d76fc2c2"><td class="mdescLeft"> </td><td class="mdescRight">Gets the list of hyperslab blocks currently selected. <a href="#a3f2f5d44143e027757845e06d76fc2c2">More...</a><br/></td></tr> +<tr class="separator:a3f2f5d44143e027757845e06d76fc2c2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abe2ef7bf53cfd83312f7e8ec2cdfd10d"><td class="memItemLeft" align="right" valign="top">hssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#abe2ef7bf53cfd83312f7e8ec2cdfd10d">getSelectHyperNblocks</a> () const </td></tr> +<tr class="memdesc:abe2ef7bf53cfd83312f7e8ec2cdfd10d"><td class="mdescLeft"> </td><td class="mdescRight">Returns number of hyperslab blocks. <a href="#abe2ef7bf53cfd83312f7e8ec2cdfd10d">More...</a><br/></td></tr> +<tr class="separator:abe2ef7bf53cfd83312f7e8ec2cdfd10d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac3b7c26e8f66a8b4233c7086d2eef737"><td class="memItemLeft" align="right" valign="top">hssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#ac3b7c26e8f66a8b4233c7086d2eef737">getSelectNpoints</a> () const </td></tr> +<tr class="memdesc:ac3b7c26e8f66a8b4233c7086d2eef737"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of elements in a dataspace selection. <a href="#ac3b7c26e8f66a8b4233c7086d2eef737">More...</a><br/></td></tr> +<tr class="separator:ac3b7c26e8f66a8b4233c7086d2eef737"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a704e01abf0484f976eef02589e1ee3fd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a704e01abf0484f976eef02589e1ee3fd">getSimpleExtentDims</a> (hsize_t *dims, hsize_t *maxdims=NULL) const </td></tr> +<tr class="memdesc:a704e01abf0484f976eef02589e1ee3fd"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves dataspace dimension size and maximum size. <a href="#a704e01abf0484f976eef02589e1ee3fd">More...</a><br/></td></tr> +<tr class="separator:a704e01abf0484f976eef02589e1ee3fd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8c7a590a67ef1a69fe6f70877761b55a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a8c7a590a67ef1a69fe6f70877761b55a">getSimpleExtentNdims</a> () const </td></tr> +<tr class="memdesc:a8c7a590a67ef1a69fe6f70877761b55a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the dimensionality of a dataspace. <a href="#a8c7a590a67ef1a69fe6f70877761b55a">More...</a><br/></td></tr> +<tr class="separator:a8c7a590a67ef1a69fe6f70877761b55a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0512712c57c51d9a8fb689770da37a8c"><td class="memItemLeft" align="right" valign="top">hssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a0512712c57c51d9a8fb689770da37a8c">getSimpleExtentNpoints</a> () const </td></tr> +<tr class="memdesc:a0512712c57c51d9a8fb689770da37a8c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of elements in a dataspace. <a href="#a0512712c57c51d9a8fb689770da37a8c">More...</a><br/></td></tr> +<tr class="separator:a0512712c57c51d9a8fb689770da37a8c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8e39d913ca70c4a5886eb2d256118eec"><td class="memItemLeft" align="right" valign="top">H5S_class_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a8e39d913ca70c4a5886eb2d256118eec">getSimpleExtentType</a> () const </td></tr> +<tr class="memdesc:a8e39d913ca70c4a5886eb2d256118eec"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current class of a dataspace. <a href="#a8e39d913ca70c4a5886eb2d256118eec">More...</a><br/></td></tr> +<tr class="separator:a8e39d913ca70c4a5886eb2d256118eec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a84fc9654f5c18b0fcb0d7ee7c10c7c35"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a84fc9654f5c18b0fcb0d7ee7c10c7c35">isSimple</a> () const </td></tr> +<tr class="memdesc:a84fc9654f5c18b0fcb0d7ee7c10c7c35"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether this dataspace is a simple dataspace. <a href="#a84fc9654f5c18b0fcb0d7ee7c10c7c35">More...</a><br/></td></tr> +<tr class="separator:a84fc9654f5c18b0fcb0d7ee7c10c7c35"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1977cf076ff136781f01e7501c9615c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a1977cf076ff136781f01e7501c9615c2">offsetSimple</a> (const hssize_t *offset) const </td></tr> +<tr class="memdesc:a1977cf076ff136781f01e7501c9615c2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the offset of this simple dataspace. <a href="#a1977cf076ff136781f01e7501c9615c2">More...</a><br/></td></tr> +<tr class="separator:a1977cf076ff136781f01e7501c9615c2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ace0f92a7cf6554462c6c4b4105d22cff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#ace0f92a7cf6554462c6c4b4105d22cff">selectAll</a> () const </td></tr> +<tr class="memdesc:ace0f92a7cf6554462c6c4b4105d22cff"><td class="mdescLeft"> </td><td class="mdescRight">Selects the entire dataspace. <a href="#ace0f92a7cf6554462c6c4b4105d22cff">More...</a><br/></td></tr> +<tr class="separator:ace0f92a7cf6554462c6c4b4105d22cff"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8b2bd5295ea459d229de280172616a0b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a8b2bd5295ea459d229de280172616a0b">selectElements</a> (H5S_seloper_t op, const size_t num_elements, const hsize_t *coord) const </td></tr> +<tr class="memdesc:a8b2bd5295ea459d229de280172616a0b"><td class="mdescLeft"> </td><td class="mdescRight">Selects array elements to be included in the selection for this dataspace. <a href="#a8b2bd5295ea459d229de280172616a0b">More...</a><br/></td></tr> +<tr class="separator:a8b2bd5295ea459d229de280172616a0b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a92bd510d1c06ebef292faeff73f40c12"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a92bd510d1c06ebef292faeff73f40c12">selectHyperslab</a> (H5S_seloper_t op, const hsize_t *count, const hsize_t *start, const hsize_t *stride=NULL, const hsize_t *block=NULL) const </td></tr> +<tr class="memdesc:a92bd510d1c06ebef292faeff73f40c12"><td class="mdescLeft"> </td><td class="mdescRight">Selects a hyperslab region to add to the current selected region. <a href="#a92bd510d1c06ebef292faeff73f40c12">More...</a><br/></td></tr> +<tr class="separator:a92bd510d1c06ebef292faeff73f40c12"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2817049bbb949258412f85b3c6db89ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a2817049bbb949258412f85b3c6db89ec">selectNone</a> () const </td></tr> +<tr class="memdesc:a2817049bbb949258412f85b3c6db89ec"><td class="mdescLeft"> </td><td class="mdescRight">Resets the selection region to include no elements. <a href="#a2817049bbb949258412f85b3c6db89ec">More...</a><br/></td></tr> +<tr class="separator:a2817049bbb949258412f85b3c6db89ec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a60cb10767095d693ce9677b6979e5689"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a60cb10767095d693ce9677b6979e5689">selectValid</a> () const </td></tr> +<tr class="memdesc:a60cb10767095d693ce9677b6979e5689"><td class="mdescLeft"> </td><td class="mdescRight">Verifies that the selection is within the extent of the dataspace. <a href="#a60cb10767095d693ce9677b6979e5689">More...</a><br/></td></tr> +<tr class="separator:a60cb10767095d693ce9677b6979e5689"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a468766b38d3f32ab966e22e5d2a96e4f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a468766b38d3f32ab966e22e5d2a96e4f">setExtentNone</a> () const </td></tr> +<tr class="memdesc:a468766b38d3f32ab966e22e5d2a96e4f"><td class="mdescLeft"> </td><td class="mdescRight">Removes the extent from a dataspace. <a href="#a468766b38d3f32ab966e22e5d2a96e4f">More...</a><br/></td></tr> +<tr class="separator:a468766b38d3f32ab966e22e5d2a96e4f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3dd7d1422ba85fe3dc7979abd9db39b3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a3dd7d1422ba85fe3dc7979abd9db39b3">setExtentSimple</a> (int rank, const hsize_t *current_size, const hsize_t *maximum_size=NULL) const </td></tr> +<tr class="memdesc:a3dd7d1422ba85fe3dc7979abd9db39b3"><td class="mdescLeft"> </td><td class="mdescRight">Sets or resets the size of an existing dataspace. <a href="#a3dd7d1422ba85fe3dc7979abd9db39b3">More...</a><br/></td></tr> +<tr class="separator:a3dd7d1422ba85fe3dc7979abd9db39b3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a357736f9ba3cb023f6715e520a10ef5d"><td class="memItemLeft" align="right" valign="top">virtual H5std_string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a357736f9ba3cb023f6715e520a10ef5d">fromClass</a> () const </td></tr> +<tr class="memdesc:a357736f9ba3cb023f6715e520a10ef5d"><td class="mdescLeft"> </td><td class="mdescRight">Returns this class name. <a href="#a357736f9ba3cb023f6715e520a10ef5d">More...</a><br/></td></tr> +<tr class="separator:a357736f9ba3cb023f6715e520a10ef5d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab62bedbc7e8ced6a2adf71dbc7d143f7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#ab62bedbc7e8ced6a2adf71dbc7d143f7">DataSpace</a> (const hid_t space_id)</td></tr> +<tr class="memdesc:ab62bedbc7e8ced6a2adf71dbc7d143f7"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="class_h5_1_1_data_space.html" title="Class DataSpace operates on HDF5 dataspaces. ">DataSpace</a> object using the id of an existing dataspace. <a href="#ab62bedbc7e8ced6a2adf71dbc7d143f7">More...</a><br/></td></tr> +<tr class="separator:ab62bedbc7e8ced6a2adf71dbc7d143f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a55be5c95c111878a78889697848c14cd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#a55be5c95c111878a78889697848c14cd">DataSpace</a> (const <a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> &original)</td></tr> +<tr class="memdesc:a55be5c95c111878a78889697848c14cd"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor: makes a copy of the original <a class="el" href="class_h5_1_1_data_space.html" title="Class DataSpace operates on HDF5 dataspaces. ">DataSpace</a> object. <a href="#a55be5c95c111878a78889697848c14cd">More...</a><br/></td></tr> +<tr class="separator:a55be5c95c111878a78889697848c14cd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaefbf468ec1d8e46b9116552f0524ef9"><td class="memItemLeft" align="right" valign="top">virtual hid_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#aaefbf468ec1d8e46b9116552f0524ef9">getId</a> () const </td></tr> +<tr class="memdesc:aaefbf468ec1d8e46b9116552f0524ef9"><td class="mdescLeft"> </td><td class="mdescRight">Get the id of this dataspace. <a href="#aaefbf468ec1d8e46b9116552f0524ef9">More...</a><br/></td></tr> +<tr class="separator:aaefbf468ec1d8e46b9116552f0524ef9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af9884abc481a0bb4c6161f9731bc3ee1"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#af9884abc481a0bb4c6161f9731bc3ee1">~DataSpace</a> ()</td></tr> +<tr class="memdesc:af9884abc481a0bb4c6161f9731bc3ee1"><td class="mdescLeft"> </td><td class="mdescRight">Properly terminates access to this dataspace. <a href="#af9884abc481a0bb4c6161f9731bc3ee1">More...</a><br/></td></tr> +<tr class="separator:af9884abc481a0bb4c6161f9731bc3ee1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_class_h5_1_1_id_component"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_h5_1_1_id_component')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_h5_1_1_id_component.html">H5::IdComponent</a></td></tr> +<tr class="memitem:a0e75b2e591d2fccd9e4c291a485d4754 inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#a0e75b2e591d2fccd9e4c291a485d4754">incRefCount</a> (const hid_t obj_id) const </td></tr> +<tr class="memdesc:a0e75b2e591d2fccd9e4c291a485d4754 inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Increment reference counter for a given id. <a href="#a0e75b2e591d2fccd9e4c291a485d4754">More...</a><br/></td></tr> +<tr class="separator:a0e75b2e591d2fccd9e4c291a485d4754 inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1b34f54d2fd41d885e8ced7613d6abd1 inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#a1b34f54d2fd41d885e8ced7613d6abd1">incRefCount</a> () const </td></tr> +<tr class="memdesc:a1b34f54d2fd41d885e8ced7613d6abd1 inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Increment reference counter for the id of this object. <a href="#a1b34f54d2fd41d885e8ced7613d6abd1">More...</a><br/></td></tr> +<tr class="separator:a1b34f54d2fd41d885e8ced7613d6abd1 inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9dc2815e9887d0adb5d5bba72adbd0d6 inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#a9dc2815e9887d0adb5d5bba72adbd0d6">decRefCount</a> (const hid_t obj_id) const </td></tr> +<tr class="memdesc:a9dc2815e9887d0adb5d5bba72adbd0d6 inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Decrement reference counter for a given id. <a href="#a9dc2815e9887d0adb5d5bba72adbd0d6">More...</a><br/></td></tr> +<tr class="separator:a9dc2815e9887d0adb5d5bba72adbd0d6 inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac15a341319624c9199a309fad56858e0 inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#ac15a341319624c9199a309fad56858e0">decRefCount</a> () const </td></tr> +<tr class="memdesc:ac15a341319624c9199a309fad56858e0 inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Decrement reference counter for the id of this object. <a href="#ac15a341319624c9199a309fad56858e0">More...</a><br/></td></tr> +<tr class="separator:ac15a341319624c9199a309fad56858e0 inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab2ba7509cb5beb8c80e242d7afe10a3c inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#ab2ba7509cb5beb8c80e242d7afe10a3c">getCounter</a> (const hid_t obj_id) const </td></tr> +<tr class="memdesc:ab2ba7509cb5beb8c80e242d7afe10a3c inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Returns the reference counter for a given id. <a href="#ab2ba7509cb5beb8c80e242d7afe10a3c">More...</a><br/></td></tr> +<tr class="separator:ab2ba7509cb5beb8c80e242d7afe10a3c inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adde1c48166476e089635bb40a2113653 inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#adde1c48166476e089635bb40a2113653">getCounter</a> () const </td></tr> +<tr class="memdesc:adde1c48166476e089635bb40a2113653 inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Returns the reference counter for the id of this object. <a href="#adde1c48166476e089635bb40a2113653">More...</a><br/></td></tr> +<tr class="separator:adde1c48166476e089635bb40a2113653 inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abef6d67a39f8723aa81bd16392dfc6bf inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top">H5I_type_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#abef6d67a39f8723aa81bd16392dfc6bf">getHDFObjType</a> () const </td></tr> +<tr class="memdesc:abef6d67a39f8723aa81bd16392dfc6bf inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of the object. It is an overloaded function of the above function. <a href="#abef6d67a39f8723aa81bd16392dfc6bf">More...</a><br/></td></tr> +<tr class="separator:abef6d67a39f8723aa81bd16392dfc6bf inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a34ac09a54825253293a0d8990e120506 inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_h5_1_1_id_component.html">IdComponent</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#a34ac09a54825253293a0d8990e120506">operator=</a> (const <a class="el" href="class_h5_1_1_id_component.html">IdComponent</a> &rhs)</td></tr> +<tr class="memdesc:a34ac09a54825253293a0d8990e120506 inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a34ac09a54825253293a0d8990e120506">More...</a><br/></td></tr> +<tr class="separator:a34ac09a54825253293a0d8990e120506 inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1e46d85ec29cd77bb1767cd01b8f0c8d inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#a1e46d85ec29cd77bb1767cd01b8f0c8d">setId</a> (const hid_t new_id)</td></tr> +<tr class="memdesc:a1e46d85ec29cd77bb1767cd01b8f0c8d inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Sets the identifier of this object to a new value. <a href="#a1e46d85ec29cd77bb1767cd01b8f0c8d">More...</a><br/></td></tr> +<tr class="separator:a1e46d85ec29cd77bb1767cd01b8f0c8d inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a013a42f5fd29d35d9428c1be8638acfe inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#a013a42f5fd29d35d9428c1be8638acfe">IdComponent</a> (const hid_t h5_id)</td></tr> +<tr class="memdesc:a013a42f5fd29d35d9428c1be8638acfe inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="class_h5_1_1_id_component.html" title="Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier. ">IdComponent</a> object using the id of an existing object. <a href="#a013a42f5fd29d35d9428c1be8638acfe">More...</a><br/></td></tr> +<tr class="separator:a013a42f5fd29d35d9428c1be8638acfe inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1c1e2479afec6ce26734225b434752fb inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#a1c1e2479afec6ce26734225b434752fb">IdComponent</a> (const <a class="el" href="class_h5_1_1_id_component.html">IdComponent</a> &original)</td></tr> +<tr class="memdesc:a1c1e2479afec6ce26734225b434752fb inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor: makes a copy of the original <a class="el" href="class_h5_1_1_id_component.html" title="Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier. ">IdComponent</a> object. <a href="#a1c1e2479afec6ce26734225b434752fb">More...</a><br/></td></tr> +<tr class="separator:a1c1e2479afec6ce26734225b434752fb inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a780d19c3d86037de38511f3e6cec3ca6 inherit pub_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#a780d19c3d86037de38511f3e6cec3ca6">~IdComponent</a> ()</td></tr> +<tr class="memdesc:a780d19c3d86037de38511f3e6cec3ca6 inherit pub_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Noop destructor. <a href="#a780d19c3d86037de38511f3e6cec3ca6">More...</a><br/></td></tr> +<tr class="separator:a780d19c3d86037de38511f3e6cec3ca6 inherit pub_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> +Static Public Attributes</h2></td></tr> +<tr class="memitem:af19fb72eae0855e07830c6d9a6f4748d"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_data_space.html#af19fb72eae0855e07830c6d9a6f4748d">ALL</a></td></tr> +<tr class="memdesc:af19fb72eae0855e07830c6d9a6f4748d"><td class="mdescLeft"> </td><td class="mdescRight">Constant for default dataspace. <a href="#af19fb72eae0855e07830c6d9a6f4748d">More...</a><br/></td></tr> +<tr class="separator:af19fb72eae0855e07830c6d9a6f4748d"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pub_static_methods_class_h5_1_1_id_component"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_h5_1_1_id_component')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_h5_1_1_id_component.html">H5::IdComponent</a></td></tr> +<tr class="memitem:a25e4d590aa5cc0fc87ced46718d5b0d7 inherit pub_static_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top">static H5I_type_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#a25e4d590aa5cc0fc87ced46718d5b0d7">getHDFObjType</a> (const hid_t obj_id)</td></tr> +<tr class="memdesc:a25e4d590aa5cc0fc87ced46718d5b0d7 inherit pub_static_methods_class_h5_1_1_id_component"><td class="mdescLeft"> </td><td class="mdescRight">Given an id, returns the type of the object. <a href="#a25e4d590aa5cc0fc87ced46718d5b0d7">More...</a><br/></td></tr> +<tr class="separator:a25e4d590aa5cc0fc87ced46718d5b0d7 inherit pub_static_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pro_methods_class_h5_1_1_id_component"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_h5_1_1_id_component')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_h5_1_1_id_component.html">H5::IdComponent</a></td></tr> +<tr class="memitem:a5545dda5e4c610b6bd9cdffe670c8728 inherit pro_methods_class_h5_1_1_id_component"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h5_1_1_id_component.html#a5545dda5e4c610b6bd9cdffe670c8728">IdComponent</a> ()</td></tr> +<tr class="separator:a5545dda5e4c610b6bd9cdffe670c8728 inherit pro_methods_class_h5_1_1_id_component"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><dl><dt><b>Examples: </b></dt><dd><a class="el" href="chunks_8cpp-example.html#_a3">chunks.cpp</a>, <a class="el" href="compound_8cpp-example.html#_a1">compound.cpp</a>, <a class="el" href="create_8cpp-example.html#_a2">create.cpp</a>, <a class="el" href="extend_ds_8cpp-example.html#_a1">extend_ds.cpp</a>, <a class="el" href="h5group_8cpp-example.html#_a4">h5group.cpp</a>, <a class="el" href="readdata_8cpp-example.html#_a8">readdata.cpp</a>, and <a class="el" href="writedata_8cpp-example.html#_a5">writedata.cpp</a>.</dd> +</dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="ad56d9dd51af4ece3e7269404903bc4a9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5::DataSpace::DataSpace </td> + <td>(</td> + <td class="paramtype">H5S_class_t </td> + <td class="paramname"><em>type</em> = <code>H5S_SCALAR</code></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type</td><td>- IN: Type of the dataspace to be created, which currently can be either <code>H5S_SCALAR</code> or <code>H5S_SIMPLE</code>; default to <code>H5S_SCALAR</code>. </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a3147799b3cd1e741e591175e61785854"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5::DataSpace::DataSpace </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">const hsize_t * </td> + <td class="paramname"><em>dims</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const hsize_t * </td> + <td class="paramname"><em>maxdims</em> = <code>NULL</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<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="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ab62bedbc7e8ced6a2adf71dbc7d143f7"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5::DataSpace::DataSpace </td> + <td>(</td> + <td class="paramtype">const hid_t </td> + <td class="paramname"><em>existing_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">existing_id</td><td>- IN: Id of an existing dataspace </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a55be5c95c111878a78889697848c14cd"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5::DataSpace::DataSpace </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> & </td> + <td class="paramname"><em>original</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">original</td><td>- IN: <a class="el" href="class_h5_1_1_data_space.html" title="Class DataSpace operates on HDF5 dataspaces. ">DataSpace</a> object to copy </td></tr> + </table> + </dd> +</dl> + +<p>References <a class="el" href="class_h5_1_1_data_space.html#aaefbf468ec1d8e46b9116552f0524ef9">getId()</a>, and <a class="el" href="class_h5_1_1_id_component.html#a1b34f54d2fd41d885e8ced7613d6abd1">H5::IdComponent::incRefCount()</a>.</p> + +</div> +</div> +<a class="anchor" id="af9884abc481a0bb4c6161f9731bc3ee1"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">H5::DataSpace::~DataSpace </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>References <a class="el" href="class_h5_1_1_data_space.html#ac0b162ae2a09816c8e5499f02ec25f27">close()</a>, and <a class="el" href="class_h5_1_1_exception.html#aedc9690b2b1a12e0fab36962d4479508">H5::Exception::getDetailMsg()</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="ac0b162ae2a09816c8e5499f02ec25f27"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::close </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +<p>Referenced by <a class="el" href="class_h5_1_1_data_space.html#aec8ac009d4284d786c26e1f7a109e635">copy()</a>, and <a class="el" href="class_h5_1_1_data_space.html#af9884abc481a0bb4c6161f9731bc3ee1">~DataSpace()</a>.</p> + +</div> +</div> +<a class="anchor" id="aec8ac009d4284d786c26e1f7a109e635"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::copy </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> & </td> + <td class="paramname"><em>like_space</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">like_space</td><td>- IN: Dataspace to be copied </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +<p>References <a class="el" href="class_h5_1_1_data_space.html#ac0b162ae2a09816c8e5499f02ec25f27">close()</a>, <a class="el" href="class_h5_1_1_exception.html#aedc9690b2b1a12e0fab36962d4479508">H5::Exception::getDetailMsg()</a>, and <a class="el" href="class_h5_1_1_data_space.html#aaefbf468ec1d8e46b9116552f0524ef9">getId()</a>.</p> + +<p>Referenced by <a class="el" href="class_h5_1_1_data_space.html#a2ced8f3ed4668656d1a9b811e9cce9e5">operator=()</a>.</p> + +</div> +</div> +<a class="anchor" id="a8e744978be229fa68c46db8eafe54e33"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::extentCopy </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> & </td> + <td class="paramname"><em>dest_space</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">dest_space</td><td>- IN: Dataspace to copy from </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +<p>References <a class="el" href="class_h5_1_1_data_space.html#aaefbf468ec1d8e46b9116552f0524ef9">getId()</a>.</p> + +<p>Referenced by <a class="el" href="class_h5_1_1_data_space.html#af1bafda4d3c9ac76bacb1cd5bcc12381">extentCopy()</a>.</p> + +</div> +</div> +<a class="anchor" id="af1bafda4d3c9ac76bacb1cd5bcc12381"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::extentCopy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> & </td> + <td class="paramname"><em>dest_space</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">dest_space</td><td>- IN: Dataspace to copy from </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +<p>References <a class="el" href="class_h5_1_1_data_space.html#a8e744978be229fa68c46db8eafe54e33">extentCopy()</a>.</p> + +</div> +</div> +<a class="anchor" id="a357736f9ba3cb023f6715e520a10ef5d"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual H5std_string H5::DataSpace::fromClass </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="aaefbf468ec1d8e46b9116552f0524ef9"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">hid_t H5::DataSpace::getId </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Dataspace identifier </dd></dl> + +<p>Referenced by <a class="el" href="class_h5_1_1_data_space.html#aec8ac009d4284d786c26e1f7a109e635">copy()</a>, <a class="el" href="class_h5_1_1_h5_location.html#a624715e413bc019345cd596db745094a">H5::H5Location::createAttribute()</a>, <a class="el" href="class_h5_1_1_common_f_g.html#a12a4af21ca0231d4f2c4008b12177bb1">H5::CommonFG::createDataSet()</a>, <a class="el" href="class_h5_1_1_data_space.html#a55be5c95c111878a78889697848c14cd">DataSpace()</a>, <a class="el" href="class_h5_1_1_data_space.html#a8e744978be229fa68c46db8eafe54e33">extentCopy()</a>, <a class="el" href="class_h5_1_1_data_set.html#a024eeee05222c411bbe7027702dfc3c3">H5::DataSet::fillMemBuf()</a>, <a class="el" href="class_h5_1_1_data_set.html#a46c4d637e0a5f9993702190f7b3ab308">H5::DataSet::getVlenBufSize()</a>, <a class="el" href="class_h5_1_1_data_set.html#a23b1e511f401e1dca147d224a6240d96">H5::DataSet::iterateElems()</a>, <a class="el" href="class_h5_1_1_data_set.html#a2f0278a519122419ae9981666277c9bb">H5::DataSet::read()</a>, <a class="el" href="class_h5_1_1_h5_location.html#a6928514c43d4c0debf1afd7511f28511">H5::H5Location::reference()</a>, <a class="el" href="class_h5_1_1_data_set.html#a4e76899f034982233893d98a994e1020">H5::DataSet::vlenReclaim()</a>, and <a class="el" href="class_h5_1_1_data_set.html#a3ce98e7a626fd32a23d1bcc41537326f">H5::DataSet::write()</a>.</p> + +</div> +</div> +<a class="anchor" id="a14c83212d4bf9158c44edbc272b5e410"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::getSelectBounds </td> + <td>(</td> + <td class="paramtype">hsize_t * </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">hsize_t * </td> + <td class="paramname"><em>end</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">start</td><td>- IN: Starting coordinates of the bounding box </td></tr> + <tr><td class="paramname">end</td><td>- IN: Ending coordinates of the bounding box, i.e., the coordinates of the diagonally opposite corner </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section user"><dt>Description</dt><dd>For more information, please refer to the C layer Reference Manual at: <a href="http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectBounds">http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectBounds</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="aa95e5ddeeb38aef326d4488d37f5a292"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">hssize_t H5::DataSpace::getSelectElemNpoints </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Number of element points </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a73520e41e66080b38ee2eee16758b956"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::getSelectElemPointlist </td> + <td>(</td> + <td class="paramtype">hsize_t </td> + <td class="paramname"><em>startpoint</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">hsize_t </td> + <td class="paramname"><em>numpoints</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">hsize_t * </td> + <td class="paramname"><em>buf</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">startpoint</td><td>- IN: Element point to start with </td></tr> + <tr><td class="paramname">numpoints</td><td>- IN: Number of element points to get </td></tr> + <tr><td class="paramname">buf</td><td>- IN: List of element points selected </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section user"><dt>Description</dt><dd>For more information, please refer to the C layer Reference Manual at: <a href="http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElemPointList">http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElemPointList</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="a3f2f5d44143e027757845e06d76fc2c2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::getSelectHyperBlocklist </td> + <td>(</td> + <td class="paramtype">hsize_t </td> + <td class="paramname"><em>startblock</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">hsize_t </td> + <td class="paramname"><em>numblocks</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">hsize_t * </td> + <td class="paramname"><em>buf</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">startblock</td><td>- IN: Hyperslab block to start with </td></tr> + <tr><td class="paramname">numblocks</td><td>- IN: Number of hyperslab blocks to get </td></tr> + <tr><td class="paramname">buf</td><td>- IN: List of hyperslab blocks selected </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="abe2ef7bf53cfd83312f7e8ec2cdfd10d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">hssize_t H5::DataSpace::getSelectHyperNblocks </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Number of hyperslab blocks </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="ac3b7c26e8f66a8b4233c7086d2eef737"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">hssize_t H5::DataSpace::getSelectNpoints </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Number of elements </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a704e01abf0484f976eef02589e1ee3fd"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int H5::DataSpace::getSimpleExtentDims </td> + <td>(</td> + <td class="paramtype">hsize_t * </td> + <td class="paramname"><em>dims</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">hsize_t * </td> + <td class="paramname"><em>maxdims</em> = <code>NULL</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">dims</td><td>- IN: Name of the new member </td></tr> + <tr><td class="paramname">maxdims</td><td>- IN: Pointer to the value of the new member </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Number of dimensions, the same value as returned by <code><a class="el" href="class_h5_1_1_data_space.html#a8c7a590a67ef1a69fe6f70877761b55a" title="Returns the dimensionality of a dataspace. ">DataSpace::getSimpleExtentNdims()</a></code> </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="chunks_8cpp-example.html#a6">chunks.cpp</a>, and <a class="el" href="readdata_8cpp-example.html#a11">readdata.cpp</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a8c7a590a67ef1a69fe6f70877761b55a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int H5::DataSpace::getSimpleExtentNdims </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Number of dimensions </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="chunks_8cpp-example.html#a5">chunks.cpp</a>, and <a class="el" href="readdata_8cpp-example.html#a10">readdata.cpp</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a0512712c57c51d9a8fb689770da37a8c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">hssize_t H5::DataSpace::getSimpleExtentNpoints </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Number of elements </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a8e39d913ca70c4a5886eb2d256118eec"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5S_class_t H5::DataSpace::getSimpleExtentType </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Class of the dataspace </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a84fc9654f5c18b0fcb0d7ee7c10c7c35"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool H5::DataSpace::isSimple </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the dataspace is a simple dataspace, and <code>false</code>, otherwise </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a1977cf076ff136781f01e7501c9615c2"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::offsetSimple </td> + <td>(</td> + <td class="paramtype">const hssize_t * </td> + <td class="paramname"><em>offset</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">offset</td><td>- IN: Offset to position the selection at </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section user"><dt>Description</dt><dd>This function creates an offset for the selection within an extent, allowing the same shaped selection to be moved to different locations within a dataspace without requiring it to be re-defined. </dd></dl> + +</div> +</div> +<a class="anchor" id="a2ced8f3ed4668656d1a9b811e9cce9e5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> & H5::DataSpace::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> & </td> + <td class="paramname"><em>rhs</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">rhs</td><td>- IN: Reference to the existing dataspace </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Reference to <a class="el" href="class_h5_1_1_data_space.html" title="Class DataSpace operates on HDF5 dataspaces. ">DataSpace</a> instance </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +<p>References <a class="el" href="class_h5_1_1_data_space.html#aec8ac009d4284d786c26e1f7a109e635">copy()</a>.</p> + +</div> +</div> +<a class="anchor" id="ace0f92a7cf6554462c6c4b4105d22cff"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::selectAll </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a8b2bd5295ea459d229de280172616a0b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::selectElements </td> + <td>(</td> + <td class="paramtype">H5S_seloper_t </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const size_t </td> + <td class="paramname"><em>num_elements</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const hsize_t * </td> + <td class="paramname"><em>coord</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">op</td><td>- IN: Operator specifying how the new selection is to be combined with the existing selection for the dataspace </td></tr> + <tr><td class="paramname">num_elements</td><td>- IN: Number of elements to be selected </td></tr> + <tr><td class="paramname">coord</td><td>- IN: A 2-dimensional array of 0-based values specifying the coordinates of the elements being selected </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section user"><dt>Description</dt><dd>For more information, please refer to the C layer Reference Manual at: <a href="http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElements">http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectElements</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="a92bd510d1c06ebef292faeff73f40c12"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::selectHyperslab </td> + <td>(</td> + <td class="paramtype">H5S_seloper_t </td> + <td class="paramname"><em>op</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const hsize_t * </td> + <td class="paramname"><em>count</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const hsize_t * </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const hsize_t * </td> + <td class="paramname"><em>stride</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const hsize_t * </td> + <td class="paramname"><em>block</em> = <code>NULL</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">op</td><td>- IN: Operation to perform on current selection </td></tr> + <tr><td class="paramname">count</td><td>- IN: Number of blocks included in the hyperslab </td></tr> + <tr><td class="paramname">start</td><td>- IN: Offset of the start of hyperslab </td></tr> + <tr><td class="paramname">stride</td><td>- IN: Hyperslab stride - default to <code>NULL</code> </td></tr> + <tr><td class="paramname">block</td><td>- IN: Size of block in the hyperslab - default to <code>NULL</code> </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section user"><dt>Description</dt><dd>For more information, please refer to the C layer Reference Manual at: <a href="http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectHyperslab">http://www.hdfgroup.org/HDF5/doc/RM/RM_H5S.html#Dataspace-SelectHyperslab</a> </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="chunks_8cpp-example.html#a9">chunks.cpp</a>, <a class="el" href="extend_ds_8cpp-example.html#a10">extend_ds.cpp</a>, and <a class="el" href="readdata_8cpp-example.html#a12">readdata.cpp</a>.</dd> +</dl> +</div> +</div> +<a class="anchor" id="a2817049bbb949258412f85b3c6db89ec"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::selectNone </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a60cb10767095d693ce9677b6979e5689"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool H5::DataSpace::selectValid </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the selection is within the extent of the dataspace, and <code>false</code>, otherwise </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a468766b38d3f32ab966e22e5d2a96e4f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::setExtentNone </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a3dd7d1422ba85fe3dc7979abd9db39b3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::DataSpace::setExtentSimple </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">const hsize_t * </td> + <td class="paramname"><em>current_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const hsize_t * </td> + <td class="paramname"><em>maximum_size</em> = <code>NULL</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">rank</td><td>- IN: Rank of the dataspace </td></tr> + <tr><td class="paramname">current_size</td><td>- IN: Array containing current size of dataspace </td></tr> + <tr><td class="paramname">maximum_size</td><td>- IN: Array containing maximum size of dataspace </td></tr> + </table> + </dd> +</dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="class_h5_1_1_data_space_i_exception.html">H5::DataSpaceIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="af19fb72eae0855e07830c6d9a6f4748d"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="class_h5_1_1_data_space.html">DataSpace</a> H5::DataSpace::ALL</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="_h5_data_space_8h_source.html">H5DataSpace.h</a></li> +<li>H5DataSpace.cpp</li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Mon Jul 21 2014 10:58:44 for HDF5 C++ API by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.5 +</small></address> +</body> +</html> |