Example.h

Go to the documentation of this file.

/*
 * (C) Copyright 2017-2018 UCAR
 * 
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0. 
 */
 
#ifndef TOOLS_NEW_QC_EXAMPLE_EXAMPLE_H_
#define TOOLS_NEW_QC_EXAMPLE_EXAMPLE_H_
 
#include <memory>
#include <ostream>
#include <string>
 
#include "ioda/ObsDataVector.h"
#include "oops/base/Variables.h"
#include "oops/util/ObjectCounter.h"
#include "oops/interface/ObsFilterBase.h"
#include "tools/new_qc/example/Example.interface.h"
#include "ufo/ObsTraits.h"
 
namespace eckit {
  class Configuration;
}
 
namespace ioda {
  class ObsSpace;
  class ObsVector;
}
 
namespace ufo {
  class GeoVaLs;
  class ObsDiagnostics;
 
/// Example filter
 
class Example : public oops::interface::ObsFilterBase<ObsTraits>,
                private util::ObjectCounter<Example> {
 public:
  static const std::string classname() {return "ufo::Example";}
 
  Example(ioda::ObsSpace &, const eckit::Configuration &,
          std::shared_ptr<ioda::ObsDataVector<int> >,
          std::shared_ptr<ioda::ObsDataVector<float> >);
  ~Example();
 
  void preProcess() override {}
  void priorFilter(const GeoVaLs &) override;
  void postFilter(const ioda::ObsVector &, const ioda::ObsVector &,
                  const ObsDiagnostics &) override;
 
  oops::Variables requiredVars() const override {return geovars_;}
  oops::Variables requiredHdiagnostics() const override {return diagnostics_;}
 
 private:
  void print(std::ostream &) const override;
  F90check key_;
 
  ioda::ObsSpace & obsdb_;
  oops::Variables geovars_;
  oops::Variables diagnostics_;
  ioda::ObsDataVector<int> & flags_;
};
 
}  // namespace ufo
 
#endif  // TOOLS_NEW_QC_EXAMPLE_EXAMPLE_H_