CMS 3D CMS Logo

List of all members | Public Member Functions | Protected Attributes
pat::helper::OverlapTest Class Referenceabstract

#include <OverlapTest.h>

Inheritance diagram for pat::helper::OverlapTest:
pat::helper::BasicOverlapTest pat::helper::OverlapBySuperClusterSeed

Public Member Functions

virtual void done ()
 end of event method. does nothing More...
 
virtual bool fillOverlapsForItem (const reco::Candidate &item, reco::CandidatePtrVector &overlapsToFill) const =0
 
const std::string & name () const
 
 OverlapTest (const std::string &name, const edm::ParameterSet &iConfig, edm::ConsumesCollector &iC)
 constructor: reads 'src' and 'requireNoOverlaps' parameters More...
 
virtual void readInput (const edm::Event &iEvent, const edm::EventSetup &iSetup)=0
 initializer for each event. to be implemented in child classes. More...
 
bool requireNoOverlaps () const
 
virtual ~OverlapTest ()
 destructor, does nothing More...
 

Protected Attributes

std::string name_
 
bool requireNoOverlaps_
 
edm::EDGetTokenT< reco::CandidateViewsrcToken_
 

Detailed Description

Definition at line 19 of file OverlapTest.h.

Constructor & Destructor Documentation

◆ OverlapTest()

pat::helper::OverlapTest::OverlapTest ( const std::string &  name,
const edm::ParameterSet iConfig,
edm::ConsumesCollector iC 
)
inline

constructor: reads 'src' and 'requireNoOverlaps' parameters

Definition at line 22 of file OverlapTest.h.

24  name_(name),
25  requireNoOverlaps_(iConfig.getParameter<bool>("requireNoOverlaps")) {}

◆ ~OverlapTest()

virtual pat::helper::OverlapTest::~OverlapTest ( )
inlinevirtual

destructor, does nothing

Definition at line 27 of file OverlapTest.h.

27 {}

Member Function Documentation

◆ done()

virtual void pat::helper::OverlapTest::done ( )
inlinevirtual

end of event method. does nothing

Definition at line 34 of file OverlapTest.h.

34 {}

◆ fillOverlapsForItem()

virtual bool pat::helper::OverlapTest::fillOverlapsForItem ( const reco::Candidate item,
reco::CandidatePtrVector overlapsToFill 
) const
pure virtual

check for overlaps for a given item. to be implemented in child classes return true if overlaps have been found, and fills the PtrVector

Implemented in pat::helper::OverlapBySuperClusterSeed, and pat::helper::BasicOverlapTest.

◆ name()

const std::string& pat::helper::OverlapTest::name ( void  ) const
inline

◆ readInput()

virtual void pat::helper::OverlapTest::readInput ( const edm::Event iEvent,
const edm::EventSetup iSetup 
)
pure virtual

initializer for each event. to be implemented in child classes.

Implemented in pat::helper::OverlapBySuperClusterSeed, and pat::helper::BasicOverlapTest.

◆ requireNoOverlaps()

bool pat::helper::OverlapTest::requireNoOverlaps ( ) const
inline

Definition at line 38 of file OverlapTest.h.

38 { return requireNoOverlaps_; }

References requireNoOverlaps_.

Member Data Documentation

◆ name_

std::string pat::helper::OverlapTest::name_
protected

Definition at line 42 of file OverlapTest.h.

Referenced by name().

◆ requireNoOverlaps_

bool pat::helper::OverlapTest::requireNoOverlaps_
protected

Definition at line 43 of file OverlapTest.h.

Referenced by requireNoOverlaps().

◆ srcToken_

edm::EDGetTokenT<reco::CandidateView> pat::helper::OverlapTest::srcToken_
protected
pat::helper::OverlapTest::requireNoOverlaps_
bool requireNoOverlaps_
Definition: OverlapTest.h:43
edm::ConsumesCollector::consumes
EDGetTokenT< ProductType > consumes(edm::InputTag const &tag)
Definition: ConsumesCollector.h:49
pat::helper::OverlapTest::name_
std::string name_
Definition: OverlapTest.h:42
edm::View
Definition: CaloClusterFwd.h:14
pat::helper::OverlapTest::name
const std::string & name() const
Definition: OverlapTest.h:37
pat::helper::OverlapTest::srcToken_
edm::EDGetTokenT< reco::CandidateView > srcToken_
Definition: OverlapTest.h:41
edm::ParameterSet::getParameter
T getParameter(std::string const &) const
edm::InputTag
Definition: InputTag.h:15