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

Localization Factory. More...

#include <LocalizationBase.h>

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

Public Member Functions

virtual ~LocalizationFactory ()=default
 

Static Public Member Functions

static std::unique_ptr< LocalizationBase< MODEL > > create (const Geometry_ &, const eckit::Configuration &config)
 Create and return a new Localization. More...
 

Protected Member Functions

 LocalizationFactory (const std::string &name)
 Register a maker able to create Localizations of type name. More...
 

Private Types

typedef Geometry< MODEL > Geometry_
 

Private Member Functions

virtual std::unique_ptr< LocalizationBase< MODEL > > make (const Geometry_ &, const eckit::Configuration &)=0
 

Static Private Member Functions

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

Detailed Description

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

Localization Factory.

Definition at line 61 of file generic/LocalizationBase.h.

Member Typedef Documentation

◆ Geometry_

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

Definition at line 62 of file generic/LocalizationBase.h.

Constructor & Destructor Documentation

◆ ~LocalizationFactory()

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

◆ LocalizationFactory()

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

Register a maker able to create Localizations of type name.

Definition at line 99 of file generic/LocalizationBase.h.

Member Function Documentation

◆ create()

template<typename MODEL >
std::unique_ptr< LocalizationBase< MODEL > > oops::LocalizationFactory< MODEL >::create ( const Geometry_ &  geometry,
const eckit::Configuration &  config 
)
static

Create and return a new Localization.

The Localization type is determined by the "localization method" entry of config.

Definition at line 110 of file generic/LocalizationBase.h.

◆ getMakers()

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

Definition at line 77 of file generic/LocalizationBase.h.

◆ make()

template<typename MODEL >
virtual std::unique_ptr<LocalizationBase<MODEL> > oops::LocalizationFactory< MODEL >::make ( const Geometry_ &  ,
const eckit::Configuration &   
)
privatepure virtual

Implemented in oops::interface::LocalizationMaker< MODEL, T >, and oops::LocalizationMaker< MODEL, T >.

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