TriggerNamesService.h

Go to the documentation of this file.

#ifndef FWCore_Framework_TriggerNamesService_h
#define FWCore_Framework_TriggerNamesService_h

// -*- C++ -*-
/*

 Original Author:  Jim Kowalkowski 26-01-06


 This service makes the trigger names available.  They are provided
 in the same order that the pass/fail status of these triggers is
 recorded in the TriggerResults object.  These trigger names are
 the names of the paths that appear in the configuration (excluding
 end paths).  The order is the same as in the configuration.

 There are also accessors for the end path names.  

 There are other accessors for other trigger related information from the
 job configuration: the process name, whether a report on trigger results
 was requested and the parameter set containing the list of trigger paths.

 Almost all the functions return information related to the current
 process only.  The second and third getTrigPaths functions are exceptions.
 They will return the trigger path names from previous processes.

 Unit tests for parts of this class are in FWCore/Integration/run_SelectEvents.sh
 and the code it invokes.

*/

#include "FWCore/ParameterSet/interface/ParameterSet.h"

#include <string>
#include <map>
#include <vector>

namespace edm {

  class TriggerResults;

  namespace service {
    class TriggerNamesService {
    public:
      typedef std::vector<std::string> Strings;
      typedef std::map<std::string, unsigned int> PosMap;
      typedef PosMap::size_type size_type;

      explicit TriggerNamesService(ParameterSet const& proc_pset);
      // Default copy, copy assignment, d'tor all do the right thing.

      // trigger names for the current process

      // Return the number of trigger paths in the current process.
      size_type size() const { return trignames_.size(); }
      Strings const& getTrigPaths() const { return trignames_; }
      std::string const& getTrigPath(size_type const i) const { return trignames_.at(i); }
      size_type findTrigPath(std::string const& name) const { return find(trigpos_, name); }

      // Get the ordered vector of trigger names that corresponds to the bits
      // in the TriggerResults object.  Unlike the other functions in this class,
      // the next two functions will retrieve the names for previous processes.
      // If the TriggerResults object is from the current process, this only
      // works for modules in end paths, because the TriggerResults object is
      // not created until the normal paths complete execution.
      // Returns false if it fails to find the trigger path names.
      bool getTrigPaths(TriggerResults const& triggerResults, Strings& trigPaths);

      // This is the same as the previous function except the value returned in
      // the last argument indicates whether the results were retrieved from the
      // ParameterSet registry.  This will always be true except in old data where
      // the trigger names were stored inside of the TriggerResults object.
      bool getTrigPaths(TriggerResults const& triggerResults, Strings& trigPaths, bool& fromPSetRegistry);

      Strings const& getEndPaths() const { return end_names_; }
      std::string const& getEndPath(size_type const i) const { return end_names_.at(i); }
      size_type findEndPath(std::string const& name) const { return find(end_pos_, name); }

      Strings const& getTrigPathModules(std::string const& name) const { return modulenames_.at(find(trigpos_, name)); }
      Strings const& getTrigPathModules(size_type const i) const { return modulenames_.at(i); }
      std::string const& getTrigPathModule(std::string const& name, size_type const j) const {
        return (modulenames_.at(find(trigpos_, name))).at(j);
      }
      std::string const& getTrigPathModule(size_type const i, size_type const j) const {
        return (modulenames_.at(i)).at(j);
      }

      Strings const& getEndPathModules(std::string const& name) const {
        return end_modulenames_.at(find(end_pos_, name));
      }
      Strings const& getEndPathModules(size_type const i) const { return end_modulenames_.at(i); }
      std::string const& getEndPathModule(std::string const& name, size_type const j) const {
        return (end_modulenames_.at(find(end_pos_, name))).at(j);
      }
      std::string const& getEndPathModule(size_type const i, size_type const j) const {
        return (end_modulenames_.at(i)).at(j);
      }

      size_type find(PosMap const& posmap, std::string const& name) const {
        PosMap::const_iterator const pos(posmap.find(name));
        if (pos == posmap.end()) {
          return posmap.size();
        } else {
          return pos->second;
        }
      }

      std::string const& getProcessName() const { return process_name_; }
      bool wantSummary() const { return wantSummary_; }

      // Parameter set containing the trigger paths
      edm::ParameterSet const& getTriggerPSet() const { return trigger_pset_; }

    private:
      void loadPosMap(PosMap& posmap, Strings const& names) {
        size_type const n(names.size());
        for (size_type i = 0; i != n; ++i) {
          posmap[names[i]] = i;
        }
      }

      edm::ParameterSet trigger_pset_;

      Strings trignames_;
      PosMap trigpos_;
      Strings end_names_;
      PosMap end_pos_;

      std::vector<Strings> modulenames_;      // modules on trigger paths
      std::vector<Strings> end_modulenames_;  // modules on endpaths

      std::string process_name_;
      bool wantSummary_;
    };
  }  // namespace service
}  // namespace edm

#endif