MDAL
Public Member Functions | List of all members
MDAL::XmdfDataset Class Reference

The XmdfDataset reads the data directly from HDF5 file by usage of hyperslabs retrieval. More...

#include <mdal_xmdf.hpp>

Inheritance diagram for MDAL::XmdfDataset:
MDAL::Dataset2D MDAL::Dataset

Public Member Functions

 XmdfDataset (DatasetGroup *grp, const HdfDataset &valuesDs, const HdfDataset &activeDs, hsize_t timeIndex)
 
size_t scalarData (size_t indexStart, size_t count, double *buffer) override
 For DataOnVertices or DataOnFaces.
 
size_t vectorData (size_t indexStart, size_t count, double *buffer) override
 For DataOnVertices or DataOnFaces.
 
size_t activeData (size_t indexStart, size_t count, int *buffer) override
 For drivers that supports it, see supportsActiveFlag()
 
const HdfDatasetdsValues () const
 
const HdfDatasetdsActive () const
 
hsize_t timeIndex () const
 
- Public Member Functions inherited from MDAL::Dataset2D
 Dataset2D (DatasetGroup *parent)
 
size_t verticalLevelCountData (size_t indexStart, size_t count, int *buffer) override
 For DataOnVolumes.
 
size_t verticalLevelData (size_t indexStart, size_t count, double *buffer) override
 For DataOnVolumes.
 
size_t faceToVolumeData (size_t indexStart, size_t count, int *buffer) override
 For DataOnVolumes.
 
size_t scalarVolumesData (size_t indexStart, size_t count, double *buffer) override
 For DataOnVolumes.
 
size_t vectorVolumesData (size_t indexStart, size_t count, double *buffer) override
 For DataOnVolumes.
 
size_t volumesCount () const override
 
size_t maximumVerticalLevelsCount () const override
 
- Public Member Functions inherited from MDAL::Dataset
 Dataset (DatasetGroup *parent)
 
size_t valuesCount () const
 
Statistics statistics () const
 
void setStatistics (const Statistics &statistics)
 
bool isValid () const
 
DatasetGroupgroup () const
 
Meshmesh () const
 
double time (RelativeTimestamp::Unit unit) const
 
RelativeTimestamp timestamp () const
 
void setTime (double time, RelativeTimestamp::Unit unit=RelativeTimestamp::hours)
 
void setTime (const RelativeTimestamp &time)
 
bool supportsActiveFlag () const
 
void setSupportsActiveFlag (bool value)
 

Detailed Description

The XmdfDataset reads the data directly from HDF5 file by usage of hyperslabs retrieval.

This format is used by TUFLOW and HYDRO_AS-2D basically all (timesteps) data for one particular dataset groups are stored in single 3D arrays (time, x, y) for vector datasets 2D arrays (time, x) for scalar datasets 2D arrays (time, active) for active flags (optional, supported by default)

For TUFLOW, the dataset groups are structured with a tree starting from a unique group and datasets support active flag value.

For HYDRO_AS-2D, all the groups are on the root of the file and the datasets don't support active flag value.


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