diff options
Diffstat (limited to 'c++/src/cpplus_RM/class_h5_1_1_id_component.html')
| -rw-r--r-- | c++/src/cpplus_RM/class_h5_1_1_id_component.html | 510 |
1 files changed, 510 insertions, 0 deletions
diff --git a/c++/src/cpplus_RM/class_h5_1_1_id_component.html b/c++/src/cpplus_RM/class_h5_1_1_id_component.html new file mode 100644 index 0000000..ff207f4 --- /dev/null +++ b/c++/src/cpplus_RM/class_h5_1_1_id_component.html @@ -0,0 +1,510 @@ +<!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::IdComponent 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_id_component.html">IdComponent</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="class_h5_1_1_id_component-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">H5::IdComponent Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Class <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> provides wrappers of the C functions that operate on an HDF5 identifier. + <a href="class_h5_1_1_id_component.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_h5_id_component_8h_source.html">H5IdComponent.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for H5::IdComponent:</div> +<div class="dyncontent"> + <div class="center"> + <img src="class_h5_1_1_id_component.png" usemap="#H5::IdComponent_map" alt=""/> + <map id="H5::IdComponent_map" name="H5::IdComponent_map"> +<area href="class_h5_1_1_attribute.html" title="Class Attribute operates on HDF5 attributes. " alt="H5::Attribute" shape="rect" coords="0,56,159,80"/> +<area href="class_h5_1_1_data_space.html" title="Class DataSpace operates on HDF5 dataspaces. " alt="H5::DataSpace" shape="rect" coords="169,56,328,80"/> +<area href="class_h5_1_1_h5_location.html" title="H5Location is an abstract base class, added in version 1.8.12. " alt="H5::H5Location" shape="rect" coords="338,56,497,80"/> +<area href="class_h5_1_1_prop_list.html" title="Class PropList provides operations for generic property lists. " alt="H5::PropList" shape="rect" coords="845,56,1004,80"/> +<area href="class_h5_1_1_h5_file.html" title="Class H5File represents an HDF5 file. " alt="H5::H5File" shape="rect" coords="253,112,412,136"/> +<area href="class_h5_1_1_h5_object.html" title="Class H5Object is a bridge between H5Location and DataSet, DataType, and Group. " alt="H5::H5Object" shape="rect" coords="422,112,581,136"/> +<area href="class_h5_1_1_d_set_creat_prop_list.html" title="Class DSetCreatPropList represents the dataset creation property list. " alt="H5::DSetCreatPropList" shape="rect" coords="591,112,750,136"/> +<area href="class_h5_1_1_d_set_mem_xfer_prop_list.html" title="Class DSetMemXferPropList represents the dataset memory and transfer property list. " alt="H5::DSetMemXferPropList" shape="rect" coords="760,112,919,136"/> +<area href="class_h5_1_1_file_acc_prop_list.html" title="Class FileAccPropList represents the HDF5 file access property list. " alt="H5::FileAccPropList" shape="rect" coords="929,112,1088,136"/> +<area href="class_h5_1_1_file_creat_prop_list.html" title="Class FileCreatPropList represents the HDF5 file create property list. " alt="H5::FileCreatPropList" shape="rect" coords="1098,112,1257,136"/> +<area href="class_h5_1_1_data_set.html" title="Class DataSet operates on HDF5 datasets. " alt="H5::DataSet" shape="rect" coords="253,168,412,192"/> +<area href="class_h5_1_1_data_type.html" title="Class DataType provides generic operations on HDF5 datatypes. " alt="H5::DataType" shape="rect" coords="422,168,581,192"/> +<area href="class_h5_1_1_group.html" title="Class Group represents an HDF5 group. " alt="H5::Group" shape="rect" coords="591,168,750,192"/> +<area href="class_h5_1_1_array_type.html" title="Class ArrayType inherits from DataType and provides wrappers for the HDF5's Array Datatypes..." alt="H5::ArrayType" shape="rect" coords="84,224,243,248"/> +<area href="class_h5_1_1_atom_type.html" title="AtomType is a base class, inherited by IntType, FloatType, StrType, and PredType. ..." alt="H5::AtomType" shape="rect" coords="253,224,412,248"/> +<area href="class_h5_1_1_comp_type.html" title="CompType is a derivative of a DataType and operates on HDF5 compound datatypes. " alt="H5::CompType" shape="rect" coords="422,224,581,248"/> +<area href="class_h5_1_1_enum_type.html" title="Class EnumType operates on HDF5 enum datatypes. " alt="H5::EnumType" shape="rect" coords="591,224,750,248"/> +<area href="class_h5_1_1_var_len_type.html" title="VarLenType operates on the HDF5 C's Variable-length Datatypes. " alt="H5::VarLenType" shape="rect" coords="760,224,919,248"/> +<area href="class_h5_1_1_float_type.html" title="Class FloatType operates on HDF5 floating point datatype. " alt="H5::FloatType" shape="rect" coords="0,280,159,304"/> +<area href="class_h5_1_1_int_type.html" title="Class IntType operates on HDF5 integer datatype. " alt="H5::IntType" shape="rect" coords="169,280,328,304"/> +<area href="class_h5_1_1_pred_type.html" title="Class PredType holds the definition of all the HDF5 predefined datatypes. " alt="H5::PredType" shape="rect" coords="338,280,497,304"/> +<area href="class_h5_1_1_str_type.html" title="Class StrType operates on HDF5 string datatypes. " alt="H5::StrType" shape="rect" coords="507,280,666,304"/> +</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:a0e75b2e591d2fccd9e4c291a485d4754"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1b34f54d2fd41d885e8ced7613d6abd1"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9dc2815e9887d0adb5d5bba72adbd0d6"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac15a341319624c9199a309fad56858e0"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab2ba7509cb5beb8c80e242d7afe10a3c"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adde1c48166476e089635bb40a2113653"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abef6d67a39f8723aa81bd16392dfc6bf"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a34ac09a54825253293a0d8990e120506"><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"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a34ac09a54825253293a0d8990e120506">More...</a><br/></td></tr> +<tr class="separator:a34ac09a54825253293a0d8990e120506"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1e46d85ec29cd77bb1767cd01b8f0c8d"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a013a42f5fd29d35d9428c1be8638acfe"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1c1e2479afec6ce26734225b434752fb"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a780d19c3d86037de38511f3e6cec3ca6"><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"><td class="mdescLeft"> </td><td class="mdescRight">Noop destructor. <a href="#a780d19c3d86037de38511f3e6cec3ca6">More...</a><br/></td></tr> +<tr class="separator:a780d19c3d86037de38511f3e6cec3ca6"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:a25e4d590aa5cc0fc87ced46718d5b0d7"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr class="memitem:a5545dda5e4c610b6bd9cdffe670c8728"><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"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>In most cases, the C library handles these operations and an application rarely needs them. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a013a42f5fd29d35d9428c1be8638acfe"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5::IdComponent::IdComponent </td> + <td>(</td> + <td class="paramtype">const hid_t </td> + <td class="paramname"><em>h5_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">h5_id</td><td>- IN: Id of an existing object </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_type_i_exception.html">H5::DataTypeIException</a></td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a1c1e2479afec6ce26734225b434752fb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5::IdComponent::IdComponent </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_h5_1_1_id_component.html">IdComponent</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_id_component.html" title="Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier. ">IdComponent</a> instance to copy </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a780d19c3d86037de38511f3e6cec3ca6"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">H5::IdComponent::~IdComponent </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"> + +</div> +</div> +<a class="anchor" id="a5545dda5e4c610b6bd9cdffe670c8728"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">H5::IdComponent::IdComponent </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a9dc2815e9887d0adb5d5bba72adbd0d6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::IdComponent::decRefCount </td> + <td>(</td> + <td class="paramtype">const hid_t </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ac15a341319624c9199a309fad56858e0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::IdComponent::decRefCount </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="ab2ba7509cb5beb8c80e242d7afe10a3c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int H5::IdComponent::getCounter </td> + <td>(</td> + <td class="paramtype">const hid_t </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>Reference count </dd></dl> + +</div> +</div> +<a class="anchor" id="adde1c48166476e089635bb40a2113653"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int H5::IdComponent::getCounter </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>Reference count </dd></dl> + +</div> +</div> +<a class="anchor" id="a25e4d590aa5cc0fc87ced46718d5b0d7"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">H5I_type_t H5::IdComponent::getHDFObjType </td> + <td>(</td> + <td class="paramtype">const hid_t </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>a valid HDF object type, which may be one of the following: <ul> +<li><code>H5I_FILE</code> </li> +<li><code>H5I_GROUP</code> </li> +<li><code>H5I_DATATYPE</code> </li> +<li><code>H5I_DATASPACE</code> </li> +<li><code>H5I_DATASET</code> </li> +<li><code>H5I_ATTR</code> </li> +<li>or <code>H5I_BADID</code>, if no valid type can be determined or the input object id is invalid. </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="abef6d67a39f8723aa81bd16392dfc6bf"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">H5I_type_t H5::IdComponent::getHDFObjType </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>a valid HDF object type, which may be one of the following: <ul> +<li><code>H5I_FILE</code> </li> +<li><code>H5I_GROUP</code> </li> +<li><code>H5I_DATATYPE</code> </li> +<li><code>H5I_DATASPACE</code> </li> +<li><code>H5I_DATASET</code> </li> +<li><code>H5I_ATTR</code> </li> +<li>or <code>H5I_BADID</code>, if no valid type can be determined or the input object id is invalid. </li> +</ul> +</dd></dl> + +</div> +</div> +<a class="anchor" id="a0e75b2e591d2fccd9e4c291a485d4754"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::IdComponent::incRefCount </td> + <td>(</td> + <td class="paramtype">const hid_t </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a1b34f54d2fd41d885e8ced7613d6abd1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::IdComponent::incRefCount </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Referenced by <a class="el" href="class_h5_1_1_attribute.html#ab93ec0beebebfa3a204f4ff8e16be985">H5::Attribute::Attribute()</a>, <a class="el" href="class_h5_1_1_data_set.html#a224114f6fd3fdb01300ffcfd5e5192d5">H5::DataSet::DataSet()</a>, <a class="el" href="class_h5_1_1_data_space.html#a55be5c95c111878a78889697848c14cd">H5::DataSpace::DataSpace()</a>, <a class="el" href="class_h5_1_1_data_type.html#a4e72f20ab686efffeedd72d8afa99519">H5::DataType::DataType()</a>, <a class="el" href="class_h5_1_1_group.html#a17a49de6cbf4e29ef2fcb33d2fecbc4c">H5::Group::Group()</a>, <a class="el" href="class_h5_1_1_h5_file.html#a912472f9bdf2bf90590a9e8ecaed3b99">H5::H5File::H5File()</a>, <a class="el" href="class_h5_1_1_prop_list.html#a8f3198e63cf76ac921c7aff75256f6a7">H5::PropList::PropList()</a>, and <a class="el" href="class_h5_1_1_id_component.html#a1e46d85ec29cd77bb1767cd01b8f0c8d">setId()</a>.</p> + +</div> +</div> +<a class="anchor" id="a34ac09a54825253293a0d8990e120506"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_h5_1_1_id_component.html">IdComponent</a> & H5::IdComponent::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_h5_1_1_id_component.html">IdComponent</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 object </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Reference to <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> 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_id_component_exception.html">H5::IdComponentException</a></td><td>when attempt to close the HDF5 object fails </td></tr> + </table> + </dd> +</dl> + +<p>References <a class="el" href="class_h5_1_1_exception.html#aedc9690b2b1a12e0fab36962d4479508">H5::Exception::getDetailMsg()</a>, and <a class="el" href="class_h5_1_1_id_component.html#a1e46d85ec29cd77bb1767cd01b8f0c8d">setId()</a>.</p> + +</div> +</div> +<a class="anchor" id="a1e46d85ec29cd77bb1767cd01b8f0c8d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void H5::IdComponent::setId </td> + <td>(</td> + <td class="paramtype">const hid_t </td> + <td class="paramname"><em>new_id</em></td><td>)</td> + <td></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_id_component_exception.html">H5::IdComponentException</a></td><td>when the attempt to close the HDF5 object fails </td></tr> + </table> + </dd> +</dl> + +<p>References <a class="el" href="class_h5_1_1_id_component.html#a1b34f54d2fd41d885e8ced7613d6abd1">incRefCount()</a>.</p> + +<p>Referenced by <a class="el" href="class_h5_1_1_id_component.html#a34ac09a54825253293a0d8990e120506">operator=()</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="_h5_id_component_8h_source.html">H5IdComponent.h</a></li> +<li>H5IdComponent.cpp</li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Mon Jul 21 2014 10:58:45 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> |