HighFive 2.3.1
HighFive - Header-only C++ HDF5 interface
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
HighFive::Selection Class Reference

Selection: represent a view on a slice/part of a dataset. More...

#include <H5Selection.hpp>

Inheritance diagram for HighFive::Selection:
Inheritance graph
[legend]
Collaboration diagram for HighFive::Selection:
Collaboration graph
[legend]

Public Member Functions

DataSpace getSpace () const noexcept
 getSpace
 
DataSpace getMemSpace () const noexcept
 getMemSpace
 
DataSet & getDataset () noexcept
 getDataSet
 
const DataSet & getDataset () const noexcept
 
const DataType getDataType () const
 return the datatype of the selection
 
- Public Member Functions inherited from HighFive::SliceTraits< Selection >
Selection select (const std::vector< size_t > &offset, const std::vector< size_t > &count, const std::vector< size_t > &stride=std::vector< size_t >()) const
 Select a region in the current Slice/Dataset of count points at offset separated by stride. If strides are not provided they will default to 1 in all dimensions.
 
Selection select (const std::vector< size_t > &columns) const
 Select a set of columns in the last dimension of this dataset.
 
Selection select (const ElementSet &elements) const
 Select a region in the current Slice/Dataset out of a list of elements.
 
void read (T &array) const
 
void read (T *array, const DataType &dtype=DataType()) const
 
void write (const T &buffer)
 
void write_raw (const T *buffer, const DataType &dtype=DataType())
 

Friends

template<typename Derivate >
class ::HighFive::SliceTraits
 

Detailed Description

Selection: represent a view on a slice/part of a dataset.

A Selection is valid only if its parent dataset is valid

Member Function Documentation

◆ getDataset() [1/2]

const DataSet & HighFive::Selection::getDataset ( ) const
inlinenoexcept

◆ getDataset() [2/2]

DataSet & HighFive::Selection::getDataset ( )
inlinenoexcept

getDataSet

Returns
parent dataset of this selection

◆ getDataType()

const DataType HighFive::Selection::getDataType ( ) const
inline

return the datatype of the selection

Returns
return the datatype of the selection

◆ getMemSpace()

DataSpace HighFive::Selection::getMemSpace ( ) const
inlinenoexcept

getMemSpace

Returns
Dataspace associated with the memory representation of this selection

◆ getSpace()

DataSpace HighFive::Selection::getSpace ( ) const
inlinenoexcept

getSpace

Returns
Dataspace associated with this selection

Friends And Related Function Documentation

◆ ::HighFive::SliceTraits

template<typename Derivate >
friend class ::HighFive::SliceTraits
friend
The documentation for this class was generated from the following files: