HDF5 Engine

HDF5 Engine. More...

Collaboration diagram for HDF5 Engine:

Files
file	HH.h
	HDF5 engine.
file	HH.cpp
	HDF5 engine interface to the rest of ioda.

Typedefs
typedef std::pair< HDF5_Version, HDF5_Version >	ioda::Engines::HH::HDF5_Version_Range

Enumerations
enum class	ioda::Engines::HH::HDF5_Version {   ioda::Engines::HH::Earliest , ioda::Engines::HH::V18 , ioda::Engines::HH::V110 , ioda::Engines::HH::V112 ,   ioda::Engines::HH::Latest }
	HDF5 library format versions. More...

Functions
IODA_DL HDF5_Version_Range	ioda::Engines::HH::defaultVersionRange ()
IODA_DL std::string	ioda::Engines::HH::genUniqueName ()
	Convenience function to generate a random file name. More...
IODA_DL Group	ioda::Engines::HH::createFile (const std::string &filename, BackendCreateModes mode, HDF5_Version_Range compat=defaultVersionRange())
	Create a ioda::Group backed by an HDF5 file. More...
IODA_DL Group	ioda::Engines::HH::openFile (const std::string &filename, BackendOpenModes mode, HDF5_Version_Range compat=defaultVersionRange())
	Open a ioda::Group backed by an HDF5 file. More...
IODA_DL Group	ioda::Engines::HH::createMemoryFile (const std::string &filename, BackendCreateModes mode, bool flush_on_close=false, size_t increment_len_bytes=1000000, HDF5_Version_Range compat=defaultVersionRange())
	Create a ioda::Group backed by the HDF5 in-memory-store. More...
IODA_DL Group	ioda::Engines::HH::openMemoryFile (const std::string &filename, BackendOpenModes mode=BackendOpenModes::Read_Only, bool flush_on_close=false, size_t increment_len_bytes=1000000, HDF5_Version_Range compat=defaultVersionRange())
	Map an HDF5 file in memory and open a ioda::Group. More...
IODA_DL Capabilities	ioda::Engines::HH::getCapabilitiesFileEngine ()
	Get capabilities of the HDF5 file-backed engine. More...
IODA_DL Capabilities	ioda::Engines::HH::getCapabilitiesInMemoryEngine ()
	Get capabilities of the HDF5 memory-backed engine. More...

Detailed Description

HDF5 Engine.

Typedef Documentation

HDF5_Version_Range

typedef std::pair<HDF5_Version, HDF5_Version> ioda::Engines::HH::HDF5_Version_Range

Definition at line 42 of file HH.h.

Enumeration Type Documentation

HDF5_Version

enum ioda::Engines::HH::HDF5_Version

strong

HDF5 library format versions.

Note

When changing, you need to update the ostream operators.

Enumerator
Earliest	Use the earliest possible HDF5 format for storing objects.
V18	Use the latest HDF5 v1.8 format for storing objects.
V110	Use the latest HDF5 v1.10 format for storing objects.
V112	Use the latest HDF5 v1.12 format for storing objects.
Latest	Use the latest possible HDF5 format for storing objects.

Definition at line 34 of file HH.h.

Function Documentation

createFile()

Group ioda::Engines::HH::createFile	(	const std::string &	filename,
		BackendCreateModes	mode,
		HDF5_Version_Range	compat = defaultVersionRange()
	)

Create a ioda::Group backed by an HDF5 file.

Parameters

filename	is the file name.
mode	is the creation mode.
compat	is the range of HDF5 versions that should be able to access this file.

Definition at line 120 of file HH.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

createMemoryFile()

Group ioda::Engines::HH::createMemoryFile	(	const std::string &	filename,
		BackendCreateModes	mode,
		bool	flush_on_close = false,
		size_t	increment_len_bytes = 1000000,
		HDF5_Version_Range	compat = defaultVersionRange()
	)

Create a ioda::Group backed by the HDF5 in-memory-store.

Parameters

filename	is the name of the file if it gets flushed (written) to disk. Otherwise, it is a unique identifier. If this id is reused, then we are re-opening the store.
mode	is the creation mode. This only matters if the file is flushed to disk.
flush_on_close	instructs us to flush the memory image to the disk when done. If false, then the image is never written to disk.
increment_len_bytes	is the length (in bytes) of the initial memory image. As the image grows larger, then additional memory allocations will be performed.
compat	is the range of HDF5 versions that should be able to access this file.

Definition at line 86 of file HH.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

defaultVersionRange()

HDF5_Version_Range ioda::Engines::HH::defaultVersionRange

(

)

Definition at line 77 of file HH.cpp.

Here is the caller graph for this function:

genUniqueName()

std::string ioda::Engines::HH::genUniqueName

(

)

Convenience function to generate a random file name.

See also

createMemoryFile

Definition at line 50 of file HH.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getCapabilitiesFileEngine()

Capabilities ioda::Engines::HH::getCapabilitiesFileEngine

(

)

Get capabilities of the HDF5 file-backed engine.

Definition at line 202 of file HH.cpp.

Here is the caller graph for this function:

getCapabilitiesInMemoryEngine()

Capabilities ioda::Engines::HH::getCapabilitiesInMemoryEngine

(

)

Get capabilities of the HDF5 memory-backed engine.

Definition at line 218 of file HH.cpp.

Here is the caller graph for this function:

openFile()

Group ioda::Engines::HH::openFile	(	const std::string &	filename,
		BackendOpenModes	mode,
		HDF5_Version_Range	compat = defaultVersionRange()
	)

Open a ioda::Group backed by an HDF5 file.

Parameters

filename	is the file name.
mode	is the access mode.
compat	is the range of HDF5 versions that should be able to access this file.

Definition at line 147 of file HH.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

openMemoryFile()

Group ioda::Engines::HH::openMemoryFile	(	const std::string &	filename,
		BackendOpenModes	mode = BackendOpenModes::Read_Only,
		bool	flush_on_close = false,
		size_t	increment_len_bytes = 1000000,
		HDF5_Version_Range	compat = defaultVersionRange()
	)

Map an HDF5 file in memory and open a ioda::Group.

Parameters

filename	is the name of the file to be opened.
mode	is the access mode.
flush_on_close	instructs us to flush the memory image to the disk when done. If false, then the image is never written to disk.
increment_len_bytes	is the length (in bytes) of the initial memory image. As the image grows larger, then additional memory allocations will be performed of increment_len bytes.
compat	is the range of HDF5 versions that should be able to access this file.

While using openMemoryFile to open an existing file, if flush_on_close is set to 1 and the mode is set to BackendOpenModes::Read_Write, any change to the file contents are saved to the file when the file is closed. If flush_on_close is set to 0 and the flags for mode is set to BackendOpenModes::Read_Write, any change to the file contents will be lost when the file is closed. If the mode for openMemoryFile is set to BackendOpenModes::Read_Only, no change to the file is allowed either in memory or on file.

Definition at line 171 of file HH.cpp.

Here is the call graph for this function:

Here is the caller graph for this function: