Hdf5ImporterShell Class Reference
[Plug-In Shells]
The base class of an importer that loads data in HDF Version 5 format.
More...
#include <Hdf5ImporterShell.h>
Protected Member Functions | |
| Hdf5ImporterShell () | |
| ~Hdf5ImporterShell () | |
| bool | getFileHandle (hid_t &fileHandle, Hdf5FileResource &fileResource) const |
Detailed Description
The base class of an importer that loads data in HDF Version 5 format.The HDF5 Importer Shell is a class designed to wrap the HDF5 libraries and provide a convenient means of importing simple (header, metadata, 1 cube) HDF5 data. The shell class is highly customizable, but to use these features requires downloading the HDF5 v1.6.2 precompiled libraries from * or *.
To link a derived plug-in under Windows, define _HDF5USEDLL_ and link to hdf5dll.lib. To link a derived plug-in under Solaris, define _HDF5USEDLL_ and link to libhdf5.so.0.0.0.
Definition at line 35 of file Hdf5ImporterShell.h.
Constructor & Destructor Documentation
| Hdf5ImporterShell::Hdf5ImporterShell | ( | ) | [protected] |
Constructs the Hdf5ImporterShell object to load file data in HDF Version 5 format.
Any class that derives from Hdf5ImporterShell MUST link against: szlib.lib, zdll.lib, and hdf5.lib on Windows systems, and libsz.a, libz.a, and libhdf5.a on Solaris systems.
| Hdf5ImporterShell::~Hdf5ImporterShell | ( | ) | [protected] |
Member Function Documentation
| bool Hdf5ImporterShell::getFileHandle | ( | hid_t & | fileHandle, | |
| Hdf5FileResource & | fileResource | |||
| ) | const [protected] |
Retrieve open HDF5 library handle to the file.
This may either involve directly opening the file or retrieving the already open file handle from the Hdf5Pager if the file was loaded on-disk read-only. Never attempt to just open the file using the HDF5 api because they specifically warn against a single process opening the same file twice with the HDF5 api.
- Parameters:
-
fileHandle On successful return, the fileHandle to use for HDF5 library access. fileResource An Hdf5FileResource which must remain in scope while fileHandle is being used. On successful return, the resource may or may not be valid, depending on how pElement was loaded.
- Returns:
- True if fileHandle is valid, false otherwise.