Hdf5DataSetObject::Args Struct Reference

This is an implementation detail of the Hdf5DataSetObject class. More...

#include <Hdf5Resource.h>

List of all members.

Public Member Functions
	Args (hid_t fileHandle, const std::string &fullPathAndName)
	Args ()
Public Attributes
hid_t	mFileHandle
std::string	mFullPathAndName

---

Detailed Description

This is an implementation detail of the Hdf5DataSetObject class.

It is used for passing the parameters required by H5Dopen1.

Definition at line 226 of file Hdf5Resource.h.

---

Constructor & Destructor Documentation

Hdf5DataSetObject::Args::Args	(	hid_t	fileHandle,
		const std::string &	fullPathAndName
	)

Constructs an Args object for an HDF5 Dataset Object.

See Resource.h for details.

Parameters:

	fileHandle	A file handle repsesenting the file that contains the specified dataset.
	fullPathAndName	The UNIX-style full path and name of the data element to open.

Definition at line 256 of file Hdf5Resource.h.

Hdf5DataSetObject::Args::Args

(

)

Default constructor.

Definition at line 264 of file Hdf5Resource.h.

---

Member Data Documentation

hid_t Hdf5DataSetObject::Args::mFileHandle

The file handle that represents the file that contains the dataset.

Definition at line 232 of file Hdf5Resource.h.

std::string Hdf5DataSetObject::Args::mFullPathAndName

The full path and name of the dataset within the file.

HDF5 provides access to datasets either by requiring opening of each group within the file (similar to performing "cd docs; cd stuff; cd mydir;") and performing a dataset open at the end, OR by providing the full path and name of the dataset (ie. "/docs/stuff/mydir/dataset").

Definition at line 243 of file Hdf5Resource.h.