vtkHDFUtilities.h File Reference

#include "vtkDataArray.h"
#include "vtkHDF5ScopedHandle.h"
#include "vtkIOHDFModule.h"
#include "vtkLogger.h"
#include "vtkPolyData.h"
#include "vtkSmartPointer.h"
#include "vtkStringArray.h"
#include "vtkType.h"
#include <array>
#include <string>
#include <vector>
#include "vtkHDFUtilities.txx"

Include dependency graph for vtkHDFUtilities.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	vtkHDFUtilities::TransientGeometryOffsets
struct	vtkHDFUtilities::TemporalGeometryOffsets

Namespaces
namespace	vtkHDFUtilities
	Common utility variables and functions for reader and writer of vtkHDF.

Functions
static constexpr int	vtkHDFUtilities::GetNumberOfAttributeTypes ()
static constexpr int	vtkHDFUtilities::GetNumberOfDataArrayTypes ()
VTKIOHDF_EXPORT void	vtkHDFUtilities::MakeObjectNameValid (std::string &objectName)
VTKIOHDF_EXPORT hid_t	vtkHDFUtilities::getH5TypeFromVtkType (int dataType)
VTKIOHDF_EXPORT bool	vtkHDFUtilities::Open (const char *fileName, hid_t &fileID)
	Open a VTK HDF file and checks if it is valid.
template<typename T >
VTKIOHDF_EXPORT hid_t	vtkHDFUtilities::TemplateTypeToHdfNativeType ()
	Convert C++ template type T to HDF5 native type this can be constexpr in C++17 standard.
template<typename T >
VTKIOHDF_EXPORT bool	vtkHDFUtilities::GetAttribute (hid_t group, const char *attributeName, size_t numberOfElements, T *value)
	Reads an attribute from the group passed to it.
VTKIOHDF_EXPORT std::size_t	vtkHDFUtilities::GetNumberOfSteps (hid_t groupID)
	Read the number of steps of an HDF group.
VTKIOHDF_EXPORT std::vector< hsize_t >	vtkHDFUtilities::GetDimensions (hid_t fileID, const char *datasetName)
	Returns the dimensions of a HDF dataset of a file.
VTKIOHDF_EXPORT bool	vtkHDFUtilities::RetrieveHDFInformation (hid_t &fileID, hid_t &groupID, const std::string &rootName, std::array< int, 2 > &version, int &dataSetType, int &numberOfPieces, std::array< hid_t, 3 > &attributeDataGroup)
	Initialize meta information of the file.
VTKIOHDF_EXPORT herr_t	vtkHDFUtilities::FileInfoCallBack (hid_t loc_id, const char *name, const H5L_info_t *info, void *opdata)
	Convenient callback method to retrieve a name when calling a H5Giterate()
VTKIOHDF_EXPORT std::vector< std::string >	vtkHDFUtilities::GetArrayNames (const std::array< hid_t, 3 > &attributeDataGroup, int attributeType)
	Returns the names of arrays for 'attributeType' (point or cell).
VTKIOHDF_EXPORT std::vector< std::string >	vtkHDFUtilities::GetOrderedChildrenOfGroup (hid_t groupID, const std::string &path)
	Return the name of all children of an HDF group given its path.
VTKIOHDF_EXPORT hid_t	vtkHDFUtilities::OpenDataSet (hid_t group, const char *name, hid_t *nativeType, std::vector< hsize_t > &dims)
	Opens the hdf5 dataset given the 'group' and 'name'.
VTKIOHDF_EXPORT std::vector< vtkIdType >	vtkHDFUtilities::GetMetadata (hid_t group, const char *name, hsize_t size, hsize_t offset)
	Reads a 1D metadata array in a DataArray or a vector of vtkIdType.
VTKIOHDF_EXPORT std::array< vtkIdType, 2 >	vtkHDFUtilities::GetFieldArraySize (hid_t group, vtkIdType step, std::string name)
	Return the field array size (components, tuples) for the HDF group.
VTKIOHDF_EXPORT vtkIdType	vtkHDFUtilities::GetArrayOffset (hid_t group, vtkIdType step, int attributeType, std::string name)
	Methods to query for array offsets for the HDF group when steps are present.
VTKIOHDF_EXPORT vtkAbstractArray *	vtkHDFUtilities::NewFieldArray (const std::array< hid_t, 3 > &attributeDataGroup, const char *name, vtkIdType offset, vtkIdType size, vtkIdType dimMaxSize)
	Reads and returns a new vtkAbstractArray.
VTKIOHDF_EXPORT vtkStringArray *	vtkHDFUtilities::NewStringArray (hid_t dataset, std::vector< hsize_t > dims, std::vector< hsize_t > fileExtent)
VTKIOHDF_EXPORT vtkDataArray *	vtkHDFUtilities::NewArrayForGroup (hid_t dataset, hid_t nativeType, const std::vector< hsize_t > &dims, const std::vector< hsize_t > &parameterExtent)
	Reads a vtkDataArray of type T from the attributeType, dataset The array has type 'T' and 'numberOfComponents'.
VTKIOHDF_EXPORT vtkDataArray *	vtkHDFUtilities::NewArrayForGroup (hid_t group, const char *name, const std::vector< hsize_t > &parameterExtent)
	Reads a vtkDataArray of type T from the attributeType, dataset The array has type 'T' and 'numberOfComponents'.

Variables
const std::string	vtkHDFUtilities::VTKHDF_ROOT_PATH = "/VTKHDF"
constexpr std::size_t	vtkHDFUtilities::NUM_POLY_DATA_TOPOS = 4
const std::vector< std::string >	vtkHDFUtilities::POLY_DATA_TOPOS { "Vertices", "Lines", "Polygons", "Strips" }
constexpr int	vtkHDFUtilities::GEOMETRY_ATTRIBUTE_TAG = -42