DetectorClocks.h

Go to the documentation of this file.

/**
 * \file lardataalg/DetectorInfo/DetectorClocks.h
 *
 * \brief pure virtual base interface for detector clocks
 *
 * \author jpaley@fnal.gov
 *
 */
#ifndef LARDATAALG_DETECTORINFO_DETECTORCLOCKS_H
#define LARDATAALG_DETECTORINFO_DETECTORCLOCKS_H

#include "lardataalg/DetectorInfo/DetectorClocksData.h"
#include "lardataalg/DetectorInfo/ElecClock.h"

// C++ libraries
#include <string>
#include <vector>

namespace detinfo {

  enum ConfigType_t {
    kG4RefTime = 0,
    kTriggerOffsetTPC,
    kFramePeriod,
    kClockSpeedTPC,
    kClockSpeedOptical,
    kClockSpeedTrigger,
    kClockSpeedExternal,
    kDefaultTrigTime,
    kDefaultBeamTime,
    kConfigTypeMax
  };

  /** **************************************************************************
   * @brief Class used for the conversion of times between different
   *        formats and references.
   *
   * `detinfo::DetectorClocks` is an abstract interface enclosing the set of
   * supported queries. A concrete implementation of this interface needs to be
   * provided in order to use this facility. LArSoft provides
   * `detinfo::DetectorClocksStandard` as a simple, reasonable implementation.
   * Initialization and configuration are designed by each implementation.
   *
   * The only use of this provider in LArSoft version 9 and newer is to provide
   * an instance of `detinfo::DetectorClocksData` containing all the relevant
   * information.
   *
   * Helper functions may be available to extract the necessary information
   * from specific implementations of `detinfo::DetectorClocks`.
   */

  class DetectorClocks {
  public:
    virtual ~DetectorClocks() = default;

    /// Returns a list of provider configuration names.
    /// @see ConfigValues()
    virtual std::vector<std::string> const& ConfigNames() const = 0;

    /// Returns a list of provider configuration values
    /// (same order as `ConfigNames()`).
    /// @see ConfigNames()
    virtual std::vector<double> const& ConfigValues() const = 0;

    /**
     * @brief Returns a complete `detinfo::DetectorClocksData` object.
     *
     * The returned timing information is based on information independent
     * of the current input file, run or event.
     * It is recommended that `DataFor()` is used instead whenever possible.
     */
    virtual DetectorClocksData DataForJob() const = 0;

    /**
     * @brief Returns a complete `detinfo::DetectorClocksData` object.
     * @param g4_ref_time start of simulation time in electronics time scale [ns]
     * @param trigger_time the default hardware trigger time in electronics time
     * @param beam_time the default beam gate opening time in electronics time
     *
     * The returned timing information reflects the current context, defined
     * by the parameters passed to this method.
     *
     * If the information required by the parameters is not available, users
     * will be forced to use `DataForJob()` instead.
     *
     * For more details on the definition of the parameters, see the
     * documentation of `detinfo::DetectorClocksData` constructor.
     */
    virtual DetectorClocksData DataFor(double g4_ref_time,
                                       double trigger_time,
                                       double beam_time) const = 0;
  }; // class DetectorClocks

} // namespace detinfo

#endif // LARDATAALG_DETECTORINFO_DETECTORCLOCKS_H