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::LinearVariableChangeFactory< MODEL > Class Template Referenceabstract

LinearVariableChange factory. More...

#include <LinearVariableChangeBase.h>

Inheritance diagram for oops::LinearVariableChangeFactory< MODEL >:
Inheritance graph
[legend]

Public Member Functions

virtual ~LinearVariableChangeFactory ()=default
 

Static Public Member Functions

static LinearVariableChangeBase< MODEL > * create (const State_ &, const State_ &, const Geometry_ &, const LinearVariableChangeParametersBase &parameters)
 Create and return a new linear variable change. More...
 
static LinearVariableChangeBase< MODEL > * create (const State_ &, const State_ &, const Geometry_ &, const eckit::Configuration &conf)
 Create and return a new linear variable change. More...
 
static std::unique_ptr< LinearVariableChangeParametersBase > createParameters (const std::string &name)
 Create and return an instance of the subclass of LinearVariableChangeParametersBase storing parameters of linear variable changes of the specified type. More...
 
static std::vector< std::string > getMakerNames ()
 Return the names of all linear variable changes that can be created by one of the registered makers. More...
 

Protected Member Functions

 LinearVariableChangeFactory (const std::string &name)
 Register a maker able to create linear variable changes of type name. More...
 

Private Types

typedef Geometry< MODEL > Geometry_
 
typedef State< MODEL > State_
 

Private Member Functions

virtual LinearVariableChangeBase< MODEL > * make (const State_ &, const State_ &, const Geometry_ &, const LinearVariableChangeParametersBase &)=0
 
virtual std::unique_ptr< LinearVariableChangeParametersBase > makeParameters () const =0
 

Static Private Member Functions

static std::map< std::string, LinearVariableChangeFactory< MODEL > * > & getMakers ()
 

Detailed Description

template<typename MODEL>
class oops::LinearVariableChangeFactory< MODEL >

LinearVariableChange factory.

Definition at line 126 of file LinearVariableChangeBase.h.

Member Typedef Documentation

◆ Geometry_

template<typename MODEL >
typedef Geometry<MODEL> oops::LinearVariableChangeFactory< MODEL >::Geometry_
private

Definition at line 127 of file LinearVariableChangeBase.h.

◆ State_

template<typename MODEL >
typedef State<MODEL> oops::LinearVariableChangeFactory< MODEL >::State_
private

Definition at line 128 of file LinearVariableChangeBase.h.

Constructor & Destructor Documentation

◆ ~LinearVariableChangeFactory()

template<typename MODEL >
virtual oops::LinearVariableChangeFactory< MODEL >::~LinearVariableChangeFactory ( )
virtualdefault

◆ LinearVariableChangeFactory()

template<typename MODEL >
oops::LinearVariableChangeFactory< MODEL >::LinearVariableChangeFactory ( const std::string &  name)
explicitprotected

Register a maker able to create linear variable changes of type name.

Definition at line 210 of file LinearVariableChangeBase.h.

Member Function Documentation

◆ create() [1/2]

template<typename MODEL >
LinearVariableChangeBase< MODEL > * oops::LinearVariableChangeFactory< MODEL >::create ( const State_ &  bg,
const State_ &  fg,
const Geometry_ &  geom,
const eckit::Configuration &  conf 
)
static

Create and return a new linear variable change.

Deprecated overload taking a Configuration instead of a LinearVariableChangeParametersBase.

Definition at line 246 of file LinearVariableChangeBase.h.

◆ create() [2/2]

template<typename MODEL >
LinearVariableChangeBase< MODEL > * oops::LinearVariableChangeFactory< MODEL >::create ( const State_ &  bg,
const State_ &  fg,
const Geometry_ &  geom,
const LinearVariableChangeParametersBase &  parameters 
)
static

Create and return a new linear variable change.

The type of the variable change is determined by the variable change attribute of parameters. parameters must be an instance of the subclass of LinearVariableChangeParametersBase associated with that variable change type, otherwise an exception will be thrown.

Definition at line 220 of file LinearVariableChangeBase.h.

Here is the caller graph for this function:

◆ createParameters()

template<typename MODEL >
std::unique_ptr< LinearVariableChangeParametersBase > oops::LinearVariableChangeFactory< MODEL >::createParameters ( const std::string &  name)
static

Create and return an instance of the subclass of LinearVariableChangeParametersBase storing parameters of linear variable changes of the specified type.

Definition at line 258 of file LinearVariableChangeBase.h.

◆ getMakerNames()

template<typename MODEL >
static std::vector<std::string> oops::LinearVariableChangeFactory< MODEL >::getMakerNames ( )
inlinestatic

Return the names of all linear variable changes that can be created by one of the registered makers.

Definition at line 155 of file LinearVariableChangeBase.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getMakers()

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

Definition at line 172 of file LinearVariableChangeBase.h.

Here is the caller graph for this function:

◆ make()

template<typename MODEL >
virtual LinearVariableChangeBase<MODEL>* oops::LinearVariableChangeFactory< MODEL >::make ( const State_ &  ,
const State_ &  ,
const Geometry_ &  ,
const LinearVariableChangeParametersBase &   
)
privatepure virtual

Implemented in oops::LinearVariableChangeMaker< MODEL, T >.

◆ makeParameters()

template<typename MODEL >
virtual std::unique_ptr<LinearVariableChangeParametersBase> oops::LinearVariableChangeFactory< MODEL >::makeParameters ( ) const
privatepure virtual

Implemented in oops::LinearVariableChangeMaker< MODEL, T >.

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