oops::LinearModelParametersBase Class Reference

Base class for classes storing model-specific parameters. More...

#include <LinearModelBase.h>

Inheritance diagram for oops::LinearModelParametersBase:

Collaboration diagram for oops::LinearModelParametersBase:

Public Attributes
OptionalParameter< std::string >	name {"name", this}
	Model name. More...

Detailed Description

Base class for classes storing model-specific parameters.

Definition at line 111 of file LinearModelBase.h.

Member Data Documentation

name

OptionalParameter<std::string> oops::LinearModelParametersBase::name {"name", this}

Model name.

Note

This parameter is marked as optional because it is only required in certain circumstances (e.g. when model parameters are deserialized into a LinearModelParametersWrapper and used by LinearModelFactory to instantiate a tangent linear model whose type is determined at runtime), but not others (e.g. in tests written with a particular model in mind). LinearModelParametersWrapper will throw an exception if this parameter is not provided.

Definition at line 122 of file LinearModelBase.h.

---

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

• LinearModelBase.h