mirrors/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2026-09-25 04:09:44 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
dd68a420501ed824f9161bc5c191247515a1e2da
hdf5/develop/h5_cpp_intro.html
T
byrnHDF dd68a42050 deploy: 972020e69f
2026-08-06 01:18:44 +00:00

210 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: C++ API Introduction</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Help us improve by taking our short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<!-- ... other metadata & script includes ... -->
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
<script type="text/javascript">
DoxygenAwesomeTabs.init()
</script>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-57FMZK4S7X"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-57FMZK4S7X');
</script>
</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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign">
<div id="projectname">HDF5<span id="projectnumber">&#160;Last Updated on 2026-08-06</span>
</div>
<div id="projectbrief">The HDF5 Field Guide</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<div id="main-nav">
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="_getting_started.html"><span>Getting&#160;started</span></a></li>
<li><a href="_u_g.html"><span>User&#160;Guide</span></a></li>
<li><a href="_r_m.html"><span>Reference&#160;Manual</span></a></li>
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
<li><a href="_t_n.html"><span>Technical&#160;Notes</span></a></li>
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
<li><a href="_f_t_s.html"><span>Full-Text&#160;Search</span></a></li>
<li><a href="_about.html"><span>About</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- main-nav -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('h5_cpp_intro.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">C++ API Introduction </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Navigate back: <a class="el" href="index.html" title="notitle">Main</a> / <a class="el" href="_getting_started.html" title="Getting Started with HDF5">Getting Started with HDF5</a> </p><hr />
<h1 class="doxsection"><a class="anchor" id="cpp_overview"></a>
Overview</h1>
<p>The HDF5 C++ API provides object-oriented wrappers for the HDF5 C Library, enabling modern C++ applications to leverage HDF5's powerful data management capabilities with:</p><ul>
<li>Automatic resource management through RAII</li>
<li>Exception-based error handling</li>
<li>Type-safe interfaces</li>
<li>STL integration (std::string support)</li>
</ul>
<h2 class="doxsection"><a class="anchor" id="cpp_prerequisites"></a>
Prerequisites</h2>
<p>Users should be familiar with:</p><ul>
<li>HDF5 concepts (files, groups, datasets, attributes, datatypes, dataspaces)</li>
<li>Basic C++ programming (classes, exceptions, templates)</li>
<li>The HDF5 <a class="el" href="_r_m.html" title="HDF5 Reference Manual">Reference Manual</a> for underlying C API concepts</li>
</ul>
<h2 class="doxsection"><a class="anchor" id="cpp_mapping"></a>
C API to C++ Class Mapping</h2>
<p>The C++ classes closely mirror the HDF5 C API modules:</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">C API Module </th><th class="markdownTableHeadNone">C++ Class </th><th class="markdownTableHeadNone">Purpose </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">H5A (Attributes) </td><td class="markdownTableBodyNone"><a class="el" href="class_h5_1_1_attribute.html" title="Class Attribute operates on HDF5 attributes.">H5::Attribute</a> </td><td class="markdownTableBodyNone">Metadata attached to objects </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">H5D (Datasets) </td><td class="markdownTableBodyNone"><a class="el" href="class_h5_1_1_data_set.html" title="Class DataSet operates on HDF5 datasets.">H5::DataSet</a> </td><td class="markdownTableBodyNone">Data storage and I/O </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">H5S (Dataspaces) </td><td class="markdownTableBodyNone"><a class="el" href="class_h5_1_1_data_space.html" title="Class DataSpace inherits from IdComponent and provides wrappers for the HDF5&#39;s dataspaces.">H5::DataSpace</a> </td><td class="markdownTableBodyNone">Dimensional structure of data </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">H5T (Datatypes) </td><td class="markdownTableBodyNone"><a class="el" href="class_h5_1_1_data_type.html" title="Class DataType provides generic operations on HDF5 datatypes.">H5::DataType</a> </td><td class="markdownTableBodyNone">Data type definitions </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">H5F (Files) </td><td class="markdownTableBodyNone"><a class="el" href="class_h5_1_1_h5_file.html" title="Class H5File represents an HDF5 file and inherits from class Group as file is a root group.">H5::H5File</a> </td><td class="markdownTableBodyNone">File access and management </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">H5G (Groups) </td><td class="markdownTableBodyNone"><a class="el" href="class_h5_1_1_group.html" title="Class Group represents an HDF5 group.">H5::Group</a> </td><td class="markdownTableBodyNone">Hierarchical organization </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">H5P (Property Lists) </td><td class="markdownTableBodyNone"><a class="el" href="class_h5_1_1_prop_list.html" title="Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list.">H5::PropList</a> + subclasses </td><td class="markdownTableBodyNone">Configuration parameters </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">H5L/H5O (Links/Objects) </td><td class="markdownTableBodyNone"><a class="el" href="class_h5_1_1_h5_location.html" title="H5Location is an abstract base class, added in version 1.8.12.">H5::H5Location</a> </td><td class="markdownTableBodyNone">Management of links and objects </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">H5E (Errors) </td><td class="markdownTableBodyNone"><a class="el" href="class_h5_1_1_exception.html" title="Exception provides wrappers of HDF5 error handling functions.">H5::Exception</a> </td><td class="markdownTableBodyNone">Error reporting </td></tr>
</table>
<h2 class="doxsection"><a class="anchor" id="cpp_examples"></a>
Quick Start Examples</h2>
<ul>
<li>Creating groups and datasets: <a href="https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples/CXX/TUTR/h5tutr_crtgrp.cpp">h5tutr_crtgrp.cpp</a> <a href="https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples/CXX/TUTR/h5tutr_crtdat.cpp">h5tutr_crtdat.cpp</a></li>
<li>Writing/Reading data <a href="https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples/CXX/TUTR/h5tutr_rdwt.cpp">h5tutr_rdwt.cpp</a> <a href="https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples/CXX/TUTR/h5tutr_subset.cpp">h5tutr_subset.cpp</a></li>
<li>Working with attributes <a href="https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples/CXX/TUTR/h5tutr_crtatt.cpp">h5tutr_crtatt.cpp</a></li>
</ul>
<p>See the <a class="el" href="_l_b_examples.html" title="Examples from Learning the Basics">Examples from Learning the Basics</a> for additional examples.</p>
<h2 class="doxsection"><a class="anchor" id="cpp_building"></a>
Building Applications</h2>
<p>Please refer to the docs/INSTALL_CMake.md file under the top directory of the HDF5 source code or <a href="https://github.com/HDFGroup/hdf5/blob/develop/docs/INSTALL_CMake.md">INSTALL_CMake.md</a> on GitHub for information about installing, building, and testing the C++ API.</p>
<hr />
<p> Navigate back: <a class="el" href="index.html" title="notitle">Main</a> / <a class="el" href="_getting_started.html" title="Getting Started with HDF5">Getting Started with HDF5</a> </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink