Class representing the space (dimensions) of a dataset.
More...
#include <H5DataSpace.hpp>
|
| DataSpace (const std::vector< size_t > &dims) |
|
template<size_t N> |
| DataSpace (const std::array< size_t, N > &dims) |
|
| DataSpace (const std::initializer_list< size_t > &items) |
|
template<typename... Args> |
| DataSpace (size_t dim1, Args... dims) |
|
template<typename IT , typename = typename std::enable_if<!std::is_integral<IT>::value, IT>::type> |
| DataSpace (const IT begin, const IT end) |
|
| DataSpace (const std::vector< size_t > &dims, const std::vector< size_t > &maxdims) |
| Create a resizable N-dimensional dataspace.
|
|
| DataSpace (DataspaceType dtype) |
| DataSpace create a scalar dataspace or a null dataset.
|
|
DataSpace | clone () const |
|
size_t | getNumberDimensions () const |
| getNumberDimensions
|
|
std::vector< size_t > | getDimensions () const |
| getDimensions
|
|
size_t | getElementCount () const |
| getElementCount
|
|
std::vector< size_t > | getMaxDimensions () const |
| getMaxDimensions
|
|
| Object (Object &&other) noexcept |
|
| ~Object () |
|
bool | isValid () const noexcept |
| isValid
|
|
hid_t | getId () const noexcept |
| getId
|
|
ObjectInfo | getInfo () const |
| Retrieve several infos about the current object (address, dates, etc)
|
|
ObjectType | getType () const |
| Gets the fundamental type of the object (dataset, group, etc)
|
|
bool | operator== (const Object &other) const noexcept |
|
|
template<typename T > |
static DataSpace | From (const T &value) |
| Create a dataspace matching a type accepted by details::inspector.
|
|
template<std::size_t N, std::size_t Width> |
static DataSpace | FromCharArrayStrings (const char(&)[N][Width]) |
|
Class representing the space (dimensions) of a dataset.
◆ DataspaceType
dataspace type
Enumerator |
---|
dataspace_scalar | |
dataspace_null | |
◆ DataSpace() [1/8]
HighFive::DataSpace::DataSpace |
( |
const std::vector< size_t > & |
dims | ) |
|
|
inlineexplicit |
create a dataspace of N-dimensions Each dimension is configured this way size(dim1) = vec[0] size(dim2) = vec[1] etc...
◆ DataSpace() [2/8]
template<size_t N>
HighFive::DataSpace::DataSpace |
( |
const std::array< size_t, N > & |
dims | ) |
|
|
inlineexplicit |
◆ DataSpace() [3/8]
HighFive::DataSpace::DataSpace |
( |
const std::initializer_list< size_t > & |
items | ) |
|
|
inline |
Make sure that DataSpace({1,2,3}) works on GCC. This is the shortcut form of the vector initializer, but one some compilers (gcc) this does not resolve correctly without this constructor.
◆ DataSpace() [4/8]
template<typename... Args>
HighFive::DataSpace::DataSpace |
( |
size_t |
dim1, |
|
|
Args... |
dims |
|
) |
| |
|
inlineexplicit |
Allow directly listing 1 or more dimensions to initialize, that is, DataSpace(1,2) means DataSpace(std::vector<size_t>{1,2}).
◆ DataSpace() [5/8]
template<class IT , typename >
HighFive::DataSpace::DataSpace |
( |
const IT |
begin, |
|
|
const IT |
end |
|
) |
| |
|
inline |
Create a dataspace from an iterator pair
Explicitly disable DataSpace(int_like, int_like) from trying to use this constructor
◆ DataSpace() [6/8]
HighFive::DataSpace::DataSpace |
( |
const std::vector< size_t > & |
dims, |
|
|
const std::vector< size_t > & |
maxdims |
|
) |
| |
|
inlineexplicit |
Create a resizable N-dimensional dataspace.
- Parameters
-
dims | Initial size of dataspace |
maxdims | Maximum size of the dataspace |
◆ DataSpace() [7/8]
DataSpace create a scalar dataspace or a null dataset.
◆ DataSpace() [8/8]
HighFive::DataSpace::DataSpace |
( |
| ) |
|
|
protecteddefault |
◆ clone()
DataSpace HighFive::DataSpace::clone |
( |
| ) |
const |
|
inline |
Create a new DataSpace with a different id available for modifications
◆ From()
template<typename T >
DataSpace HighFive::DataSpace::From |
( |
const T & |
value | ) |
|
|
inlinestatic |
Create a dataspace matching a type accepted by details::inspector.
◆ FromCharArrayStrings()
template<std::size_t N, std::size_t Width>
DataSpace HighFive::DataSpace::FromCharArrayStrings |
( |
const |
char(&)[N][Width] | ) |
|
|
inlinestatic |
◆ getDimensions()
std::vector< size_t > HighFive::DataSpace::getDimensions |
( |
| ) |
const |
|
inline |
getDimensions
- Returns
- return a vector of N-element, each element is the size of the associated dataset dimension
◆ getElementCount()
size_t HighFive::DataSpace::getElementCount |
( |
| ) |
const |
|
inline |
getElementCount
- Returns
- the total number of elements in the dataspace
◆ getMaxDimensions()
std::vector< size_t > HighFive::DataSpace::getMaxDimensions |
( |
| ) |
const |
|
inline |
getMaxDimensions
- Returns
- return a vector of N-element, each element is the size of the associated dataset maximum dimension
◆ getNumberDimensions()
size_t HighFive::DataSpace::getNumberDimensions |
( |
| ) |
const |
|
inline |
getNumberDimensions
- Returns
- the number of dimensions in the current dataspace
◆ Attribute
◆ DataSet
◆ File
◆ type
◆ UNLIMITED
const size_t HighFive::DataSpace::UNLIMITED = SIZE_MAX |
|
static |
The documentation for this class was generated from the following files: