ObsSpaceBase.h

Go to the documentation of this file.

/*
 * (C) Copyright 2009-2016 ECMWF.
 *
 * 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.
 * In applying this licence, ECMWF does not waive the privileges and immunities
 * granted to it by virtue of its status as an intergovernmental organisation nor
 * does it submit to any jurisdiction.
 */
 
#ifndef OOPS_BASE_OBSSPACEBASE_H_
#define OOPS_BASE_OBSSPACEBASE_H_
 
#include <boost/noncopyable.hpp>
 
#include "eckit/mpi/Comm.h"
 
#include "oops/util/DateTime.h"
#include "oops/util/parameters/Parameter.h"
#include "oops/util/parameters/Parameters.h"
#include "oops/util/Printable.h"
 
namespace eckit {
  class Configuration;
}
 
namespace oops {
 
/// \brief Base class for configuration parameters of observation spaces.
class ObsSpaceParametersBase : public oops::Parameters {
  OOPS_ABSTRACT_PARAMETERS(ObsSpaceParametersBase, Parameters)
 
 public:
  /// \brief An integer added to the seed used to initialize the random number generator
  /// producing observation perturbations (if these are requested).
  ///
  /// The seed is a sum of this integer and terms derived from the position of the assimilation
  /// window, the ensemble member index and the number of ObsSpaceBase instances created so far
  /// during the lifetime of the program.
  oops::Parameter<int> obsPerturbationsSeed{"obs perturbations seed", 0, this};
};
 
// -----------------------------------------------------------------------------
/// Base class for observation spaces.
 
class ObsSpaceBase : public util::Printable,
                     private boost::noncopyable {
 public:
  ObsSpaceBase(const ObsSpaceParametersBase &, const eckit::mpi::Comm &,
               const util::DateTime &, const util::DateTime &);
 
  virtual ~ObsSpaceBase() {}
 
/// Access information
  const util::DateTime & windowStart() const {return winbgn_;}
  const util::DateTime & windowEnd() const {return winend_;}
 
  int64_t getSeed() const {return seed_;}
 
 private:
  static int instances_;
 
  const util::DateTime winbgn_;
  const util::DateTime winend_;
  int64_t seed_;
  const int instance_;
};
 
// -----------------------------------------------------------------------------
 
}  // namespace oops
 
#endif  // OOPS_BASE_OBSSPACEBASE_H_