CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
HLTStreamFilter Class Referenceabstract

#include <HLTStreamFilter.h>

Inheritance diagram for HLTStreamFilter:
edm::stream::EDFilter<> edm::stream::EDFilterBase edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper HLTL1TSeed HLTLevel1GTSeed

Public Member Functions

 HLTStreamFilter (const edm::ParameterSet &config)
 
int module (edm::Event const &) const
 
const std::string * moduleLabel () const
 
int path (edm::Event const &) const
 
const std::string * pathName (edm::Event const &) const
 
std::pair< int, int > pmid (edm::Event const &) const
 
bool saveTags () const
 
 ~HLTStreamFilter () override
 
- Public Member Functions inherited from edm::stream::EDFilter<>
 EDFilter ()=default
 
bool hasAbilityToProduceInLumis () const final
 
bool hasAbilityToProduceInRuns () const final
 
- Public Member Functions inherited from edm::stream::EDFilterBase
 EDFilterBase ()
 
ModuleDescription const & moduleDescription () const
 
 ~EDFilterBase () override
 
- Public Member Functions inherited from edm::ProducerBase
void callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
 
std::vector< edm::ProductResolverIndex > const & indiciesForPutProducts (BranchType iBranchType) const
 
 ProducerBase ()
 
std::vector< edm::ProductResolverIndex > const & putTokenIndexToProductResolverIndex () const
 
void registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
 
std::function< void(BranchDescription const &)> registrationCallback () const
 used by the fwk to register list of products More...
 
void resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
 
 ~ProducerBase () noexcept(false) override
 
- Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfoconsumesInfo () const
 
void convertCurrentProcessAlias (std::string const &processName)
 Convert "@currentProcess" in InputTag process names to the actual current process name. More...
 
 EDConsumerBase ()
 
 EDConsumerBase (EDConsumerBase const &)=delete
 
 EDConsumerBase (EDConsumerBase &&)=default
 
ESProxyIndex const * esGetTokenIndices (edm::Transition iTrans) const
 
ProductResolverIndexAndSkipBit indexFrom (EDGetToken, BranchType, TypeID const &) const
 
void itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
 
void itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
 
std::vector< ProductResolverIndexAndSkipBit > const & itemsToGetFrom (BranchType iType) const
 
void labelsForToken (EDGetToken iToken, Labels &oLabels) const
 
void modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
 
EDConsumerBase const & operator= (EDConsumerBase const &)=delete
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
bool registeredToConsume (ProductResolverIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
ProductResolverIndexAndSkipBit uncheckedIndexFrom (EDGetToken) const
 
void updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
 
void updateLookup (eventsetup::ESRecordsToProxyIndices const &)
 
virtual ~EDConsumerBase () noexcept(false)
 

Static Public Member Functions

static void makeHLTFilterDescription (edm::ParameterSetDescription &desc)
 
- Static Public Member Functions inherited from edm::stream::EDFilterBase
static const std::string & baseType ()
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &descriptions)
 

Private Member Functions

bool filter (edm::Event &event, const edm::EventSetup &setup) final
 
virtual bool hltFilter (edm::Event &event, const edm::EventSetup &setup, trigger::TriggerFilterObjectWithRefs &filterobject)=0
 

Private Attributes

const bool saveTags_
 

Additional Inherited Members

- Public Types inherited from edm::stream::EDFilter<>
typedef CacheContexts< T... > CacheTypes
 
typedef CacheTypes::GlobalCache GlobalCache
 
typedef AbilityChecker< T... > HasAbility
 
typedef CacheTypes::LuminosityBlockCache LuminosityBlockCache
 
typedef LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCacheLuminosityBlockContext
 
typedef CacheTypes::LuminosityBlockSummaryCache LuminosityBlockSummaryCache
 
typedef CacheTypes::RunCache RunCache
 
typedef RunContextT< RunCache, GlobalCacheRunContext
 
typedef CacheTypes::RunSummaryCache RunSummaryCache
 
- Public Types inherited from edm::stream::EDFilterBase
typedef EDFilterAdaptorBase ModuleType
 
- Public Types inherited from edm::ProducerBase
using ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex >>
 
typedef ProductRegistryHelper::TypeLabelList TypeLabelList
 
- Public Types inherited from edm::EDConsumerBase
typedef ProductLabels Labels
 
- Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
EDGetToken consumes (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken consumes (TypeToGet const &id, edm::InputTag const &tag)
 
ConsumesCollector consumesCollector ()
 Use a ConsumesCollector to gather consumes information from helper functions. More...
 
template<typename ProductType , BranchType B = InEvent>
void consumesMany ()
 
void consumesMany (const TypeToGet &id)
 
template<BranchType B>
void consumesMany (const TypeToGet &id)
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes ()
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes (ESInputTag const &tag)
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > mayConsume (edm::InputTag const &tag)
 
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 

Detailed Description

This class derives from EDFilter and adds a few HLT specific items. All HLT filters that wish to save summary objects for the AOD must derive from the HLTStreamFilter class.

Author
Martin Grunewald

This class derives from EDFilter and adds a few HLT specific items. Any and all HLT filters must derive from the HLTStreamFilter class!

Author
Martin Grunewald

Definition at line 29 of file HLTStreamFilter.h.

Constructor & Destructor Documentation

HLTStreamFilter::HLTStreamFilter ( const edm::ParameterSet config)
explicit

Definition at line 20 of file HLTStreamFilter.cc.

20  :
21  EDFilter(),
22  saveTags_(config.getParameter<bool>("saveTags"))
23 {
24  // register common HLTStreamFilter products
25  produces<trigger::TriggerFilterObjectWithRefs>();
26 }
T getParameter(std::string const &) const
const bool saveTags_
HLTStreamFilter::~HLTStreamFilter ( )
overridedefault

Member Function Documentation

bool HLTStreamFilter::filter ( edm::Event event,
const edm::EventSetup setup 
)
finalprivate

Definition at line 35 of file HLTStreamFilter.cc.

References hltFilter(), module(), eostools::move(), path(), and mps_fire::result.

35  {
36  std::unique_ptr<trigger::TriggerFilterObjectWithRefs> filterproduct( new trigger::TriggerFilterObjectWithRefs(path(event), module(event)) );
37 
38  // compute the result of the HLTStreamFilter implementation
39  bool result = hltFilter(event, setup, * filterproduct);
40 
41  // put filter object into the Event
42  event.put(std::move(filterproduct));
43 
44  // retunr the result of the HLTStreamFilter
45  return result;
46 }
int module(edm::Event const &) const
virtual bool hltFilter(edm::Event &event, const edm::EventSetup &setup, trigger::TriggerFilterObjectWithRefs &filterobject)=0
int path(edm::Event const &) const
def move(src, dest)
Definition: eostools.py:511
virtual bool HLTStreamFilter::hltFilter ( edm::Event event,
const edm::EventSetup setup,
trigger::TriggerFilterObjectWithRefs filterobject 
)
privatepure virtual

Implemented in HLTLevel1GTSeed, and HLTL1TSeed.

Referenced by filter().

void HLTStreamFilter::makeHLTFilterDescription ( edm::ParameterSetDescription desc)
static

Definition at line 29 of file HLTStreamFilter.cc.

References edm::ParameterSetDescription::add(), and ~HLTStreamFilter().

Referenced by HLTL1TSeed::fillDescriptions(), and HLTLevel1GTSeed::fillDescriptions().

29  {
30  desc.add<bool>("saveTags",true);
31 }
ParameterDescriptionBase * add(U const &iLabel, T const &value)
int HLTStreamFilter::module ( edm::Event const &  event) const

Definition at line 52 of file HLTStreamFilter.cc.

Referenced by filter(), and saveTags().

52  {
53  return static_cast<int>(event.moduleCallingContext()->placeInPathContext()->placeInPath());
54 }
const std::string * HLTStreamFilter::moduleLabel ( ) const

Definition at line 66 of file HLTStreamFilter.cc.

References edm::stream::EDFilterBase::moduleDescription(), and edm::ModuleDescription::moduleLabel().

Referenced by saveTags().

66  {
67  return &moduleDescription().moduleLabel();
68 }
ModuleDescription const & moduleDescription() const
Definition: EDFilterBase.h:59
std::string const & moduleLabel() const
int HLTStreamFilter::path ( edm::Event const &  event) const

Definition at line 48 of file HLTStreamFilter.cc.

Referenced by filter(), and saveTags().

48  {
49  return static_cast<int>(event.moduleCallingContext()->placeInPathContext()->pathContext()->pathID());
50 }
const std::string * HLTStreamFilter::pathName ( edm::Event const &  event) const

Definition at line 62 of file HLTStreamFilter.cc.

Referenced by saveTags().

62  {
63  return &event.moduleCallingContext()->placeInPathContext()->pathContext()->pathName();
64 }
std::pair< int, int > HLTStreamFilter::pmid ( edm::Event const &  event) const

Definition at line 56 of file HLTStreamFilter.cc.

References edm::PlaceInPathContext::pathContext(), edm::PathContext::pathID(), and edm::PlaceInPathContext::placeInPath().

Referenced by saveTags().

56  {
57  edm::PlaceInPathContext const* placeInPathContext = event.moduleCallingContext()->placeInPathContext();
58  return std::make_pair(static_cast<int>(placeInPathContext->pathContext()->pathID()),
59  static_cast<int>(placeInPathContext->placeInPath()));
60 }
PathContext const * pathContext() const
unsigned int pathID() const
Definition: PathContext.h:32
unsigned int placeInPath() const
bool HLTStreamFilter::saveTags ( ) const
inline

Member Data Documentation

const bool HLTStreamFilter::saveTags_
private

Definition at line 43 of file HLTStreamFilter.h.

Referenced by saveTags().