Provides the C-style interface for the ioda::Engines namespace. More...

Collaboration diagram for Engines:

Classes
struct	c_ioda_engines_ObsStore
	Class-like encapsulation of ioda::Engines::ObsStore functions. More...

struct	c_ioda_engines_HH
	Class-like encapsulation of ioda::Engines::HH functions. More...

struct	c_ioda_engines
	Class-like encapsulation of ioda::Engines functions. More...

Enumerations
enum	ioda_Engines_BackendOpenModes { ioda_Engines_BackendOpenModes_Read_Only , ioda_Engines_BackendOpenModes_Read_Write }
	Options when opening a file. More...

enum	ioda_Engines_BackendCreateModes { ioda_Engines_BackendCreateModes_Truncate_If_Exists , ioda_Engines_BackendCreateModes_Fail_If_Exists }
	Options when creating a file. More...

Functions
IODA_DL struct ioda_group *	ioda_Engines_ObsStore_createRootGroup ()
	Create a new ObsStore instance. More...

IODA_DL struct ioda_group *	ioda_Engines_HH_createMemoryFile (size_t sz_filename, const char *filename, bool flush_on_close, long increment_len_bytes)
	Create a new in-memory data store, backed by HDF5. More...

IODA_DL struct ioda_group *	ioda_Engines_HH_openFile (size_t sz_filename, const char *filename, enum ioda_Engines_BackendOpenModes mode)
	Open a handle to a file that is backed by HDF5. More...

IODA_DL struct ioda_group *	ioda_Engines_HH_createFile (size_t sz_filename, const char *filename, enum ioda_Engines_BackendCreateModes mode)
	Create a new file using the HDF5 interface. More...

IODA_DL struct ioda_group *	ioda_Engines_constructFromCmdLine (int argc, char *argv, const char defaultFilename)
	Function used in the ioda C examples and unit tests to construct different backends based on different command-line parameters. More...

Detailed Description

Provides the C-style interface for the ioda::Engines namespace.

Enumeration Type Documentation

Options when creating a file.

Enumerator
ioda_Engines_BackendCreateModes_Truncate_If_Exists	Create a new file. If a file already exists, overwrite it.
ioda_Engines_BackendCreateModes_Fail_If_Exists	Create a new file. If a file already exists at the path, fail.

Definition at line 34 of file Engines_c.h.

Options when opening a file.

Enumerator
ioda_Engines_BackendOpenModes_Read_Only	Open in read-only mode.
ioda_Engines_BackendOpenModes_Read_Write	Open in read-write mode.

Definition at line 27 of file Engines_c.h.

IODA_DL ioda_group * ioda_Engines_constructFromCmdLine	(	int	argc,
		char **	argv,
		const char *	defaultFilename
	)

Function used in the ioda C examples and unit tests to construct different backends based on different command-line parameters.

Parameters

argc	is the number of command-line arguments.
argv	is the command-line arguments.
defaultFilename	is a default file to be used in case no command-line arguments are specified.

Definition at line 79 of file Engines_c.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

IODA_DL ioda_group * ioda_Engines_HH_createFile	(	size_t	sz_filename,
		const char *	filename,
		enum ioda_Engines_BackendCreateModes	mode
	)

Create a new file using the HDF5 interface.

Parameters

filename	is the path to the file.
sz_filename	is strlen(filename). Needed by Fortran bindings.
mode	is the access mode. Essentially, is the file created if a file with the same name already exists?

Definition at line 62 of file Engines_c.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

IODA_DL ioda_group * ioda_Engines_HH_createMemoryFile	(	size_t	sz_filename,
		const char *	filename,
		bool	flush_on_close,
		long	increment_len_bytes
	)

Create a new in-memory data store, backed by HDF5.

Parameters

filename	is an identifier to the "file" that HDF5 is accessing. Multiple opens of the same identifier open the same object.
sz_filename	is strlen(filename). Needed by Fortran bindings.
flush_on_close	denotes whether the in-memory object should be flushed (written) to disk once it is closed. Useful for debugging. If true, then file "filename" will be created on success.
increment_len_bytes	represents the size of new memory allocations that occur when data is written to the in-memory storage. Basically, when the engine needs more memory, allocate additional blocks with this size.