UFO
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ufo::ObsExample Class Reference

Example observation operator class. More...

#include <ObsExample.h>

Inheritance diagram for ufo::ObsExample:
Inheritance graph
[legend]
Collaboration diagram for ufo::ObsExample:
Collaboration graph
[legend]

Public Member Functions

 ObsExample (const ioda::ObsSpace &, const eckit::Configuration &)
 
virtual ~ObsExample ()
 
void simulateObs (const GeoVaLs &, ioda::ObsVector &, ObsDiagnostics &) const override
 Obs Operator. More...
 
const oops::Variables & requiredVars () const override
 Operator input required from Model. More...
 
int & toFortran ()
 
const int & toFortran () const
 
- Public Member Functions inherited from ufo::ObsOperatorBase
 ObsOperatorBase (const ioda::ObsSpace &odb, const eckit::Configuration &=eckit::LocalConfiguration())
 
virtual ~ObsOperatorBase ()
 
virtual std::unique_ptr< Locations > locations () const
 Locations for GeoVaLs. More...
 
virtual oops::Variables simulatedVars () const
 List of variables simulated by this operator. More...
 

Static Public Member Functions

static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const override
 

Private Attributes

F90hop keyOper_
 
const ioda::ObsSpace & odb_
 
oops::Variables varin_
 

Detailed Description

Example observation operator class.

Definition at line 36 of file ObsExample.h.

Constructor & Destructor Documentation

◆ ObsExample()

ufo::ObsExample::ObsExample ( const ioda::ObsSpace &  odb,
const eckit::Configuration &  config 
)

Definition at line 25 of file ObsExample.cc.

Here is the call graph for this function:

◆ ~ObsExample()

ufo::ObsExample::~ObsExample ( )
virtual

Definition at line 35 of file ObsExample.cc.

Here is the call graph for this function:

Member Function Documentation

◆ classname()

static const std::string ufo::ObsExample::classname ( )
inlinestatic

Definition at line 39 of file ObsExample.h.

◆ print()

void ufo::ObsExample::print ( std::ostream &  os) const
overrideprivatevirtual

Implements ufo::ObsOperatorBase.

Definition at line 51 of file ObsExample.cc.

◆ requiredVars()

const oops::Variables& ufo::ObsExample::requiredVars ( ) const
inlineoverridevirtual

Operator input required from Model.

Implements ufo::ObsOperatorBase.

Definition at line 48 of file ObsExample.h.

◆ simulateObs()

void ufo::ObsExample::simulateObs ( const GeoVaLs &  ,
ioda::ObsVector &  ,
ObsDiagnostics &   
) const
overridevirtual

Obs Operator.

Implements ufo::ObsOperatorBase.

Definition at line 42 of file ObsExample.cc.

Here is the call graph for this function:

◆ toFortran() [1/2]

int& ufo::ObsExample::toFortran ( )
inline

Definition at line 50 of file ObsExample.h.

◆ toFortran() [2/2]

const int& ufo::ObsExample::toFortran ( ) const
inline

Definition at line 51 of file ObsExample.h.

Member Data Documentation

◆ keyOper_

F90hop ufo::ObsExample::keyOper_
private

Definition at line 55 of file ObsExample.h.

◆ odb_

const ioda::ObsSpace& ufo::ObsExample::odb_
private

Definition at line 56 of file ObsExample.h.

◆ varin_

oops::Variables ufo::ObsExample::varin_
private

Definition at line 57 of file ObsExample.h.

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