IODA
ioda::IodaIOfactory Class Reference

Factory class to instantiate objects of IodaIO subclasses. More...

#include <IodaIOfactory.h>

Public Member Functions

 IodaIOfactory ()
 
 ~IodaIOfactory ()
 

Static Public Member Functions

static ioda::IodaIOCreate (const std::string &FileName, const std::string &FileMode, const std::size_t MaxFrameSize)
 Instantiate a IodaIO object. More...
 

Detailed Description

Factory class to instantiate objects of IodaIO subclasses.

This class provides a Create method to open a file in a particular mode.

     Currently, the subclass from which to instantiate an object from is chosen
     based on the suffix in the file name. ".nc4" and ".nc" are recognized as
     netcdf files, and .odb is recognized as an ODB2 file. This isn't necessarily
     the best way to identify the file format, so this should be revisited in
     the future.
Author
Stephen Herbener (JCSDA)

Definition at line 36 of file IodaIOfactory.h.

Constructor & Destructor Documentation

◆ IodaIOfactory()

ioda::IodaIOfactory::IodaIOfactory ( )
inline

Definition at line 38 of file IodaIOfactory.h.

◆ ~IodaIOfactory()

ioda::IodaIOfactory::~IodaIOfactory ( )
inline

Definition at line 39 of file IodaIOfactory.h.

Member Function Documentation

◆ Create()

IodaIO * ioda::IodaIOfactory::Create ( const std::string &  FileName,
const std::string &  FileMode,
const std::size_t  MaxFrameSize 
)
static

Instantiate a IodaIO object.

Parameters
[in]FileNamePath to the obs file
[in]FileModeMode in which to open the obs file, "r" for read, "w" for overwrite and existing file and "W" for create and write to a new file
[in]MaxFrameSizeMaximum number of "rows" in a frame

Definition at line 29 of file IodaIOfactory.cc.

Here is the caller graph for this function:

The documentation for this class was generated from the following files: