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

VariableChange factory. More...

#include <VariableChangeBase.h>

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

Public Member Functions

virtual ~VariableChangeFactory ()=default
 

Static Public Member Functions

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

Protected Member Functions

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

Private Types

typedef Geometry< MODEL > Geometry_
 

Private Member Functions

virtual GenericVariableChangeBase< MODEL > * make (const Geometry_ &, const VariableChangeParametersBase &)=0
 
virtual std::unique_ptr< VariableChangeParametersBase > makeParameters () const =0
 

Static Private Member Functions

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

Detailed Description

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

VariableChange factory.

Definition at line 143 of file VariableChangeBase.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 144 of file VariableChangeBase.h.

Constructor & Destructor Documentation

◆ ~VariableChangeFactory()

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

◆ VariableChangeFactory()

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

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

Definition at line 239 of file VariableChangeBase.h.

Member Function Documentation

◆ create()

template<typename MODEL >
GenericVariableChangeBase< MODEL > * oops::VariableChangeFactory< MODEL >::create ( const Geometry_ &  resol,
const VariableChangeParametersBase &  params 
)
static

Create and return a new 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 VariableChangeParametersBase associated with that variable change type, otherwise an exception will be thrown.

Definition at line 249 of file VariableChangeBase.h.

◆ createParameters()

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

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

Definition at line 268 of file VariableChangeBase.h.

◆ getMakerNames()

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

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

Definition at line 161 of file VariableChangeBase.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, VariableChangeFactory<MODEL> * >& oops::VariableChangeFactory< MODEL >::getMakers ( )
inlinestaticprivate

Definition at line 177 of file VariableChangeBase.h.

Here is the caller graph for this function:

◆ make()

template<typename MODEL >
virtual GenericVariableChangeBase<MODEL>* oops::VariableChangeFactory< MODEL >::make ( const Geometry_ &  ,
const VariableChangeParametersBase &   
)
privatepure virtual

Implemented in oops::VariableChangeMaker< MODEL, T >, and oops::GenericVariableChangeMaker< MODEL, T >.

◆ makeParameters()

template<typename MODEL >
virtual std::unique_ptr<VariableChangeParametersBase> oops::VariableChangeFactory< MODEL >::makeParameters ( ) const
privatepure virtual

Implemented in oops::VariableChangeMaker< MODEL, T >, and oops::GenericVariableChangeMaker< MODEL, T >.

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