GaudiSequencer.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, 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 GAUDISEQUENCER_H
#define GAUDISEQUENCER_H 1

// Include files
// from Gaudi
#include "GaudiAlg/GaudiAlg.h"
#include "GaudiAlg/GaudiCommon.h"
#include <Gaudi/Sequence.h>

// Forward declarations
class ISequencerTimerTool;

class GAUDI_API GaudiSequencer : public GaudiCommon<Gaudi::Sequence> {
public:
  using GaudiCommon::GaudiCommon;

  StatusCode initialize() override;
  StatusCode execute( const EventContext& ctx ) const override;
  StatusCode sysExecute( const EventContext& ctx ) override;

  std::ostream& toControlFlowExpression( std::ostream& os ) const override;

private:
  class AlgorithmEntry final {
  public:
    AlgorithmEntry( Gaudi::Algorithm* alg ) : m_algorithm( alg ) {}

    void setReverse( bool flag ) { m_reverse = flag; }

    Gaudi::Algorithm* algorithm() const { return m_algorithm; }
    bool              reverse() const { return m_reverse; }
    void              setTimer( int nb ) { m_timer = nb; }
    int               timer() const { return m_timer; }

  private:
    Gaudi::Algorithm* m_algorithm = nullptr; 
    bool              m_reverse   = false;   
    int               m_timer     = 0;       
  };

  StatusCode decodeNames();

  void membershipHandler();

  Gaudi::Property<std::vector<std::string>> m_vetoObjs{
      this, "VetoObjects", {}, "skip execute if one or more of these TES objects exist"};
  Gaudi::Property<std::vector<std::string>> m_requireObjs{
      this, "RequireObjects", {}, "execute only if one or more of these TES objects exist"};

  Gaudi::Property<std::vector<std::string>> m_names = {
      this, "Members", {}, &GaudiSequencer::membershipHandler, "list of algorithms"};
  Gaudi::Property<bool> m_sequential   = {this, "Sequential", false, "execute members one at a time"};
  Gaudi::Property<bool> m_modeOR       = {this, "ModeOR", false, "use OR logic instead of AND"};
  Gaudi::Property<bool> m_ignoreFilter = {this, "IgnoreFilterPassed", false, "always continue"};
  Gaudi::Property<bool> m_measureTime  = {this, "MeasureTime", false, "measure time"};
  Gaudi::Property<bool> m_returnOK     = {this, "ReturnOK", false, "forces the sequencer to return a good status"};
  Gaudi::Property<bool> m_shortCircuit = {this, "ShortCircuit", true, "stop processing as soon as possible"};
  Gaudi::Property<bool> m_invert       = {this, "Invert", false, "invert the logic result of the sequencer"};

  std::vector<AlgorithmEntry> m_entries;             
  ISequencerTimerTool*        m_timerTool = nullptr; 
  int                         m_timer;               
};
#endif // GAUDISEQUENCER_H