IODA
ioda::Engines Namespace Reference

The backends that implement the ioda-engines functionality. More...

Namespaces

 HH
 Functions that are helpful in creating a new ioda::Group that is backed by HDF5.
 
 ObsStore
 
 ODC
 Functions that are helpful in creating a new ioda::Group that is imported from an ODB database.
 

Classes

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

Enumerations

enum class  Capability_Mask { Supported , Unsupported , 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  BackendNames { Hdf5File , Hdf5Mem , ObsStore }
 Backend names. More...
 
enum class  BackendFileActions { Create , Open }
 
enum class  BackendCreateModes { Truncate_If_Exists , Fail_If_Exists }
 
enum class  BackendOpenModes { Read_Only , Read_Write }
 

Functions

IODA_DL Group 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 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...
 
IODA_DL std::ostream & operator<< (std::ostream &os, const BackendCreateModes &mode)
 stream operator More...
 
IODA_DL std::ostream & operator<< (std::ostream &os, const BackendOpenModes &mode)
 stream operator More...
 

Detailed Description

The backends that implement the ioda-engines functionality.

Function Documentation

◆ operator<<() [1/2]

std::ostream & ioda::Engines::operator<< ( std::ostream &  os,
const BackendCreateModes mode 
)

stream operator

Definition at line 148 of file Factory.cpp.

◆ operator<<() [2/2]

std::ostream & ioda::Engines::operator<< ( std::ostream &  os,
const BackendOpenModes mode 
)

stream operator

Definition at line 161 of file Factory.cpp.