BankPulseTimes.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 "MantidDataHandling/DllConfig.h"
#include "MantidKernel/DateAndTime.h"
#include <mutex>
 
namespace Mantid::Nexus {
class File;
}
 
namespace Mantid::DataHandling {
class MANTID_DATAHANDLING_DLL BankPulseTimes {
public:
  static const int FIRST_PERIOD;
  static const std::string DEFAULT_START_TIME;
 
  BankPulseTimes(Nexus::File &file, const std::vector<int> &periodNumbers);
 
  BankPulseTimes(const std::vector<Mantid::Types::Core::DateAndTime> &times);
 
  BankPulseTimes(const std::vector<Mantid::Types::Core::DateAndTime> &times, const std::vector<int> &periodNumbers);
 
  size_t numberOfPulses() const;
 
  bool arePulseTimesIncreasing() const;
 
  int periodNumber(const size_t index) const;
  const Mantid::Types::Core::DateAndTime &pulseTime(const size_t index) const;
 
  std::vector<size_t> getPulseIndices(const Mantid::Types::Core::DateAndTime &start,
                                      const Mantid::Types::Core::DateAndTime &stop) const;
 
  // convert a list of time intervals to pulse indices
  std::vector<size_t> getPulseIndices(const std::vector<Mantid::Kernel::TimeInterval> &splitters) const;
 
  bool equals(size_t otherNumPulse, const std::string &otherStartTime);
 
  std::string startTime;
 
private:
  template <typename ValueType>
  void readData(Nexus::File &file, std::size_t numValues, Mantid::Types::Core::DateAndTime &start);
 
  void updateStartTime();
 
  void finalizePeriodNumbers();
 
  std::vector<int> periodNumbers;
 
  std::vector<Mantid::Types::Core::DateAndTime> pulseTimes;
 
  bool have_period_info;
 
  mutable int8_t m_sorting_info;
  mutable std::mutex m_sortingMutex;
};
} // namespace Mantid::DataHandling