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

Add the C++ API introduction page (#6092)

Browse Source
This commit is contained in:
bmribler
2025-12-09 16:07:12 -06:00
committed by GitHub
parent c4da612110
commit 72da2a290e
2 changed files with 61 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doxygen/dox/CppAPIIntro.dox
+57
View File
@@ -0,0 +1,57 @@
/** \page h5_cpp_intro C++ API Introduction
Navigate back: \ref index "Main" / \ref GettingStarted
<hr>
\section cpp_overview Overview
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:
- Automatic resource management through RAII
- Exception-based error handling
- Type-safe interfaces
- STL integration (std::string support)
\subsection cpp_prerequisites Prerequisites
Users should be familiar with:
- HDF5 concepts (files, groups, datasets, attributes, datatypes, dataspaces)
- Basic C++ programming (classes, exceptions, templates)
- The HDF5 \ref RM "Reference Manual" for underlying C API concepts
\subsection cpp_mapping C API to C++ Class Mapping
The C++ classes closely mirror the HDF5 C API modules:
| C API Module | C++ Class | Purpose |
|--------------|-----------|---------|
| H5A (Attributes) | H5::Attribute | Metadata attached to objects |
| H5D (Datasets) | H5::DataSet | Data storage and I/O |
| H5S (Dataspaces) | H5::DataSpace | Dimensional structure of data |
| H5T (Datatypes) | H5::DataType | Data type definitions |
| H5F (Files) | H5::H5File | File access and management |
| H5G (Groups) | H5::Group | Hierarchical organization |
| H5P (Property Lists) | H5::PropList + subclasses | Configuration parameters |
| H5L/H5O (Links/Objects) | H5::Location | Management of links and objects |
| H5E (Errors) | H5::Exception | Error reporting |
\subsection cpp_examples Quick Start Examples
- Creating groups and datasets: <a href="https://\CPPEXS/h5tutr_crtgrp.cpp">h5tutr_crtgrp.cpp</a> <a href="https://\CPPEXS/h5tutr_crtdat.cpp">h5tutr_crtdat.cpp</a>
- Writing/Reading data <a href="https://\CPPEXS/h5tutr_rdwt.cpp">h5tutr_rdwt.cpp</a> <a href="https://\CPPEXS/h5tutr_subset.cpp">h5tutr_subset.cpp</a>
- Working with attributes <a href="https://\CPPEXS/h5tutr_crtatt.cpp">h5tutr_crtatt.cpp</a>
- Extendible datasets <a href="https://\CPPEXS/h5tutr_extend.cpp">h5tutr_extend.cpp</a>
- Chunked/Compressed datasets <a href="https://\CPPEXS/h5tutr_cmprss.cpp">h5tutr_cmprss.cpp</a>
See the See \ref LBExamples for additional examples.
\subsection cpp_building Building Applications
Please refer to the release_docs/INSTALL_CMake.txt file under the top directory of the HDF5 source code or <a href="https://\SRCURL/release_docs/INSTALL_CMake.txt">INSTALL_CMake.txt on GitHub for information about installing, building, and testing the C++ API.</a>
<hr>
Navigate back: \ref index "Main" / \ref GettingStarted
*/
doxygen/dox/ReferenceManual.dox
+4
View File
@@ -177,6 +177,10 @@ Follow these simple rules and stay out of trouble:
\cpp_c_api_note
\par C++ API Guide
New to the HDF5 C++ API? See the \ref h5_cpp_intro for an introduction,
class mapping guide, and examples.
\par Don't like what you see? - You can help to improve this Reference Manual
Complete the survey linked near the top of this page!\n
We treat documentation like code: Fork the