Triggers.h

Go to the documentation of this file.

// Copyright CERN and copyright holders of ALICE O2. This software is
// distributed under the terms of the GNU General Public License v3 (GPL
// Version 3), copied verbatim in the file "COPYING".
//
// See http://alice-o2.web.cern.ch/license for full licensing information.
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.


#ifndef QUALITYCONTROL_TRIGGERS_H
#define QUALITYCONTROL_TRIGGERS_H

#include <string>
#include <functional>
#include <iosfwd>

namespace o2::quality_control::postprocessing
{

// todo: implement the rest
enum TriggerType {
  No = 0, // casts to boolean false
  Once,   // triggers only first time it is asked
  Always, // triggers always
  StartOfRun,
  EndOfRun,
  StartOfFill,
  EndOfFill,
  Periodic,
  NewObject,
  UserOrControl, // reacts start and stop transitions (not an update trigger).
  INVALID
};

struct Trigger {

  Trigger(TriggerType triggerType) : triggerType(triggerType), timestamp(msSinceEpoch()){};
  Trigger(TriggerType triggerType, uint64_t timestamp) : triggerType(triggerType), timestamp(timestamp){};

  operator bool() const { return triggerType != TriggerType::No && triggerType != TriggerType::INVALID; }
  friend std::ostream& operator<<(std::ostream& out, const Trigger& t);
  bool operator==(TriggerType other) const
  {
    return triggerType == other;
  }

  static uint64_t msSinceEpoch();

  TriggerType triggerType;
  uint64_t timestamp;
};

using TriggerFcn = std::function<Trigger()>;

namespace triggers
{

TriggerFcn StartOfRun();
TriggerFcn EndOfRun();
TriggerFcn StartOfFill();
TriggerFcn EndOfFill();
TriggerFcn Periodic(double seconds);
TriggerFcn NewObject(std::string databaseUrl, std::string objectPath);
TriggerFcn Once();
TriggerFcn Always();
TriggerFcn Never();

} // namespace triggers

} // namespace o2::quality_control::postprocessing

#endif //QUALITYCONTROL_TRIGGERS_H