Counter< T > Class Template Reference

A module counting the number of entries in a vector. More...

Detailed Description

template<typename T>
class Counter< T >

A module counting the number of entries in a vector.

Definition at line 32 of file Counter.cc.

Inheritance diagram for Counter< T >:

Public Member Functions

 Counter (PoolPtr pool, const ParameterSet &parameters)
 
virtual void beginIntegration () override
 Called once at the beginning of the integration.
 
virtual void beginLoop () override
 Called once at the beginning of a loop. More...
 
virtual Status work () override
 Main function. More...
 
- Public Member Functions inherited from Module
 Module (PoolPtr pool, const std::string &name)
 Constructor. More...
 
virtual void configure ()
 Called once at the beginning of the job.
 
virtual void beginPoint ()
 Called once when a new PS point is started. More...
 
virtual void endLoop ()
 Called once at the end of a loop. More...
 
virtual void endPoint ()
 Called once when a PS point is finished. More...
 
virtual void endIntegration ()
 Called once at the end of the integration.
 
virtual void finish ()
 Called once at the end of the job.
 
virtual std::string name () const final
 

Additional Inherited Members

- Public Types inherited from Module
enum  Status : std::int8_t { OK, NEXT, ABORT }
 
- Static Public Member Functions inherited from Module
static std::string statusToString (const Status &status)
 
static bool is_virtual_module (const std::string &name)
 Test if a given name correspond to a virtual module. More...
 
- Protected Member Functions inherited from Module
template<typename T , typename... Args>
std::shared_ptr< T > produce (const std::string &name, Args... args)
 Add a new output to the module. More...
 
template<typename T >
Value< T > get (const std::string &module, const std::string &name)
 
template<typename T >
Value< T > get (const InputTag &tag)
 
- Protected Attributes inherited from Module
PoolPtr m_pool
 

Member Function Documentation

◆ beginLoop()

template<typename T >
virtual void Counter< T >::beginLoop ( )
inlineoverridevirtual

Called once at the beginning of a loop.

Only relevant if the module is inside a loop

Reimplemented from Module.

Definition at line 43 of file Counter.cc.

◆ work()

template<typename T >
virtual Status Counter< T >::work ( )
inlineoverridevirtual

Main function.

This method is called for each integration step. The module's logic and work happen here.

You'll usually want to override this function if you want your module to perform some task.

Reimplemented from Module.

Definition at line 47 of file Counter.cc.


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