UFO
ufo::ConditionalParameters< FunctionValue > Class Template Reference

Parameters controlling the Conditional obs function. More...

#include <Conditional.h>

Inheritance diagram for ufo::ConditionalParameters< FunctionValue >:
Collaboration diagram for ufo::ConditionalParameters< FunctionValue >:

Public Attributes

oops::RequiredParameter< std::vector< LocalConditionalParameters< FunctionValue > > > cases
 
oops::OptionalParameter< FunctionValue > defaultvalue {"defaultvalue", this}
 
oops::Parameter< bool > firstmatchingcase {"firstmatchingcase", true, this}
 

Detailed Description

template<typename FunctionValue>
class ufo::ConditionalParameters< FunctionValue >

Parameters controlling the Conditional obs function.

Definition at line 52 of file Conditional.h.

Member Data Documentation

◆ cases

template<typename FunctionValue >
oops::RequiredParameter<std::vector<LocalConditionalParameters<FunctionValue> > > ufo::ConditionalParameters< FunctionValue >::cases
Initial value:
{
"cases", this}

List of cases for assignment. See LocalConditionalParameters for what each where clause requires.

Definition at line 58 of file Conditional.h.

◆ defaultvalue

template<typename FunctionValue >
oops::OptionalParameter<FunctionValue> ufo::ConditionalParameters< FunctionValue >::defaultvalue {"defaultvalue", this}

Default value for the array to be assigned. Missing value is used if this is not present in the yaml.

Definition at line 63 of file Conditional.h.

◆ firstmatchingcase

template<typename FunctionValue >
oops::Parameter<bool> ufo::ConditionalParameters< FunctionValue >::firstmatchingcase {"firstmatchingcase", true, this}

When this flag is true a value is assigned for the first matching where case for a location. This matches with the python case logic. When this is false the last matching case will take precedence which replicates a series of separate variable assignment filter calls.

Definition at line 69 of file Conditional.h.


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