UFO
ufo::DataHandlerParameters Class Reference

Options controlling the operation of the EntireSampleDataHandler and ProfileDataHandler classes. More...

#include <DataHandlerParameters.h>

Inheritance diagram for ufo::DataHandlerParameters:
Collaboration diagram for ufo::DataHandlerParameters:

Public Member Functions

bool getOptional (const std::string &groupname) const
 Determine whether a variable group is optional or not. More...
 
size_t getEntriesPerProfile (const std::string &groupname) const
 Determine number of entries per profile for a variable group. More...
 

Public Attributes

oops::Parameter< std::vector< std::string > > groups_optional {"groups_optional", {"Corrections", "Counters"}, this}
 
oops::Parameter< std::vector< std::string > > groups_singlevalue {"groups_singlevalue", {"Counters"}, this}
 Groups of variables which have one value per profile. More...
 
oops::Parameter< int > nErrorsFail {"nErrorsFail", 1, this}
 Number of errors, accumulated over checks, that cause the observation to have failed. More...
 

Detailed Description

Options controlling the operation of the EntireSampleDataHandler and ProfileDataHandler classes.

Definition at line 25 of file DataHandlerParameters.h.

Member Function Documentation

◆ getEntriesPerProfile()

size_t ufo::DataHandlerParameters::getEntriesPerProfile ( const std::string &  groupname) const
inline

Determine number of entries per profile for a variable group.

Definition at line 40 of file DataHandlerParameters.h.

Here is the caller graph for this function:

◆ getOptional()

bool ufo::DataHandlerParameters::getOptional ( const std::string &  groupname) const
inline

Determine whether a variable group is optional or not.

Definition at line 30 of file DataHandlerParameters.h.

Here is the caller graph for this function:

Member Data Documentation

◆ groups_optional

oops::Parameter<std::vector<std::string> > ufo::DataHandlerParameters::groups_optional {"groups_optional", {"Corrections", "Counters"}, this}

Groups of variables whose presence in the input sample is optional (if not present, all variables are initially set to zero).

Definition at line 54 of file DataHandlerParameters.h.

◆ groups_singlevalue

oops::Parameter<std::vector<std::string> > ufo::DataHandlerParameters::groups_singlevalue {"groups_singlevalue", {"Counters"}, this}

Groups of variables which have one value per profile.

Definition at line 58 of file DataHandlerParameters.h.

◆ nErrorsFail

oops::Parameter<int> ufo::DataHandlerParameters::nErrorsFail {"nErrorsFail", 1, this}

Number of errors, accumulated over checks, that cause the observation to have failed.

Definition at line 62 of file DataHandlerParameters.h.


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