echelon  0.8.0
Public Types | Public Member Functions | Friends | List of all members
echelon::scalar_dataset Class Reference

A handle to an HDF5 scalar dataset. More...

#include <scalar_dataset.hpp>

Public Types

using native_handle_type = hdf5::group
 Type of the underlying HDF5 low-level handle.
 

Public Member Functions

 scalar_dataset ()=default
 Initializes the handle with its null state.
 
type datatype () const
 The value type of the scalar dataset.
 
object_reference ref () const
 A HDF5 object reference to this scalar dataset.
 
native_handle_type native_handle () const
 The underlying HDF5 low-level handle.
 
 operator bool () const
 Tests the validity of the handle.
 
attribute_repository< scalar_datasetattributes () const
 The attributes, which are attached to the scalar dataset.
 

Friends

template<typename T >
void operator<<= (scalar_dataset &sink, const T &value)
 Writes the content of a variable into the scalar dataset. More...
 
template<typename T >
void operator<<= (T &value, const scalar_dataset &source)
 Reads the content of the scalar dataset into a variable. More...
 

Detailed Description

A handle to an HDF5 scalar dataset.

Friends And Related Function Documentation

template<typename T >
void operator<<= ( scalar_dataset sink,
const T &  value 
)
friend

Writes the content of a variable into the scalar dataset.

Template Parameters
TType of the written value.
Parameters
sinkthe scalar dataset, which is used as a sink
valuevalue, which is written into the dataset
template<typename T >
void operator<<= ( T &  value,
const scalar_dataset source 
)
friend

Reads the content of the scalar dataset into a variable.

Template Parameters
TType of the read value.
Parameters
valuevalue, which is read from the dataset
sourcethe scalar dataset, which is used as a source

The documentation for this class was generated from the following files: