h5cpp

https://ess-dmsc.github.io/h5cpp/
Admin
h5cpp is a modern C++ HDF5 wrapper library providing convenient bindings for working with HDF5 files...
Tokens:853,923
Snippets:6,931
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Installing the Library

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/installing.html

Install the compiled h5cpp library to the default prefix or a custom location using make install.

```bash
$ make install

```

--------------------------------

### C++ Main File Example

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/using.html

A basic C++ program demonstrating the inclusion of the h5cpp header and usage of its datatype functionalities. Ensure the h5cpp library is installed and accessible.

```cpp
#include <iostream>
#include <h5cpp/hdf5.hpp>

int main()
{
      auto type = hdf5::datatype::TypeTrait<int>::create();
      std::cout<<type.get_class()<<std::endl;

      return 0;
}

```

--------------------------------

### Example HDF5 Paths

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/users_guide/overview.html

Demonstrates how paths are represented in h5cpp, similar to Unix filesystem paths. Paths can be absolute (starting with '/') or relative.

```text
/sensors/temp
/plot/y

```

--------------------------------

### HDF5 Path Examples

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/overview.html

Demonstrates the string representation of HDF5 paths, which are sequences of link names separated by '/'. Paths can be absolute (starting with '/') or relative.

```text
/sensors/temp
/plot/y
```

--------------------------------

### Updating Package List and Installing h5cpp

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/installing.html

Update your system's package list and install the h5cpp library and its related packages.

```bash
$ apt-get update
$ apt-get install libh5cpp0.8.0 libh5cpp0.8.0-dbg libh5cpp0.8.0-doc libh5cpp0.8.0-dev

```

--------------------------------

### offset() - Get

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/classhdf5_1_1dataspace_1_1Hyperslab.html

Retrieves a constant reference to the starting offset values of the hyperslab selection.

```APIDOC
## const Dimensions& hdf5::dataspace::Hyperslab::offset() const

### Description
Retrieves a constant reference to the start values of the hyperslab.

### Exceptions
* std::runtime_error - if the Hyperslab is default constructed

### Returns
* const reference to the start values of the hyperslab
```

--------------------------------

### Get Iterator Configuration (Const)

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/classhdf5_1_1node_1_1Group.html

Returns a constant reference to the iterator configuration of the group. This is used for read-only iteration setup.

```cpp
const IteratorConfig & iterator_config() const noexcept
```

--------------------------------

### Get Begin Iterator for RecursiveLinkIterator

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/api_reference/doxygen/recursive__link__iterator_8hpp_source.html

Returns a RecursiveLinkIterator pointing to the first link in the specified group. This is used to start a recursive traversal.

```cpp
static RecursiveLinkIterator begin(const Group &current_group);
```

--------------------------------

### Creating Build Directory

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/installing.html

Create a build directory and navigate into it for compiling the h5cpp library.

```bash
$ make h5cpp-build
$ cd h5cpp-build

```

--------------------------------

### Building and Running Tests

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/installing.html

Build the h5cpp library and run its unit tests using make.

```bash
$ make run_tests

```

--------------------------------

### Get Hyperslab Offset

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/api_reference/doxygen/hyperslab_8hpp_source.html

Retrieves the current offset of the hyperslab selection as a Dimensions object. This represents the starting point of the hyperslab in the dataspace.

```cpp
const Dimensions &offset() const;
```

--------------------------------

### Create and Open HDF5 Files

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/uguide.html

Demonstrates how to create a new HDF5 file and open an existing one using h5cpp. Ensure 'h5cpp/h5cpp.hpp' is included and 'h5' namespace is used.

```cpp
#include<h5cpp/h5cpp.hpp>
namespace h5 = h5cpp;

//creating a new file
h5::file f1 = h5::file::create("name.h5",....);
//opening an existing file
h5::file f2 = h5::file::open("name.h5",....);
```

--------------------------------

### ArrayAdapter Constructor Example

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/namespace_hdf5.html

Demonstrates the construction of an ArrayAdapter for C-style arrays. The ArrayAdapter does not own the array; resource management must be handled by the caller.

```cpp
double *data = new double[100];


```

```cpp
inline ArrayAdapter(){
}
```

```cpp
inline ArrayAdapter(T *data, size_t size){
}
```

--------------------------------

### Create File from Buffer (Full Signature) - Implementation

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/file_2functions_8hpp_source.html

Core implementation for creating an HDF5 file from a buffer. Validates flags and opens the file image. Throws an error if DONT_COPY is used without DONT_RELEASE.

```cpp
template<typename T>
File from_buffer(T &data,
 const datatype::Datatype &mem_type,
 const dataspace::Dataspace &mem_space,
 ImageFlagsBase flags)
{
 if ((flags & ImageFlags::DontCopy) && !(flags & ImageFlags::DontRelease))
 throw std::runtime_error("Invalid ImageFlags in from_buffer: the DONT_COPY flag without the DONT_RELEASE flag");
 size_t databytesize = signed2unsigned<size_t>(mem_space.size()) * mem_type.size();
 hid_t fid = 0;
 if(mem_type.get_class() == datatype::Class::Integer)
 {

 fid = H5LTopen_file_image(dataspace::ptr(data), databytesize, flags);
 if (fid < 0)
 {
 std::stringstream ss;
 ss << "Failure opening file image";
 error::Singleton::instance().throw_with_stack(ss.str());
 }
 return File(ObjectHandle(fid));
 }
 else
 {
 std::stringstream ss;
 ss<<"Failure to open non-integer buffer";
 error::Singleton::instance().throw_with_stack(ss.str());
 }
 return File(hdf5::ObjectHandle(fid));
}
```

--------------------------------

### Building the Library

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/installing.html

Compile the h5cpp library using make after configuring with CMake.

```bash
$ make

```

--------------------------------

### close_degree (get)

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/file__access_8hpp_source.html

Gets the file close degree.

```APIDOC
## CloseDegree close_degree() const

### Description
Gets the file close degree.

### Method
close_degree

### Endpoint
N/A (Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **return value** (CloseDegree) - The file close degree.

#### Response Example
None
```

--------------------------------

### Storing and Applying Selections with SelectionList

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/users_guide/dataspace_selections.html

Demonstrates how to create a SelectionList, add multiple selections with different operations (Set, Or), and apply them to a dataspace. Requires importing necessary dataspace and selection types.

```cpp
dataspace::SelectionList selections;
selections.push_back({dataspace::SelectionOperation::Set,
                      Selection::SharedPointer(new dataspace::Hyperslab({0,0},{100,100}))});
selections.push_back({dataspace::SelectionOperation::Or,
                      Selection::SharedPointer(new dataspace::Hyperslab({200,129},{100,100}))});

dataspace::Simple space = ...;

for(auto selection: selections)
    selection.second->apply(space,selection.first);
```

--------------------------------

### get()

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/api_reference/doxygen/classhdf5_1_1dataspace_1_1DataspaceHolder.html

Factory holder method for getting a reference of dataspace objects.

```APIDOC
## get()
template<typename T >
const Dataspace & hdf5::dataspace::DataspaceHolder::get(const T &v)

Returns data space reference for static data space object if available. Otherwise, it creates a new data space object and returns its reference.

Parameters:
     v: provided dataspace data

Returns:
    data space reference for data space object
```

--------------------------------

### Reading and Writing Entire Datasets

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/users_guide/datasets.html

Demonstrates how to read from and write to an entire dataset using the `read()` and `write()` methods. Assumes the dataset is already created.

```c++
dataset_t dset = group["temperatures"];

std::vector<double> temperatures;
dset.read(temperatures);

//or for writing
dset.write(temperatures)

```

--------------------------------

### Constructor Documentation

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/classhdf5_1_1property_1_1CreationOrder.html

Detailed documentation for the constructors of the CreationOrder class.

```APIDOC
## Constructor & Destructor Documentation

### ◆ CreationOrder() [1/3]

hdf5::property::CreationOrder::CreationOrder ()

## ◆ CreationOrder() [2/3]

hdf5::property::CreationOrder::CreationOrder (const CreationOrder & _c)

Parameters:
     c| reference from which to copy

## ◆ CreationOrder() [3/3]

hdf5::property::CreationOrder::CreationOrder (unsigned _value)

Parameters:
     value| flags from which to construct the instance
```

--------------------------------

### ObjectId Static Get File Name

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/object__id_8hpp_source.html

A static method to get the file name from an ObjectHandle. This is useful when you have a handle but not necessarily an ObjectId.

```cpp
static std::string get_file_name(const ObjectHandle &handle);
```

--------------------------------

### Adding Ubuntu Resolute Package Sources

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/installing.html

Download the package sources file for Ubuntu Resolute to enable installation from the HDRI repository.

```bash
$ wget http://repos.pni-hdri.de/resolute-pni-hdri.sources

```

--------------------------------

### Get Dataspace Reference

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/dataspace_2type__trait_8hpp_source.html

Factory function to get a const reference to a dataspace associated with a value. It uses a DataspacePool for efficient management.

```cpp
template<typename T>
const typename dataspace::Dataspace & get(const T &value, DataspacePool & pool) {
 return TypeTrait<T>::get(value, pool);
}
```

--------------------------------

### h5cpp Functions starting with 'd'

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/api_reference/doxygen/functions_func_d.html

This section details the functions available in the h5cpp library that start with the letter 'd'. Each function is listed with its class context.

```APIDOC
## Functions starting with 'd'

This section lists functions available in the h5cpp library whose names begin with the letter 'd'. The functions are grouped by the class they belong to.

### Function List

- **data()** : `hdf5::ArrayAdapter< T >`
- **Dataset()** : `hdf5::node::Dataset`
- **DatasetAccessList()** : `hdf5::property::DatasetAccessList`
- **DatasetCreationList()** : `hdf5::property::DatasetCreationList`
- **DatasetTransferList()** : `hdf5::property::DatasetTransferList`
- **dataspace()** : `hdf5::attribute::Attribute`
- **Dataspace()** : `hdf5::dataspace::Dataspace`
- **dataspace()** : `hdf5::node::Dataset`
- **DataspaceHolder()** : `hdf5::dataspace::DataspaceHolder`
- **datatype()** : `hdf5::attribute::Attribute`
- **Datatype()** : `hdf5::datatype::Datatype`
- **datatype()** : `hdf5::node::Dataset`
- **DatatypeAccessList()** : `hdf5::property::DatatypeAccessList`
- **Deflate()** : `hdf5::filter::Deflate`
- **Descriptor()** : `hdf5::error::Descriptor`
- **dimensions()** : `hdf5::dataspace::Hyperslab`, `hdf5::dataspace::Points`, `hdf5::dataspace::Selection`, `hdf5::dataspace::Simple`, `hdf5::datatype::Array`
- **DirectDriver()** : `hdf5::file::DirectDriver`
- **disable_indexed()** : `hdf5::property::CreationOrder`
- **disable_intermediate_group_creation()** : `hdf5::property::LinkCreationList`
- **disable_time_tracking()** : `hdf5::property::ObjectCreationList`
- **disable_tracked()** : `hdf5::property::CreationOrder`
- **driver()** : `hdf5::property::FileAccessList`
```

--------------------------------

### ArrayAdapter Usage Example

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/classhdf5_1_1ArrayAdapter.html

Demonstrates the creation of an ArrayAdapter for a C-style array of doubles. This adapter is necessary because C-style arrays lack the size information required for HDF5 dataspace construction.

```cpp
double *data = new double[100];
hdf5::ArrayAdapter::data
```

--------------------------------

### TypeTrait for Scalar Dataspace

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/api_reference/doxygen/dataspace_2type__trait_8hpp_source.html

This snippet defines the TypeTrait for scalar types, mapping them to the Scalar dataspace. It provides methods to create, get, and get pointers to the scalar dataspace.

```cpp
template<typename T>
class TypeTrait {
 public:
  using DataspaceType = Scalar;
  static DataspaceType create(const T &) {
    return Scalar();
  }

  const static DataspaceType & get(const T &, DataspacePool &) {
    const static DataspaceType & cref_ = Scalar();
    return cref_;
  }

  static void *ptr(T &value) {
    return reinterpret_cast<void *>(&value);
  }

  static const void *cptr(const T &value) {
    return reinterpret_cast<const void *>(&value);
  }
};

```

--------------------------------

### Constructing a Root Path in hdf5::Path

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/classhdf5_1_1Path.html

Demonstrates two ways to construct a root path. The first method using a string literal is preferred.

```cpp
Path root_path("/");
Path root_path();
root_path.absolute(true);
```

--------------------------------

### Create File from Buffer (ImageFlagsBase) - Implementation

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/file_2functions_8hpp_source.html

Implementation for creating an HDF5 file from a buffer, automatically creating dataspace and datatype.

```cpp
template<typename T>
File from_buffer(T &data, ImageFlagsBase flags)
{
 auto mem_space = hdf5::dataspace::create(data);
 hdf5::datatype::DatatypeHolder mem_type_holder;
 return from_buffer(data, mem_type_holder.get(data), mem_space, flags);
}
```

--------------------------------

### Class Members starting with 'l'

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/api_reference/doxygen/functions_l.html

This section lists members of the h5cpp library that start with the letter 'l'. It includes functions, variables, and types organized by their respective classes and namespaces.

```APIDOC
## Class Members starting with 'l'

This section lists members of the h5cpp library that start with the letter 'l'. It includes functions, variables, and types organized by their respective classes and namespaces.

### layout()
- **Class**: hdf5::property::DatasetCreationList
- **Description**: Returns the layout of the dataset.

### level()
- **Class**: hdf5::filter::Deflate
- **Description**: Returns the compression level for Deflate filter.

### library_version_bound_high()
- **Class**: hdf5::property::FileAccessList
- **Description**: Gets the high bound for the library version.

### library_version_bound_low()
- **Class**: hdf5::property::FileAccessList
- **Description**: Gets the low bound for the library version.

### library_version_bounds()
- **Class**: hdf5::property::FileAccessList
- **Description**: Gets the library version bounds.

### line
- **Class**: hdf5::error::Descriptor
- **Description**: Represents a line in a source file.

### Link()
- **Class**: hdf5::node::Link
- **Description**: Constructor for hdf5::node::Link.

### link()
- **Class**: hdf5::node::Node
- **Description**: Returns a link to the node.

### link_access_list()
- **Class**: hdf5::IteratorConfig
- **Description**: Gets the link access list configuration.

### link_creation_order()
- **Class**: hdf5::property::GroupCreationList
- **Description**: Gets the link creation order property.

### link_storage_maximum_compact()
- **Class**: hdf5::property::GroupCreationList
- **Description**: Sets the maximum compact link storage size.

### link_storage_minimum_dense()
- **Class**: hdf5::property::GroupCreationList
- **Description**: Sets the minimum dense link storage size.

### link_storage_thresholds()
- **Class**: hdf5::property::GroupCreationList
- **Description**: Sets the link storage thresholds.

### LinkAccessList()
- **Class**: hdf5::property::LinkAccessList
- **Description**: Constructor for hdf5::property::LinkAccessList.

### LinkCreationList()
- **Class**: hdf5::property::LinkCreationList
- **Description**: Constructor for hdf5::property::LinkCreationList.

### LinkIterator()
- **Class**: hdf5::node::LinkIterator
- **Description**: Constructor for hdf5::node::LinkIterator.

### links
- **Class**: hdf5::node::Group
- **Description**: Represents the links within a group.

### LinkTarget()
- **Class**: hdf5::node::LinkTarget
- **Description**: Constructor for hdf5::node::LinkTarget.

### LinkView()
- **Class**: hdf5::node::LinkView
- **Description**: Constructor for hdf5::node::LinkView.

### List()
- **Class**: hdf5::property::List
- **Description**: Constructor for hdf5::property::List.

### local_heap_size_hint()
- **Class**: hdf5::property::GroupCreationList
- **Description**: Sets a hint for the local heap size.
```

--------------------------------

### Functions starting with 'i'

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/api_reference/doxygen/functions_func_i.html

This section lists functions available in the h5cpp library that start with the letter 'i'. Each function is associated with the class(es) it belongs to, providing a clear overview of its context and usage.

```APIDOC
## Functions starting with 'i'

This section lists functions available in the h5cpp library that start with the letter 'i'. Each function is associated with the class(es) it belongs to, providing a clear overview of its context and usage.

### id()

- **Classes**: hdf5::file::DirectDriver, hdf5::file::Driver, hdf5::file::File, hdf5::file::MemoryDriver, hdf5::file::MPIDriver, hdf5::file::PosixDriver, hdf5::filter::Filter, hdf5::node::Node

### increment()

- **Classes**: hdf5::file::MemoryDriver

### index()

- **Classes**: hdf5::Iterator, hdf5::IteratorConfig

### indexed()

- **Classes**: hdf5::property::CreationOrder

### inpad()

- **Classes**: hdf5::datatype::Float

### insert()

- **Classes**: hdf5::datatype::Compound, hdf5::datatype::Enum

### insert_underlying()

- **Classes**: hdf5::datatype::Enum

### instance()

- **Classes**: hdf5::error::Singleton

### Integer()

- **Classes**: hdf5::datatype::Integer

### intent()

- **Classes**: hdf5::file::File

### intermediate_group_creation()

- **Classes**: hdf5::property::LinkCreationList

### is_decoding_enabled()

- **Classes**: hdf5::filter::Filter

### is_encoding_enabled()

- **Classes**: hdf5::filter::Filter

### is_name()

- **Classes**: hdf5::Path

### is_open()

- **Classes**: hdf5::Context

### is_resolvable()

- **Classes**: hdf5::node::Link

### is_root()

- **Classes**: hdf5::Path

### is_signed()

- **Classes**: hdf5::datatype::Integer

### is_valid()

- **Classes**: hdf5::attribute::Attribute, hdf5::dataspace::Dataspace, hdf5::datatype::Datatype, hdf5::file::File, hdf5::node::Node, hdf5::ObjectHandle

### is_variable_length()

- **Classes**: hdf5::datatype::String

### Iterator()

- **Classes**: hdf5::Iterator

### iterator_config()

- **Classes**: hdf5::attribute::AttributeManager, hdf5::node::Group

### IteratorConfig()

- **Classes**: hdf5::IteratorConfig
```

--------------------------------

### FileCreationList Methods

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/classhdf5_1_1property_1_1FileCreationList-members.html

This section details the methods available for the HDF5 FileCreationList class, enabling configuration of file creation properties.

```APIDOC
## FileCreationList()

### Description
Default constructor for FileCreationList.

### Method
Constructor

## FileCreationList(ObjectHandle &&handle)

### Description
Constructor that takes an existing ObjectHandle.

### Method
Constructor

## object_length_size(size_t size) const

### Description
Sets the size of the object length. This method is part of the FileCreationList configuration.

### Method
Setter

## object_length_size() const

### Description
Retrieves the current size of the object length.

### Method
Getter

## object_offset_size(size_t size) const

### Description
Sets the size of the object offset. This method is part of the FileCreationList configuration.

### Method
Setter

## object_offset_size() const

### Description
Retrieves the current size of the object offset.

### Method
Getter

## page_size(hsize_t size)

### Description
Sets the page size for the file. This method is part of the FileCreationList configuration.

### Method
Setter

## page_size() const

### Description
Retrieves the current page size of the file.

### Method
Getter

## user_block(hsize_t size) const

### Description
Sets the user block size for the file. This method is part of the FileCreationList configuration.

### Method
Setter

## user_block() const

### Description
Retrieves the current user block size of the file.

### Method
Getter

## ~FileCreationList() override

### Description
Destructor for FileCreationList.

### Method
Destructor
```

--------------------------------

### Namespace Members starting with 'd'

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/api_reference/doxygen/namespacemembers_d.html

This section details various members within the h5cpp namespaces that start with the letter 'd'. It includes properties, dimensions, data types, and file drivers.

```APIDOC
## Namespace Members - d

### Description
This page lists and describes namespace members in the h5cpp library that begin with the letter 'd', categorized by their respective namespaces.

### Namespace Members

*   **DatasetAllocTime** : `hdf5::property`
    *   Description: Represents the allocation time property for HDF5 datasets.
*   **DatasetFillTime** : `hdf5::property`
    *   Description: Represents the fill time property for HDF5 datasets.
*   **DatasetFillValueStatus** : `hdf5::property`
    *   Description: Represents the fill value status property for HDF5 datasets.
*   **DatasetLayout** : `hdf5::property`
    *   Description: Represents the layout property for HDF5 datasets.
*   **Dimensions** : `hdf5`
    *   Description: Represents the dimensions of an HDF5 object.
*   **Direction** : `hdf5::datatype`
    *   Description: Represents the directionality of a datatype.
*   **DriverID** : `hdf5::file`
    *   Description: Represents the identifier for an HDF5 file driver.
```

--------------------------------

### Type Members Starting with 't'

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/api_reference/doxygen/functions_t.html

This section lists members of the h5cpp library whose names start with 't'. It includes functions, types, and other members across various classes and namespaces.

```APIDOC
## target()

### Description
Returns the target of a link.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **hdf5::node::Link**: The target of the link.

### Response Example
N/A

## throw_with_stack()

### Description
Throws an exception with stack trace information.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A (Throws exception)

### Response Example
N/A

## time_tracking()

### Description
Enables or disables time tracking for object creation.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **hdf5::property::ObjectCreationList**: The object creation property list.

### Response Example
N/A

## to_buffer()

### Description
Converts data to a buffer format.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **Buffer**: The data converted to a buffer.

### Response Example
N/A

## to_buffer_reshape()

### Description
Converts data to a buffer format with reshaping.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **Buffer**: The data converted to a buffer with reshaping.

### Response Example
N/A

## to_string()

### Description
Converts the version information to a string.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **std::string**: The string representation of the version.

### Response Example
N/A

## tracked()

### Description
Indicates whether creation order tracking is enabled.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **hdf5::property::CreationOrder**: The creation order property.

### Response Example
N/A

## type()

### Description
Returns the HDF5 datatype of the object.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **hdf5::datatype::DataType**: The HDF5 datatype.

### Response Example
N/A

## Type

### Description
Represents an HDF5 object handle.

### Method
N/A (Type Alias)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **hdf5::ObjectHandle**: The HDF5 object handle.

### Response Example
N/A

## TypeClass

### Description
Represents the class of an HDF5 datatype.

### Method
N/A (Type Alias)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **hdf5::datatype::TypeTrait< T >**: The HDF5 datatype class.

### Response Example
N/A

## TypeCreationList()

### Description
Constructor for TypeCreationList.

### Method
N/A (Constructor)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **hdf5::property::TypeCreationList**: A new TypeCreationList object.

### Response Example
N/A
```

--------------------------------

### H5Pcreate

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Creates a new property list.

```APIDOC
## H5Pcreate

### Description
Creates a new property list.

### Method
APIDOC

### Endpoint
H5Pcreate
```

--------------------------------

### Functions starting with 'd'

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/functions_func_d.html

This section details functions available in the h5cpp library that start with the letter 'd'. Each function is listed with the class it belongs to, providing a clear overview of its context and potential usage.

```APIDOC
## Functions starting with 'd'

This section details functions available in the h5cpp library that start with the letter 'd'. Each function is listed with the class it belongs to, providing a clear overview of its context and potential usage.

### - d -

*   **data()** : hdf5::ArrayAdapter< T >
    *   Description: Retrieves the underlying data array from an ArrayAdapter.
    *   Class: hdf5::ArrayAdapter< T >

*   **Dataset()** : hdf5::node::Dataset
    *   Description: Constructor for creating a Dataset object.
    *   Class: hdf5::node::Dataset

*   **DatasetAccessList()** : hdf5::property::DatasetAccessList
    *   Description: Constructor for creating a DatasetAccessList property.
    *   Class: hdf5::property::DatasetAccessList

*   **DatasetCreationList()** : hdf5::property::DatasetCreationList
    *   Description: Constructor for creating a DatasetCreationList property.
    *   Class: hdf5::property::DatasetCreationList

*   **DatasetTransferList()** : hdf5::property::DatasetTransferList
    *   Description: Constructor for creating a DatasetTransferList property.
    *   Class: hdf5::property::DatasetTransferList

*   **dataspace()** : hdf5::attribute::Attribute
    *   Description: Retrieves the dataspace of an attribute.
    *   Class: hdf5::attribute::Attribute

*   **Dataspace()** : hdf5::dataspace::Dataspace
    *   Description: Constructor for creating a Dataspace object.
    *   Class: hdf5::dataspace::Dataspace

*   **dataspace()** : hdf5::node::Dataset
    *   Description: Retrieves the dataspace of a dataset.
    *   Class: hdf5::node::Dataset

*   **DataspaceHolder()** : hdf5::dataspace::DataspaceHolder
    *   Description: Constructor for creating a DataspaceHolder object.
    *   Class: hdf5::dataspace::DataspaceHolder

*   **datatype()** : hdf5::attribute::Attribute
    *   Description: Retrieves the datatype of an attribute.
    *   Class: hdf5::attribute::Attribute

*   **Datatype()** : hdf5::datatype::Datatype
    *   Description: Constructor for creating a Datatype object.
    *   Class: hdf5::datatype::Datatype

*   **datatype()** : hdf5::node::Dataset
    *   Description: Retrieves the datatype of a dataset.
    *   Class: hdf5::node::Dataset

*   **DatatypeAccessList()** : hdf5::property::DatatypeAccessList
    *   Description: Constructor for creating a DatatypeAccessList property.
    *   Class: hdf5::property::DatatypeAccessList

*   **Deflate()** : hdf5::filter::Deflate
    *   Description: Applies the Deflate filter.
    *   Class: hdf5::filter::Deflate

*   **Descriptor()** : hdf5::error::Descriptor
    *   Description: Constructor for creating an error descriptor.
    *   Class: hdf5::error::Descriptor

*   **dimensions()** : hdf5::dataspace::Hyperslab, hdf5::dataspace::Points, hdf5::dataspace::Selection, hdf5::dataspace::Simple, hdf5::datatype::Array
    *   Description: Retrieves the dimensions of a dataspace or array datatype.
    *   Classes: hdf5::dataspace::Hyperslab, hdf5::dataspace::Points, hdf5::dataspace::Selection, hdf5::dataspace::Simple, hdf5::datatype::Array

*   **DirectDriver()** : hdf5::file::DirectDriver
    *   Description: Constructor for creating a DirectDriver file driver.
    *   Class: hdf5::file::DirectDriver

*   **disable_indexed()** : hdf5::property::CreationOrder
    *   Description: Disables indexed creation order property.
    *   Class: hdf5::property::CreationOrder

*   **disable_intermediate_group_creation()** : hdf5::property::LinkCreationList
    *   Description: Disables intermediate group creation for link creation.
    *   Class: hdf5::property::LinkCreationList

*   **disable_time_tracking()** : hdf5::property::ObjectCreationList
    *   Description: Disables time tracking for object creation.
    *   Class: hdf5::property::ObjectCreationList

*   **disable_tracked()** : hdf5::property::CreationOrder
    *   Description: Disables tracked creation order property.
    *   Class: hdf5::property::CreationOrder

*   **driver()** : hdf5::property::FileAccessList
    *   Description: Retrieves the file driver from a FileAccessList property.
    *   Class: hdf5::property::FileAccessList
```

--------------------------------

### Create a new HDF5 file

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/files.html

Create a new HDF5 file using `hdf5::file::create()`. By default, this will throw an exception if the file already exists.

```C++
#include <h5cpp/hdf5.hpp>
#include <boost/filesystem.hpp>

using namespace hdf5;
using namespace fs = boost::filesystem;

int main()
{
  //creating a new file
  fs::path file_path("data.h5");
  file::File f1 = file::create(file_path);

  //do something with the file
}

```

--------------------------------

### Get HDF5 Data Type

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/classhdf5_1_1datatype_1_1TypeTrait.html

Use the static `get` function to retrieve a constant reference to the HDF5 data type for a given C++ type `T`. This is efficient when the type is already known or has been created previously.

```cpp
template<typename T >
static const TypeClass & hdf5::datatype::TypeTrait< T >::get  ( const T &  = `T()` )
```

--------------------------------

### Namespace Members starting with 'v'

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/namespacemembers_v.html

This section details various members within the h5cpp namespaces that start with the letter 'v'. It covers data structures and views related to variable-length data and virtual data.

```APIDOC
## Namespace Members (v)

### Description
This page lists and describes namespace members beginning with the letter 'v' within the h5cpp C++ wrapper for the HDF5 library. It includes details on data buffers, string buffers, and virtual data views.

### Members

- **VarLengthDataBuffer** : `hdf5`
  - Description: Represents a variable-length data buffer.

- **VarLengthStringBuffer** : `hdf5`
  - Description: Represents a variable-length string buffer.

- **VirtualDataView** : `hdf5::property`
  - Description: Represents a view for virtual data within the property namespace.
```

--------------------------------

### Property List Constructor with Class

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/property__list_8hpp_source.html

Constructs a property list from a property list class.

```cpp
List(const Class &plist_class);
```

--------------------------------

### ObjectCreationList Methods

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/classhdf5_1_1property_1_1TypeCreationList.html

Documentation for methods inherited from the ObjectCreationList base class.

```APIDOC
## Inherited from hdf5::property::ObjectCreationList

### Methods

*   **ObjectCreationList()**
    *   Description: Constructor.

*   **ObjectCreationList(const ObjectCreationList &) = default**
    *   Description: Copy constructor.

*   **~ObjectCreationList() override**
    *   Description: Destructor.

*   **ObjectCreationList(ObjectHandle &&handle)**
    *   Description: Constructor that takes an ObjectHandle.

*   **enable_time_tracking() const**
    *   Description: Enable object time tracking.

*   **disable_time_tracking() const**
    *   Description: Disable object time tracking.

*   **time_tracking() const**
    *   Description: Return time tracking status.
    *   Returns: bool

*   **attribute_creation_order(const CreationOrder &order) const**
    *   Description: Set the attribute creation order.

*   **attribute_creation_order() const**
    *   Description: Retrieve current attribute creation order.
    *   Returns: CreationOrder

*   **attribute_storage_thresholds(unsigned max_compact, unsigned min_dense) const**
    *   Description: Set storage layout thresholds.

*   **attribute_storage_maximum_compact() const**
    *   Description: Get upper threshold for compact storage.
    *   Returns: unsigned

*   **attribute_storage_minimum_dense() const**
    *   Description: Get lower threshold for dense threshold.
    *   Returns: unsigned
```

--------------------------------

### Namespace Members starting with 'o'

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/namespacemembers_o.html

This section details various members within the h5cpp namespaces that start with the letter 'o'. It includes functions like 'open()' and overloaded operators for different types, as well as the 'Order' enumeration.

```APIDOC
## Namespace Members starting with 'o'

This section details various members within the h5cpp namespaces that start with the letter 'o'. It includes functions like 'open()' and overloaded operators for different types, as well as the 'Order' enumeration.

### open()

- **Namespace:** hdf5::file
- **Description:** Opens an HDF5 file.

### operator!=()

- **Namespace:** hdf5::datatype, hdf5::filter, hdf5::node, hdf5, hdf5::property
- **Description:** Not equal to operator for comparing various h5cpp objects.

### operator&()

- **Namespace:** hdf5::file, hdf5::filter, hdf5::property
- **Description:** Bitwise AND operator, likely for property manipulation.

### operator+()

- **Namespace:** hdf5
- **Description:** Addition operator for hdf5 objects.

### operator-()

- **Namespace:** hdf5
- **Description:** Subtraction operator for hdf5 objects.

### operator<()

- **Namespace:** hdf5
- **Description:** Less than operator for hdf5 objects.

### operator<<()

- **Namespace:** hdf5::dataspace, hdf5::datatype, hdf5::error, hdf5::file, hdf5::filter, hdf5::node, hdf5, hdf5::property
- **Description:** Stream insertion operator for outputting various h5cpp objects.

### operator<=()

- **Namespace:** hdf5
- **Description:** Less than or equal to operator for hdf5 objects.

### operator==()

- **Namespace:** hdf5::datatype, hdf5::filter, hdf5::node, hdf5, hdf5::property
- **Description:** Equal to operator for comparing various h5cpp objects.

### operator>()

- **Namespace:** hdf5
- **Description:** Greater than operator for hdf5 objects.

### operator>=()

- **Namespace:** hdf5
- **Description:** Greater than or equal to operator for hdf5 objects.

### operator|()

- **Namespace:** hdf5::dataspace, hdf5::file, hdf5::filter, hdf5::property
- **Description:** Bitwise OR operator, likely for property manipulation.

### operator||()

- **Namespace:** hdf5::dataspace
- **Description:** Logical OR operator for hdf5::dataspace.

### Order

- **Namespace:** hdf5::datatype
- **Description:** Enumeration type for specifying data order.
```

--------------------------------

### Attribute Creation Order and Storage Thresholds

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/classhdf5_1_1property_1_1DatasetCreationList.html

Documentation for setting and retrieving attribute creation order and storage thresholds.

```APIDOC
## void attribute_creation_order(const CreationOrder &order) const

set the attribute creation order

## CreationOrder attribute_creation_order() const

retrieve current attribute creation order

## void attribute_storage_thresholds(unsigned max_compact, unsigned min_dense) const

set storage layout thresholds

## unsigned attribute_storage_maximum_compact() const

get upper threshold for compact storage

## unsigned attribute_storage_minimum_dense() const

get lower threshold for dense threshold
```

--------------------------------

### Functions starting with 'v'

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/functions_func_v.html

This section lists all functions in the h5cpp library that start with the letter 'v'. Each entry includes the function name, its return type, and the class it belongs to, providing a quick reference for developers.

```APIDOC
## Functions starting with 'v'

### Description
This section lists all functions in the h5cpp library that start with the letter 'v'. Each entry includes the function name, its return type, and the class it belongs to, providing a quick reference for developers.

### Functions

* **value()** : `hdf5::datatype::Enum`
* **variable()** : `hdf5::datatype::String`
* **Version()** : `hdf5::Version`
* **View()** : `hdf5::dataspace::View`
* **virtual_view()** : `hdf5::property::DatasetAccessList`
* **VirtualDataMap()** : `hdf5::property::VirtualDataMap`
* **VirtualDataset()** : `hdf5::node::VirtualDataset`
* **VLengthArray()** : `hdf5::datatype::VLengthArray`
```

--------------------------------

### Storing and Applying Multiple Selections

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/dataspace_selections.html

Demonstrates how to create a list of selection pairs, each with an operation and a selection pointer, and then apply them sequentially to a dataspace.

```cpp
dataspace::SelectionList selections;
selections.push_back({dataspace::SelectionOperation::Set,
                      Selection::SharedPointer(new dataspace::Hyperslab({0,0},{100,100}))});
selections.push_back({dataspace::SelectionOperation::Or,
                      Selection::SharedPointer(new dataspace::Hyperslab({200,129},{100,100}))});

dataspace::Simple space = ...;

for(auto selection: selections)
    selection.second->apply(space,selection.first);

```

--------------------------------

### H5Pget_vol_info

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets VOL information.

```APIDOC
## H5Pget_vol_info

### Description
Gets VOL information.

### Method
APIDOC

### Endpoint
H5Pget_vol_info
```

--------------------------------

### H5Pget_vol_id

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets the VOL identifier.

```APIDOC
## H5Pget_vol_id

### Description
Gets the VOL identifier.

### Method
APIDOC

### Endpoint
H5Pget_vol_id
```

--------------------------------

### Create File from Buffer (Datatype and Dataspace)

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/file_2functions_8hpp_source.html

Creates an HDF5 file from a buffer with explicit memory datatype and dataspace, and ImageFlagsBase.

```cpp
template<typename T>
File from_buffer(T &data,
 const datatype::Datatype &mem_type,
 const dataspace::Dataspace &mem_space,
 ImageFlagsBase flags);
```

--------------------------------

### Building the Project with CMake

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/using.html

Commands to build a C++ project using h5cpp with CMake. This involves creating a build directory, configuring CMake with the installation path of h5cpp, and then compiling the project.

```bash
h5cpp_test:$ mkdir build
h5cpp_test:$ cd build
h5cpp_test:$ cmake -Dh5cpp_DIR=<INSTALLPREFIX>/lib/cmake/h5cpp-0.8.0 ../
h5cpp_test:$ make

```

--------------------------------

### H5Pget_sizes

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets the sizes of properties.

```APIDOC
## H5Pget_sizes

### Description
Gets the sizes of properties.

### Method
APIDOC

### Endpoint
H5Pget_sizes
```

--------------------------------

### H5Pget_size

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets the size of a property.

```APIDOC
## H5Pget_size

### Description
Gets the size of a property.

### Method
APIDOC

### Endpoint
H5Pget_size
```

--------------------------------

### Include Headers for C-style Array Adapter

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/advanced/c_arrays.html

Include the necessary headers for using h5cpp and the array adapter utility.

```cpp
#include <h5cpp/hdf5.hpp>
#include <h5cpp/utilities/array_adapter.hpp>

```

--------------------------------

### H5Pget_preserve

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets the preserve property.

```APIDOC
## H5Pget_preserve

### Description
Gets the preserve property.

### Method
APIDOC

### Endpoint
H5Pget_preserve
```

--------------------------------

### Reading and Writing Entire Dataset

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/datasets.html

Demonstrates how to read from or write to an entire dataset using the read() and write() methods. Ensure the dataset is accessible via its name in the group.

```c++
dataset_t dset = group["temperatures"];

std::vector<double> temperatures;
dset.read(temperatures);

//or for writing
dset.write(temperatures)
```

--------------------------------

### Pseudocode for Dataset Creation

Source: https://ess-dmsc.github.io/h5cpp/latest/users_guide/datasets.html

Illustrates the basic structure for creating a dataset within a group. The exact signature for create_dataset() is still under development.

```pseudocode
dataset_t dset = group.create_dataset(...);
```

--------------------------------

### H5Pget_nprops

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets the number of properties.

```APIDOC
## H5Pget_nprops

### Description
Gets the number of properties.

### Method
APIDOC

### Endpoint
H5Pget_nprops
```

--------------------------------

### FileCreationList Constructors

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/classhdf5_1_1property_1_1FileCreationList.html

Provides documentation for the constructors of the FileCreationList class, including the default constructor, a constructor taking an ObjectHandle, and a copy constructor.

```APIDOC
## Constructors

### FileCreationList()
Default constructor.

### FileCreationList(ObjectHandle &&handle)
Constructor that takes an r-value reference to an ObjectHandle instance. This constructor will throw an exception if the handle does not reference a file creation property list.

**Parameters:**
* **handle** (ObjectHandle &&) - An r-value reference to a handle instance.

**Exceptions:**
* std::runtime_error: In case of a failure.
```

--------------------------------

### H5Pget_nlinks

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets the number of links.

```APIDOC
## H5Pget_nlinks

### Description
Gets the number of links.

### Method
APIDOC

### Endpoint
H5Pget_nlinks
```

--------------------------------

### FileCreationList()

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/functions_f.html

Constructor for FileCreationList property list.

```APIDOC
## FileCreationList()

### Description
Constructor for FileCreationList property list.

### Method
N/A (Constructor)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **hdf5::property::FileCreationList**: An instance of the FileCreationList.
```

--------------------------------

### H5Pget_multi_type

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets the multi-file type.

```APIDOC
## H5Pget_multi_type

### Description
Gets the multi-file type.

### Method
APIDOC

### Endpoint
H5Pget_multi_type
```

--------------------------------

### H5Pget_mpi_params

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets MPI parameters.

```APIDOC
## H5Pget_mpi_params

### Description
Gets MPI parameters.

### Method
APIDOC

### Endpoint
H5Pget_mpi_params
```

--------------------------------

### create() function

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/namespace_file.html

Creates a new HDF5 file at the specified path with given access flags and properties.

```APIDOC
## create()

### Description
Creates a new HDF5 file.

### Signature
File hdf5::file::create(const fs::path &path, AccessFlags flags = AccessFlags::Exclusive, const property::FileCreationList &fcpl = property::FileCreationList(), const property::FileAccessList &fapl = property::FileAccessList())

### Parameters
- **path** (const fs::path &): The path to the new file.
- **flags** (AccessFlags): HDF5 file creation flags (defaults to Exclusive).
- **fcpl** (const property::FileCreationList &): File creation property list (defaults to empty).
- **fapl** (const property::FileAccessList &): File access property list (defaults to empty).

### Throws
std::runtime_error: In case of a failure.

### Returns
A new instance of File.
```

--------------------------------

### H5Pget_mdc_config

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets the MDC configuration.

```APIDOC
## H5Pget_mdc_config

### Description
Gets the MDC configuration.

### Method
APIDOC

### Endpoint
H5Pget_mdc_config
```

--------------------------------

### SZip Constructors

Source: https://ess-dmsc.github.io/h5cpp/v0.8.0/api_reference/doxygen/classhdf5_1_1filter_1_1SZip-members.html

Provides documentation for the various constructors of the SZip class, enabling initialization with different option masks and pixel block sizes.

```APIDOC
## SZip Constructors

### Description
Constructors for the `hdf5::filter::SZip` class.

### Methods
- `SZip()`
- `SZip(OptionMask option_mask, unsigned int pixels_per_block)`
- `SZip(OptionMaskBase option_mask, unsigned int pixels_per_block)`
```

--------------------------------

### H5Pget_layout

Source: https://ess-dmsc.github.io/h5cpp/latest/capi/H5P.html

Gets the layout property.

```APIDOC
## H5Pget_layout

### Description
Gets the layout property.

### Method
APIDOC

### Endpoint
H5Pget_layout
```

--------------------------------

### File()

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/functions_f.html

Constructor for the HDF5 File class.

```APIDOC
## File()

### Description
Constructor for the HDF5 File class.

### Method
N/A (Constructor)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **hdf5::file::File**: An instance of the File class.
```

--------------------------------

### Create File from Buffer (ImageFlags) - Implementation

Source: https://ess-dmsc.github.io/h5cpp/latest/api_reference/doxygen/file_2functions_8hpp_source.html

Helper function to create an HDF5 file from a buffer, casting ImageFlags to ImageFlagsBase.

```cpp
template<typename T>
File from_buffer(T &data, ImageFlags flags)
{
 return from_buffer(data, static_cast<ImageFlagsBase>(flags));
}
```
Tokens:
Raw