OOPS
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Static Private Member Functions | List of all members
oops::ObsErrorFactory< OBS > Class Template Referenceabstract

A factory creating instances of concrete subclasses of ObsErrorBase. More...

#include <ObsErrorBase.h>

Inheritance diagram for oops::ObsErrorFactory< OBS >:
Inheritance graph
[legend]

Public Member Functions

virtual ~ObsErrorFactory ()=default
 

Static Public Member Functions

static std::unique_ptr< ObsErrorBase_ > create (const ObsErrorParametersBase &params, const ObsSpace_ &)
 Create and return a new observation error covariance matrix model. More...
 
static std::unique_ptr< ObsErrorParametersBase > createParameters (const std::string &model)
 Create and return an instance of the subclass of ObsErrorParametersBase storing parameters of covariance matrix models of the specified type. More...
 
static std::vector< std::string > getMakerNames ()
 Return the names of all models that can be created by one of the registered makers. More...
 

Protected Member Functions

 ObsErrorFactory (const std::string &model)
 Register a maker able to create covariance matrix models of type model. More...
 

Private Types

typedef ObsErrorBase< OBS > ObsErrorBase_
 
typedef ObsSpace< OBS > ObsSpace_
 

Private Member Functions

virtual std::unique_ptr< ObsErrorBase_ > make (const ObsErrorParametersBase &, const ObsSpace_ &)=0
 
virtual std::unique_ptr< ObsErrorParametersBase > makeParameters () const =0
 

Static Private Member Functions

static std::map< std::string, ObsErrorFactory< OBS > * > & getMakers ()
 

Detailed Description

template<typename OBS>
class oops::ObsErrorFactory< OBS >

A factory creating instances of concrete subclasses of ObsErrorBase.

Definition at line 118 of file generic/ObsErrorBase.h.

Member Typedef Documentation

◆ ObsErrorBase_

template<typename OBS >
typedef ObsErrorBase<OBS> oops::ObsErrorFactory< OBS >::ObsErrorBase_
private

Definition at line 119 of file generic/ObsErrorBase.h.

◆ ObsSpace_

template<typename OBS >
typedef ObsSpace<OBS> oops::ObsErrorFactory< OBS >::ObsSpace_
private

Definition at line 120 of file generic/ObsErrorBase.h.

Constructor & Destructor Documentation

◆ ~ObsErrorFactory()

template<typename OBS >
virtual oops::ObsErrorFactory< OBS >::~ObsErrorFactory ( )
virtualdefault

◆ ObsErrorFactory()

template<typename OBS >
oops::ObsErrorFactory< OBS >::ObsErrorFactory ( const std::string &  model)
explicitprotected

Register a maker able to create covariance matrix models of type model.

Definition at line 185 of file generic/ObsErrorBase.h.

Member Function Documentation

◆ create()

template<typename OBS >
std::unique_ptr< ObsErrorBase< OBS > > oops::ObsErrorFactory< OBS >::create ( const ObsErrorParametersBase &  params,
const ObsSpace_ &  obs 
)
static

Create and return a new observation error covariance matrix model.

The model's type is determined by the covariance model attribute of params. params must be an instance of the subclass of ObsErrorParametersBase associated with that model type, otherwise an exception will be thrown.

Definition at line 196 of file generic/ObsErrorBase.h.

Here is the caller graph for this function:

◆ createParameters()

template<typename OBS >
std::unique_ptr< ObsErrorParametersBase > oops::ObsErrorFactory< OBS >::createParameters ( const std::string &  model)
static

Create and return an instance of the subclass of ObsErrorParametersBase storing parameters of covariance matrix models of the specified type.

Definition at line 213 of file generic/ObsErrorBase.h.

◆ getMakerNames()

template<typename OBS >
static std::vector<std::string> oops::ObsErrorFactory< OBS >::getMakerNames ( )
inlinestatic

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

Definition at line 136 of file generic/ObsErrorBase.h.

Here is the call graph for this function:

◆ getMakers()

template<typename OBS >
static std::map< std::string, ObsErrorFactory<OBS> * >& oops::ObsErrorFactory< OBS >::getMakers ( )
inlinestaticprivate

Definition at line 152 of file generic/ObsErrorBase.h.

Here is the caller graph for this function:

◆ make()

template<typename OBS >
virtual std::unique_ptr<ObsErrorBase_> oops::ObsErrorFactory< OBS >::make ( const ObsErrorParametersBase &  ,
const ObsSpace_ &   
)
privatepure virtual

Implemented in oops::interface::ObsErrorMaker< OBS, T >, and oops::ObsErrorMaker< OBS, T >.

◆ makeParameters()

template<typename OBS >
virtual std::unique_ptr<ObsErrorParametersBase> oops::ObsErrorFactory< OBS >::makeParameters ( ) const
privatepure virtual

Implemented in oops::interface::ObsErrorMaker< OBS, T >, and oops::ObsErrorMaker< OBS, T >.

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