echelon  0.8.0
Public Member Functions | List of all members
echelon::hdf5::dimension Class Reference

Handle to a dataset dimension. More...

#include <dataset_dimensions.hpp>

Public Member Functions

dimension_scale attach_dimension_scale (const std::string &scale_name, object location, const std::string &dataset_name, const type &datatype, const std::vector< hsize_t > &extent)
 Attach a new dimension scale to this dimension. More...
 
template<typename T >
dimension_scale attach_dimension_scale (const std::string &scale_name, object location, const std::string &dataset_name, const std::vector< hsize_t > &extent)
 Attach a new dimension scale to this dimension. More...
 
std::string label () const
 The label of the dimension.
 
void relabel (const std::string &new_label)
 Relabel the dimension. More...
 
hsize_t extend () const
 The extend of the dimension.
 

Detailed Description

Handle to a dataset dimension.

Member Function Documentation

dimension_scale echelon::hdf5::dimension::attach_dimension_scale ( const std::string &  scale_name,
object  location,
const std::string &  dataset_name,
const type datatype,
const std::vector< hsize_t > &  extent 
)

Attach a new dimension scale to this dimension.

Parameters
scale_nameName of the new dimension scale
locationLocation of the new dataset
dataset_nameName of the dimension scale's dataset
datatypeDatatype of the new dimension scale
extentExtent of the dimension scale
Returns
a handle to the new dimension scale.
template<typename T >
dimension_scale echelon::hdf5::dimension::attach_dimension_scale ( const std::string &  scale_name,
object  location,
const std::string &  dataset_name,
const std::vector< hsize_t > &  extent 
)
inline

Attach a new dimension scale to this dimension.

Parameters
scale_nameName of the new dimension scale
locationLocation of the new dataset
dataset_nameName of the dimension scale's dataset
extentExtent of the dimension scale
Template Parameters
TC++ type, which should be used to determine the dimension scale's value typele
Returns
a handle to the new dimension scale.
void echelon::hdf5::dimension::relabel ( const std::string &  new_label)

Relabel the dimension.

Parameters
new_labelNew label of the dimension

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