NDFileHDF5Dataset Class Reference

Class used for writing a Dataset with the NDFileHDF5 plugin. More...

#include <NDFileHDF5Dataset.h>

Public Member Functions
	NDFileHDF5Dataset (asynUser *pAsynUser, const std::string &name, hid_t dataset)
	Constructor. More...
virtual	~NDFileHDF5Dataset ()
asynStatus	configureDims (NDArray *pArray, bool multiframe, int extradimensions, int *extra_dims, int *extra_dim_chunking, int *user_chunking)
	configureDims. More...
asynStatus	extendDataSet (int extradims)
	extendDataSet. More...
asynStatus	extendDataSet (int extradims, hsize_t *offsets)
asynStatus	verifyChunking (NDArray *pArray)
	Check if pArray dimensions and codec match hdf5 dataset definition. More...
void	configureCompression (Codec_t codec)
	Store codec definition. More...
asynStatus	writeFile (NDArray *pArray, hid_t datatype, hid_t dataspace, hsize_t *framesize)
	writeFile. More...
hid_t	getHandle ()
	getHandle. More...
asynStatus	flushDataset ()
hsize_t	getDim (int index)
	Return the requested dimension size. More...
hsize_t	getMaxDim (int index)
	Return the requested max dimension size. More...
hsize_t	getOffset (int index)
	Return the requested offset size. More...
hsize_t	getVirtualDim (int index)
	Return the requested virtual dimension size. More...

Detailed Description

Class used for writing a Dataset with the NDFileHDF5 plugin.

Constructor & Destructor Documentation

NDFileHDF5Dataset()

NDFileHDF5Dataset::NDFileHDF5Dataset	(	asynUser *	pAsynUser,
		const std::string &	name,
		hid_t	dataset
	)

Constructor.

Parameters

[in]	pAsynUser	- asynUser that is used to control debugging output
[in]	name	- String name of the dataset.
[in]	dataset	- HDF5 handle to the dataset.

~NDFileHDF5Dataset()

NDFileHDF5Dataset::~NDFileHDF5Dataset ( )

virtual

Member Function Documentation

configureCompression()

void NDFileHDF5Dataset::configureCompression

(

Codec_t

codec

)

Store codec definition.

Parameters

[in]

codec

- Codec definition.

configureDims()

asynStatus NDFileHDF5Dataset::configureDims	(	NDArray *	pArray,
		bool	multiframe,
		int	extradimensions,
		int *	extra_dims,
		int *	extra_dim_chunking,
		int *	user_chunking
	)

configureDims.

Setup any extra dimensions required for this dataset

Parameters

[in]	pArray	- A pointer to an NDArray which contains dimension information.
[in]	multiframe	- Is this multiframe?
[in]	extradimensions	- The number of extra dimensions.
[in]	extra_dims	- The size of extra dimensions.
[in]	extra_dim_chunking	- Array of extra dimension chunking.
[in]	user_chunking	- Array of user defined chunking dimensions.

extendDataSet() [1/2]

asynStatus NDFileHDF5Dataset::extendDataSet

(

int

extradims

)

extendDataSet.

Extend this dataset as necessary. If no extra dimensions are specified then the dataset is simply increased in the frame number direction.

Parameters

[in]

extradims

- The number of extra dimensions.

extendDataSet() [2/2]

asynStatus NDFileHDF5Dataset::extendDataSet	(	int	extradims,
		hsize_t *	offsets
	)

flushDataset()

asynStatus NDFileHDF5Dataset::flushDataset

(

)

getDim()

hsize_t NDFileHDF5Dataset::getDim

(

int

index

)

Return the requested dimension size.

Parameters

[in]

index

of dimension

Returns

size of the dimension

getHandle()

hid_t NDFileHDF5Dataset::getHandle

(

)

getHandle.

Returns the HDF5 handle to this dataset.

getMaxDim()

hsize_t NDFileHDF5Dataset::getMaxDim

(

int

index

)

Return the requested max dimension size.

Parameters

[in]

index

of dimension

Returns

size of the dimension

getOffset()

hsize_t NDFileHDF5Dataset::getOffset

(

int

index

)

Return the requested offset size.

Parameters

[in]

index

of offset

Returns

size of the offset

getVirtualDim()

hsize_t NDFileHDF5Dataset::getVirtualDim

(

int

index

)

Return the requested virtual dimension size.

Parameters

[in]

index

of dimension

Returns

size of the dimension

verifyChunking()

asynStatus NDFileHDF5Dataset::verifyChunking

(

NDArray *

pArray

)

Check if pArray dimensions and codec match hdf5 dataset definition.

Parameters

[in]

pArray

- The NDArray containing the data to verify.

writeFile()

asynStatus NDFileHDF5Dataset::writeFile	(	NDArray *	pArray,
		hid_t	datatype,
		hid_t	dataspace,
		hsize_t *	framesize
	)

writeFile.

Write the data using the HDF5 library calls.

Parameters

[in]	pArray	- The NDArray containing the data to write.
[in]	datatype	- The HDF5 datatype of the data.
[in]	dataspace	- A handle to the HDF5 dataspace for this dataset.
[in]	framesize	- The size of the data to write.

---

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

• /home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDFileHDF5Dataset.h
• /home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDFileHDF5Dataset.cpp