ITimeSeriesProperty.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include <vector>
 
namespace Mantid {
namespace Types {
namespace Core {
class DateAndTime;
}
} // namespace Types
namespace Kernel {
//---------------------------------------------------------------------------
// Forward Declarations
//---------------------------------------------------------------------------
class SplittingInterval;
class TimeInterval;
class Property;
class ITimeSeriesProperty {
public:
  virtual void makeFilterByValue(std::vector<SplittingInterval> &split, double min, double max, double TimeTolerance,
                                 bool centre = true) const = 0;
  virtual void expandFilterToRange(std::vector<SplittingInterval> &split, double min, double max,
                                   const TimeInterval &range) const = 0;
  // Provide a new instance of the ITimeSeriesProperty with shifted time values
  // After trying to use return type covariance, but that showed Error C2908
  // Using property seemed to be the most straightforward solution.
  virtual Property *cloneWithTimeShift(const double timeShift) const = 0;
  virtual double averageValueInFilter(const std::vector<SplittingInterval> &filter) const = 0;
  virtual std::pair<double, double> averageAndStdDevInFilter(const std::vector<SplittingInterval> &filter) const = 0;
  virtual std::vector<Types::Core::DateAndTime> timesAsVector() const = 0;
  virtual double timeAverageValue() const = 0;
  virtual int realSize() const = 0;
  virtual void clear() = 0;
  virtual void clearOutdated() = 0;
  virtual ~ITimeSeriesProperty() = default;
};
 
} // namespace Kernel
} // namespace Mantid