art::Prescaler Class Reference

Inheritance diagram for art::Prescaler:

Classes
struct	Config

Public Types
using	Parameters = Table< Config >
Public Types inherited from art::SharedFilter
using	ModuleType = SharedFilter
using	WorkerType = WorkerT< SharedFilter >
Public Types inherited from art::detail::Filter
template<typename UserConfig >
using	Table = Modifier::Table< UserConfig >
Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
	Prescaler (Parameters const &, ProcessingFrame const &)
Public Member Functions inherited from art::SharedFilter
	SharedFilter (fhicl::ParameterSet const &pset)
template<typename Config >
	SharedFilter (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Filter
virtual	~Filter () noexcept
	Filter (fhicl::ParameterSet const &)
	Filter (Filter const &)=delete
	Filter (Filter &&)=delete
Filter &	operator= (Filter const &)=delete
Filter &	operator= (Filter &&)=delete
void	doBeginJob (SharedResources const &resources)
void	doEndJob ()
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenOutputFiles (FileBlock const &fb)
void	doRespondToCloseOutputFiles (FileBlock const &fb)
bool	doBeginRun (RunPrincipal &rp, ModuleContext const &)
bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
Public Member Functions inherited from art::Modifier
	~Modifier () noexcept
	Modifier ()
	Modifier (Modifier const &)=delete
	Modifier (Modifier &&)=delete
Modifier &	operator= (Modifier const &)=delete
Modifier &	operator= (Modifier &&)=delete
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)
Public Member Functions inherited from art::detail::SharedModule
	SharedModule ()
	SharedModule (std::string const &moduleLabel)
hep::concurrency::SerialTaskQueueChain *	serialTaskQueueChain () const
std::set< std::string > const &	sharedResources () const
void	createQueues (SharedResources const &resources)
template<BranchType , typename... T>
void	serialize (T const &...resources)
template<BranchType , typename... T>
void	serializeExternal (T const &...resources)

Private Member Functions
bool	filter (Event &, ProcessingFrame const &) override

Private Attributes
size_t	count_ {}
size_t const	n_
size_t const	offset_
std::mutex	mutex_ {}

Additional Inherited Members
Static Public Attributes inherited from art::detail::Filter
static constexpr bool	Pass {true}
static constexpr bool	Fail {false}
Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()
Protected Member Functions inherited from art::detail::SharedModule
template<BranchType BT = InEvent, typename... T>
void	serialize (T const &...)
template<BranchType BT = InEvent, typename... T>
void	serializeExternal (T const &...)
template<BranchType BT = InEvent>
void	async ()

Detailed Description

Definition at line 22 of file Prescaler_module.cc.

Member Typedef Documentation

using art::Prescaler::Parameters = Table<Config>

Definition at line 29 of file Prescaler_module.cc.

Constructor & Destructor Documentation

Prescaler::Prescaler ( Parameters const &  config, ProcessingFrame const &    )

explicit

Definition at line 47 of file Prescaler_module.cc.

  : SharedFilter{config}
  , n_{config().prescaleFactor()}
  , offset_{config().prescaleOffset()}
{
  async<InEvent>();
}

Member Function Documentation

bool Prescaler::filter ( Event &  , ProcessingFrame const &    )

overrideprivatevirtual

Implements art::SharedFilter.

Definition at line 56 of file Prescaler_module.cc.

{
  // The combination of incrementing, modulo dividing, and equality
  // comparing must be synchronized.  Changing count_ to the type
  // std::atomic<size_t> would not help since the entire combination
  // of operations must be atomic.  Using a mutex here is cheaper than
  // calling serialize(), since that will also serialize any of the
  // module-level service callbacks invoked before and after this
  // function is called.
  std::lock_guard lock{mutex_};
  ++count_;
  return count_ % n_ == offset_;
}

Member Data Documentation

size_t art::Prescaler::count_ {}

private

Definition at line 35 of file Prescaler_module.cc.

std::mutex art::Prescaler::mutex_ {}

private

Definition at line 41 of file Prescaler_module.cc.

size_t const art::Prescaler::n_

private

Definition at line 37 of file Prescaler_module.cc.

size_t const art::Prescaler::offset_

private

Definition at line 40 of file Prescaler_module.cc.

---

The documentation for this class was generated from the following file:

• art/art/Framework/Modules/Prescaler_module.cc