Hdf5FileObject::Args Struct Reference

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

#include <Hdf5Resource.h>

List of all members.

Public Member Functions
	Args (std::string filename, unsigned flags=H5F_ACC_RDONLY, hid_t access=H5P_DEFAULT)
	Args ()
Public Attributes
std::string	mFilename
unsigned int	mFlags
hid_t	mAccess

---

Detailed Description

This is an implementation detail of the Hdf5FileObject class.

It is used for passing the parameters required by H5Fopen.

Definition at line 35 of file Hdf5Resource.h.

---

Constructor & Destructor Documentation

Hdf5FileObject::Args::Args	(	std::string	filename,
		unsigned	flags = H5F_ACC_RDONLY,
		hid_t	access = H5P_DEFAULT
	)

Creates a resource to an HDF5 file handle.

Auto-closes file when the object goes out of scope.

Parameters:

	filename	The name of the file to open.
	flags	The open flags for the file access (H5F_ACC_RDONLY, H5F_ACC_RDWR, H5F_ACC_TRUNC, H5F_ACC_EXCL, H5F_ACC_DEBUG, H5F_ACC_CREAT). These flags may be ORed together with the operator |. For details on these flags, see the HDF5 documentation.
	access	The internal HDF5 access flags. These flags are different than the file-level access flags. They specify what filters are needed to access the data. This should almost always stay at the default, H5P_DEFAULT.

Definition at line 79 of file Hdf5Resource.h.

Hdf5FileObject::Args::Args

(

)

Default constructor.

Definition at line 87 of file Hdf5Resource.h.

---

Member Data Documentation

std::string Hdf5FileObject::Args::mFilename

The file name of the HDF5 file to be opened.

Definition at line 40 of file Hdf5Resource.h.

unsigned int Hdf5FileObject::Args::mFlags

The access flags for opening the file.

Default is to open read only. Other options include read only, read-write, write, truncate. Options may be combined with the | operator. For details, see the HDF5 documentation.

Definition at line 49 of file Hdf5Resource.h.

hid_t Hdf5FileObject::Args::mAccess

The internal HDF5 access flags.

These flags are different than the file-level access flags. They specify what filters are needed to access the data. This should almost always stay at the default, H5P_DEFAULT. For details regarding this parameter, see the H5Fopen function in the HDF5 documentation.

Definition at line 59 of file Hdf5Resource.h.