Engines

Public API for engines. More...

Collaboration diagram for Engines:

Modules
	HDF5 Engine
	HDF5 Engine.
	ObsStore Engine
	ObsStore Engine.
	ODB / ODC Engine
	ODB / ODC Engine.

Files
file	Capabilities.h
	Structs that describe backend capabilities.
file	Factory.h
	Definitions for setting up backends with file and memory I/O.

Classes
struct	ioda::Engines::Capabilities
	Struct defining what an engine can/cannot do. More...
struct	ioda::Engines::BackendCreationParameters
	Used to specify backend creation-time properties. More...

Enumerations
enum class	ioda::Engines::Capability_Mask { ioda::Engines::Supported , ioda::Engines::Unsupported , ioda::Engines::Ignored }
	A tri-bool type that indicates whether a feature is supported, ignored if used, or if the engine will fail on use. More...
enum class	ioda::Engines::BackendNames { ioda::Engines::Hdf5File , ioda::Engines::Hdf5Mem , ioda::Engines::ObsStore }
	Backend names. More...
enum class	ioda::Engines::BackendFileActions { ioda::Engines::Create , ioda::Engines::Open }
enum class	ioda::Engines::BackendCreateModes { ioda::Engines::Truncate_If_Exists , ioda::Engines::Fail_If_Exists }
enum class	ioda::Engines::BackendOpenModes { ioda::Engines::Read_Only , ioda::Engines::Read_Write }

Functions
IODA_DL Group	ioda::Engines::constructFromCmdLine (int argc, char **argv, const std::string &defaultFilename)
	This is a wrapper function around the constructBackend function for creating a backend based on command-line options. Intended for unit testing only. More...
IODA_DL Group	ioda::Engines::constructBackend (BackendNames name, BackendCreationParameters &params)
	This is a simple factory style function that will instantiate a different backend based on a given name an parameters. More...

Detailed Description

Public API for engines.

Enumeration Type Documentation

BackendCreateModes

enum ioda::Engines::BackendCreateModes

strong

Options when creating a new file.

Note

When changing, you need to update the ostream operators.

Enumerator
Truncate_If_Exists	If the file already exists, overwrite it.
Fail_If_Exists	If the file already exists, fail with an error.

Definition at line 44 of file Factory.h.

BackendFileActions

enum ioda::Engines::BackendFileActions

strong

Actions for accessing a file

Enumerator
Create	Create a new file.
Open	Open an existing file.

Definition at line 36 of file Factory.h.

BackendNames

enum ioda::Engines::BackendNames

strong

Backend names.

Enumerator
Hdf5File	HDF5 file access.
Hdf5Mem	HDF5 in-memory "file".
ObsStore	ObsStore in-memory.

Definition at line 28 of file Factory.h.

BackendOpenModes

enum ioda::Engines::BackendOpenModes

strong

Options when opening an file that already exists.

Note

When changing, you need to update the ostream operators.

Enumerator
Read_Only	Open the file in read-only mode.
Read_Write	Open the file in read-write mode.

Definition at line 52 of file Factory.h.

Capability_Mask

enum ioda::Engines::Capability_Mask

strong

A tri-bool type that indicates whether a feature is supported, ignored if used, or if the engine will fail on use.

Enumerator
Supported	The feature always works.
Unsupported	The feature causes an exception if used.
Ignored	The feature is silently disabled or unimplemented. For example, not all engines support data chunking. If a caller specifies that chunking is requested, then we store the chunking parameters but do not actually chunk the data. Useful when we copy data across backends — some backends may support and use the feature, so we preserve the settings without always obeying them.

Definition at line 25 of file Capabilities.h.

Function Documentation

constructBackend()

Group ioda::Engines::constructBackend	(	BackendNames	name,
		BackendCreationParameters &	params
	)

This is a simple factory style function that will instantiate a different backend based on a given name an parameters.

Definition at line 124 of file Factory.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

constructFromCmdLine()

Group ioda::Engines::constructFromCmdLine	(	int	argc,
		char **	argv,
		const std::string &	defaultFilename
	)

This is a wrapper function around the constructBackend function for creating a backend based on command-line options. Intended for unit testing only.

Definition at line 21 of file Factory.cpp.

Here is the call graph for this function:

Here is the caller graph for this function: