VTK  9.3.20240412
Static Public Member Functions | List of all members
vtkHDF5Helper Class Reference

Helper class used to read hdf5 file format. More...

#include <vtkHDF5Helper.h>

Static Public Member Functions

static std::vector< std::string > GetChildren (const hid_t &id, const std::string &name)
 Get childs of a specific group name and id. More...
 
static std::string GetPathFromName (const hid_t &id, const std::string &path, const std::string &name)
 Get the relative path for a name based on the id. More...
 
static bool ArrayExists (hid_t fileId, const char *pathName)
 Check existence of array defined by pathName relative to fileId. More...
 
static bool GroupExists (int64_t fileId, const char *groupName)
 Check existence of group defined by groupName relative to fileId. More...
 
static hsize_t GetDataLength (hid_t arrayId)
 Get length of array defined by arrayId. More...
 
static std::vector< hsize_t > GetDataDimensions (hid_t arrayId)
 Get dimension of array defined by arrayId. More...
 
static herr_t FileInfoCallBack (hid_t, const char *name, void *opdata)
 FileInfo() is a callback function for H5Giterate(). More...
 
static vtkAbstractArrayCreateDataArray (const hid_t &fileId, const std::string &pathName)
 Create an appropriate data array based on fileId and the array defined by pathName. More...
 
static vtkAbstractArrayCreateDataArray (const hid_t &fileId, const std::string &path, const std::string &dataSetName)
 Create an appropriate data array based on fileId and the array defined by pathName. More...
 

Detailed Description

Helper class used to read hdf5 file format.

Definition at line 23 of file vtkHDF5Helper.h.

Member Function Documentation

◆ GetChildren()

static std::vector<std::string> vtkHDF5Helper::GetChildren ( const hid_t id,
const std::string &  name 
)
static

Get childs of a specific group name and id.

◆ GetPathFromName()

static std::string vtkHDF5Helper::GetPathFromName ( const hid_t id,
const std::string &  path,
const std::string &  name 
)
static

Get the relative path for a name based on the id.

◆ ArrayExists()

static bool vtkHDF5Helper::ArrayExists ( hid_t  fileId,
const char *  pathName 
)
static

Check existence of array defined by pathName relative to fileId.

◆ GroupExists()

static bool vtkHDF5Helper::GroupExists ( int64_t  fileId,
const char *  groupName 
)
static

Check existence of group defined by groupName relative to fileId.

◆ GetDataLength()

static hsize_t vtkHDF5Helper::GetDataLength ( hid_t  arrayId)
static

Get length of array defined by arrayId.

◆ GetDataDimensions()

static std::vector<hsize_t> vtkHDF5Helper::GetDataDimensions ( hid_t  arrayId)
static

Get dimension of array defined by arrayId.

◆ CreateDataArray() [1/2]

static vtkAbstractArray* vtkHDF5Helper::CreateDataArray ( const hid_t fileId,
const std::string &  pathName 
)
static

Create an appropriate data array based on fileId and the array defined by pathName.

◆ CreateDataArray() [2/2]

static vtkAbstractArray* vtkHDF5Helper::CreateDataArray ( const hid_t fileId,
const std::string &  path,
const std::string &  dataSetName 
)
static

Create an appropriate data array based on fileId and the array defined by pathName.

◆ FileInfoCallBack()

static herr_t vtkHDF5Helper::FileInfoCallBack ( hid_t  ,
const char *  name,
void *  opdata 
)
static

FileInfo() is a callback function for H5Giterate().


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