edm::Prescaler Class Reference

Inheritance diagram for edm::Prescaler:

Public Member Functions
virtual bool	filter (StreamID, Event &e, EventSetup const &c) const overridefinal
	Prescaler (ParameterSet const &)
virtual	~Prescaler ()
Public Member Functions inherited from edm::global::EDFilter<>
	EDFilter ()=default
Public Member Functions inherited from edm::global::EDFilterBase
	EDFilterBase ()
ModuleDescription const &	moduleDescription () const
virtual	~EDFilterBase ()
Public Member Functions inherited from edm::ProducerBase
	ProducerBase ()
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
virtual	~ProducerBase ()
Public Member Functions inherited from edm::EDConsumerBase
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Static Public Member Functions
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
Static Public Member Functions inherited from edm::global::EDFilterBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Attributes
std::atomic< int >	count_
int	n_
int	offset_

Additional Inherited Members
Public Types inherited from edm::global::EDFilterBase
typedef EDFilterBase	ModuleType
Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Protected Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
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 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

Definition at line 10 of file Prescaler.cc.

Constructor & Destructor Documentation

edm::Prescaler::Prescaler ( ParameterSet const &  ps )

explicit

Definition at line 24 of file Prescaler.cc.

                                             :
    count_(),
    n_(ps.getParameter<int>("prescaleFactor")),
    offset_(ps.getParameter<int>("prescaleOffset")) {
  }

edm::Prescaler::~Prescaler ( )

virtual

Definition at line 30 of file Prescaler.cc.

                        {
  }

Member Function Documentation

void edm::Prescaler::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 40 of file Prescaler.cc.

References edm::ConfigurationDescriptions::add(), and edm::ParameterSetDescription::add().

                                                                     {
    ParameterSetDescription desc;
    desc.add<int>("prescaleFactor")->setComment("Accept one event every N events");
    desc.add<int>("prescaleOffset")->setComment("The first event to accept should be the Mth one. Choose 'prescaleFactor'=1 to accept the first event from the source.");
    descriptions.add("preScaler", desc);
  }

bool edm::Prescaler::filter ( StreamID  , Event &  e, EventSetup const &  c  ) const

finaloverridevirtual

Implements edm::global::EDFilterBase.

Definition at line 33 of file Prescaler.cc.

References prof2calltree::count, count_, n_, and offset_.

                                                                  {
    //have to capture the value here since it could change by the time we do the comparision
    int count = ++count_;
    return count % n_ == offset_ ? true : false;
  }

Member Data Documentation

std::atomic<int> edm::Prescaler::count_

mutableprivate

Definition at line 19 of file Prescaler.cc.

Referenced by filter().

int edm::Prescaler::n_

private

Definition at line 20 of file Prescaler.cc.

Referenced by filter().

int edm::Prescaler::offset_

private

Definition at line 21 of file Prescaler.cc.

Referenced by filter().