ioda::ObsIoFactory Class Reference

#include <ObsIoFactory.h>

Inheritance diagram for ioda::ObsIoFactory:

Public Member Functions
virtual	~ObsIoFactory ()=default

Static Public Member Functions
static std::shared_ptr< ObsIo >	create (ObsIoModes mode, const ObsSpaceParameters &parameters)
	Create and return a new instance of an ObsIo subclass. More...
static std::unique_ptr< ObsIoParametersBase >	createParameters (const std::string &name)
	Create and return an instance of the subclass of ObsIoParametersBase storing parameters of the specified type of ObsIo. More...
static std::vector< std::string >	getMakerNames ()
	Return the names of all ObsIo subclasses that can be created by one of the registered makers. More...

Protected Member Functions
	ObsIoFactory (const std::string &)
	Register a maker able to create instances of the specified ObsIo subclass. More...

Private Member Functions
virtual std::shared_ptr< ObsIo >	make (const ObsIoParametersBase &ioParameters, const ObsSpaceParameters &obsSpaceParameters)=0
virtual std::unique_ptr< ObsIoParametersBase >	makeParameters () const =0

Static Private Member Functions
static std::map< std::string, ObsIoFactory * > &	getMakers ()
static ObsIoFactory &	getMaker (const std::string &name)

Detailed Description

Definition at line 29 of file ObsIoFactory.h.

Constructor & Destructor Documentation

~ObsIoFactory()

virtual ioda::ObsIoFactory::~ObsIoFactory ( )

virtualdefault

ObsIoFactory()

ioda::ObsIoFactory::ObsIoFactory ( const std::string &  name )

explicitprotected

Register a maker able to create instances of the specified ObsIo subclass.

Definition at line 17 of file ObsIoFactory.cc.

Here is the call graph for this function:

Member Function Documentation

create()

std::shared_ptr< ObsIo > ioda::ObsIoFactory::create ( ObsIoModes  mode, const ObsSpaceParameters &  parameters  )

static

Create and return a new instance of an ObsIo subclass.

If mode is set to READ, the type of the instantiated subclass is determined by the string returned by parameters.top_level_.obsIoInParameters().type.value(). If mode is set to WRITE, an ObsIoFileCreate instance is returned unless `parameters.top_level_.obsOutFile is not set, in which case an exception is thrown.

Definition at line 24 of file ObsIoFactory.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

createParameters()

std::unique_ptr< ObsIoParametersBase > ioda::ObsIoFactory::createParameters ( const std::string &  name )

static

Create and return an instance of the subclass of ObsIoParametersBase storing parameters of the specified type of ObsIo.

Definition at line 53 of file ObsIoFactory.cc.

Here is the call graph for this function:

getMaker()

ObsIoFactory & ioda::ObsIoFactory::getMaker ( const std::string &  name )

staticprivate

Definition at line 57 of file ObsIoFactory.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

getMakerNames()

std::vector< std::string > ioda::ObsIoFactory::getMakerNames ( )

static

Return the names of all ObsIo subclasses that can be created by one of the registered makers.

Definition at line 70 of file ObsIoFactory.cc.

Here is the call graph for this function:

getMakers()

std::map< std::string, ObsIoFactory * > & ioda::ObsIoFactory::getMakers ( )

staticprivate

Definition at line 74 of file ObsIoFactory.cc.

Here is the caller graph for this function:

make()

virtual std::shared_ptr<ObsIo> ioda::ObsIoFactory::make ( const ObsIoParametersBase &  ioParameters, const ObsSpaceParameters &  obsSpaceParameters  )

privatepure virtual

Implemented in ioda::ObsIoMaker< T >.

Here is the caller graph for this function:

makeParameters()

virtual std::unique_ptr<ObsIoParametersBase> ioda::ObsIoFactory::makeParameters ( ) const

privatepure virtual

Implemented in ioda::ObsIoMaker< T >.

Here is the caller graph for this function:

---

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

• ObsIoFactory.h
• ObsIoFactory.cc