WxHdf5IoTmpl does the reading and writing to HDF5 files for a given data type. More...

#include <wxhdf5iotmpl.h>

Inheritance diagram for WxHdf5IoTmpl:

Detailed Description

WxHdf5IoTmpl does the reading and writing to HDF5 files for a given data type.

Public Member Functions
	WxHdf5IoTmpl ()
	Constructor.

virtual	~WxHdf5IoTmpl ()
	Virtual destructor.

virtual WxIoNodeType	writeDataSet (WxIoNodeType node, const std::string &dataName, const std::vector< std::pair< int, int > > &fileSpaceCorners, const std::vector< std::pair< int, int > > &memorySpaceCorners, const std::vector< std::pair< int, int > > &writeSelectionCorners, const WmConstOpaquePtr &data) const
	Write a new data set under a node.

virtual void	writeToDataSet (WxIoNodeType node, const WxRange &memoryRange, const WxRange &memorySubRange, const WxRange &fileRange, const WxRange &fileSubRange, const WmConstOpaquePtr &data) const
	Write to an open dataset (independent)

virtual WxIoNodeType	readDataSet (WxIoNodeType node, const std::string &dataName, const std::vector< std::pair< int, int > > &memorySpaceCorners, const std::vector< std::pair< int, int > > &readSelectionCorners, WmOpaquePtr &data) const
	Read a data set under a node.

virtual void	readFromDataSet (WxIoNodeType node, const WxRange &memoryRange, const WxRange &memorySubRange, const WxRange &fileRange, const WxRange &fileSubRange, WmOpaquePtr &data) const
	Read from an open dataset (independent)

virtual WxIoNodeType	getDataShape (WxIoNodeType node, const std::string &dataSetName, WxRange &dataShape) const
	Obtain simple data shape for a data set under a node.

virtual void	writeAttribute (WxIoNodeType node, const std::string &attribName, const WmConstOpaquePtr &attrib) const
	Write an attribute.

virtual void	writeVecAttribute (WxIoNodeType node, const std::string &attribName, const WmConstOpaquePtr &attrib, int count) const
	Write a vector attribute.

virtual void	readAttribute (WxIoNodeType node, const std::string &attribName, WmOpaquePtr &attrib) const
	Read an attribute.

virtual int	readVecAttribute (WxIoNodeType node, const std::string &attribName, WmOpaquePtr &attribStorage, int count) const
	Read a vector attribute.

Public Member Functions inherited from WxIoTmpl
virtual	~WxIoTmpl ()
	Virtual destructor.

virtual WxIoNodeType	writeDataSet (WxIoNodeType node, const std::string &dataName, const std::vector< std::pair< int, int > > &fileSpaceCorners, const std::vector< std::pair< int, int > > &memorySpaceCorners, const std::vector< std::pair< int, int > > &writeSelectionCorners, const WmConstOpaquePtr &data) const =0
	Write a new data set under a node.

virtual void	writeToDataSet (WxIoNodeType node, const WxRange &memoryRange, const WxRange &memorySubRange, const WxRange &fileRange, const WxRange &fileSubRange, const WmConstOpaquePtr &data) const =0
	Write to an open dataset (independent)

virtual WxIoNodeType	readDataSet (WxIoNodeType node, const std::string &dataName, const std::vector< std::pair< int, int > > &memorySpaceCorners, const std::vector< std::pair< int, int > > &readSelectionCorners, WmOpaquePtr &data) const =0
	Read a new data set under a node.

virtual void	readFromDataSet (WxIoNodeType node, const WxRange &memoryRange, const WxRange &memorySubRange, const WxRange &fileRange, const WxRange &fileSubRange, WmOpaquePtr &data) const =0
	Read from an open dataset (independent)

virtual WxIoNodeType	getDataShape (WxIoNodeType node, const std::string &dataSetName, WxRange &dataShape) const =0
	Obtain simple data shape for a data set under a node.

virtual void	writeAttribute (WxIoNodeType node, const std::string &attribName, const WmConstOpaquePtr &attrib) const =0
	Write an attribute.

virtual void	writeVecAttribute (WxIoNodeType node, const std::string &attribName, const WmConstOpaquePtr &attribStorage, int count) const =0
	Write a vector attribute.

virtual void	readAttribute (WxIoNodeType node, const std::string &attribName, WmOpaquePtr &attrib) const =0
	Read an attribute.

virtual int	readVecAttribute (WxIoNodeType node, const std::string &attribName, WmOpaquePtr &attribStorage, int count) const =0
	Read a vector attribute.

Static Public Attributes
static const int	max_dims = 8
	Max rank dataset that needs to be represented.

Additional Inherited Members
Protected Member Functions inherited from WxIoTmpl
	WxIoTmpl ()
	Constructor is protected, as this class cannot be made standalone.

Constructor & Destructor Documentation

◆ WxHdf5IoTmpl()

WxHdf5IoTmpl::WxHdf5IoTmpl ( )

Constructor.

◆ ~WxHdf5IoTmpl()

virtual WxHdf5IoTmpl::~WxHdf5IoTmpl ( )

virtual

Virtual destructor.

Member Function Documentation

◆ getDataShape()

virtual WxIoNodeType WxHdf5IoTmpl::getDataShape	(	WxIoNodeType	node,
		const std::string &	dataSetName,
		WxRange &	dataShape
	)		const

virtual

Obtain simple data shape for a data set under a node.

NOTE: data shape start indices can be offset by a vector attribute called "startIndices". If the attribute is shorter than the data rank, trailing start indices are assumed to be 0.

Parameters

node	the node under which to find the dataset
dataName	the name of the data
dataShape	the data set shape is returned by reference

Returns: the node to the dataset found

Implements WxIoTmpl.

◆ readAttribute()

virtual void WxHdf5IoTmpl::readAttribute	(	WxIoNodeType	node,
		const std::string &	attribName,
		WmOpaquePtr &	attrib
	)		const

virtual

Read an attribute.

Parameters

node	the node to which this attribute belongs
attribName	the name of the attribute
attrib	the attribute to be read

Exceptions

WxExcept on failure to read attribute

Implements WxIoTmpl.

◆ readDataSet()

virtual WxIoNodeType WxHdf5IoTmpl::readDataSet	(	WxIoNodeType	node,
		const std::string &	dataName,
		const std::vector< std::pair< int, int > > &	memorySpaceCorners,
		const std::vector< std::pair< int, int > > &	readSelectionCorners,
		WmOpaquePtr &	data
	)		const

virtual

Read a data set under a node.

Parameters

node	the node under which to find the dataset
dataName	the name of the data
memorySpaceCorners	vector of (start, stop) pairs for each dimension that specify local extent held in contiguous allocation
readSelectionCorners	vector of (start, stop) pairs for each dimension that specify subarea of memory space to read into
data	the data to be written

Returns: the node to the dataset read

Implements WxIoTmpl.

◆ readFromDataSet()

virtual void WxHdf5IoTmpl::readFromDataSet	(	WxIoNodeType	node,
		const WxRange &	memoryRange,
		const WxRange &	memorySubRange,
		const WxRange &	fileRange,
		const WxRange &	fileSubRange,
		WmOpaquePtr &	data
	)		const

virtual

Read from an open dataset (independent)

Parameters

node	the node to read under
memoryRange	Range that specifies total extent on host
memorySubRange	Range that specifies local extent on host
fileRange	Range that specifies total extent on file
fileSubRange	Range that specifies local extent on file
data	the destination for data to be read. This is returned in ROW MAJOR ordering.

Implements WxIoTmpl.

◆ readVecAttribute()

virtual int WxHdf5IoTmpl::readVecAttribute	(	WxIoNodeType	node,
		const std::string &	attribName,
		WmOpaquePtr &	attribStorage,
		int	count
	)		const

virtual

Read a vector attribute.

Parameters

node	the node to which this attribute belongs
attribName	the name of the attribute
attribStorage	the vector attribute to be read
count	maximum number of items to read; the amount of memory provided by attribStorage

Exceptions

WxExcept on failure to read attribute

Returns: number of items actually read

Implements WxIoTmpl.

◆ writeAttribute()

virtual void WxHdf5IoTmpl::writeAttribute	(	WxIoNodeType	node,
		const std::string &	attribName,
		const WmConstOpaquePtr &	attrib
	)		const

virtual

Write an attribute.

Parameters

node	the node to write under
attribName	the name of the attribute
attrib	the attribute to be written

Implements WxIoTmpl.

◆ writeDataSet()

virtual WxIoNodeType WxHdf5IoTmpl::writeDataSet	(	WxIoNodeType	node,
		const std::string &	dataName,
		const std::vector< std::pair< int, int > > &	fileSpaceCorners,
		const std::vector< std::pair< int, int > > &	memorySpaceCorners,
		const std::vector< std::pair< int, int > > &	writeSelectionCorners,
		const WmConstOpaquePtr &	data
	)		const

virtual

Write a new data set under a node.

Parameters

node	the node to write under
dataName	the name of the data
fileSpaceCorners	vector of (start, stop) pairs for each dimension that specify the global data space extent
memorySpaceCorners	vector of (start, stop) pairs for each dimension that specify local extent held in contiguous allocation
writeSelectionCorners	vector of (start, stop) pairs for each dimension that specify subarea of local extent to write
data	the data to be written

Returns: the node to the written data

Implements WxIoTmpl.

◆ writeToDataSet()

virtual void WxHdf5IoTmpl::writeToDataSet	(	WxIoNodeType	node,
		const WxRange &	memoryRange,
		const WxRange &	memorySubRange,
		const WxRange &	fileRange,
		const WxRange &	fileSubRange,
		const WmConstOpaquePtr &	data
	)		const

virtual

Write to an open dataset (independent)

Parameters

node	the node to write under
memoryRange	Range that specifies total extent on host
memorySubRange	Range that specifies local extent on host
fileRange	Range that specifies total extent on file
fileSubRange	Range that specifies local extent on file
data	the destination for data to be written. This is returned in ROW MAJOR ordering.

Implements WxIoTmpl.

◆ writeVecAttribute()

virtual void WxHdf5IoTmpl::writeVecAttribute	(	WxIoNodeType	node,
		const std::string &	attribName,
		const WmConstOpaquePtr &	attrib,
		int	count
	)		const

virtual

Write a vector attribute.

Parameters

node	the node to write under
attribName	the name of the attribute
attrib	the vector attribute to be written
count	number of items in vector to write

Implements WxIoTmpl.

Member Data Documentation

◆ max_dims

const int WxHdf5IoTmpl::max_dims = 8

static

Max rank dataset that needs to be represented.

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

src/lib/wxhdf5iotmpl.h

Detailed Description

Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ WxHdf5IoTmpl()

◆ ~WxHdf5IoTmpl()

Member Function Documentation

◆ getDataShape()

◆ readAttribute()

◆ readDataSet()

◆ readFromDataSet()

◆ readVecAttribute()

◆ writeAttribute()

◆ writeDataSet()

◆ writeToDataSet()

◆ writeVecAttribute()

Member Data Documentation

◆ max_dims