allpix::Event

Holds the data required for running an event.

#include <Event.hpp>

Public Functions

	Name
	Event(Event && ) =delete Disallow move because of mutexes and atomics.
Event &	operator=(Event && ) =delete Disallow move because of mutexes and atomics.
	Event(Messenger & messenger, uint64_t event_num, uint64_t seed) Construct an Event.
	~Event() =default Use default destructor.
RandomNumberGenerator &	getRandomEngine() Access the random engine of this event.
uint64_t	getRandomNumber() Advances the random engine’s state by one step.
uint64_t	getSeed() const Returns the current seed for the ranom number generator.

	Name
const uint64_t	number Unique identifier of this event.

Event(
    Event && 
) =delete

Disallow move because of mutexes and atomics.

Event & operator=(
    Event && 
) =delete

Disallow move because of mutexes and atomics.

explicit Event(
    Messenger & messenger,
    uint64_t event_num,
    uint64_t seed
)

Construct an Event.

Parameters:

messenger Messenger responsible for handling message transmission for this event
event_num The unique event identifier
seed Random generator seed for this event

~Event() =default

Use default destructor.

RandomNumberGenerator & getRandomEngine()

Access the random engine of this event.

Return: Reference to this event’s random engine

inline uint64_t getRandomNumber()

Advances the random engine’s state by one step.

Return: The generated value

inline uint64_t getSeed() const

Returns the current seed for the ranom number generator.

Return: The random seed of the current event

const uint64_t number;

Unique identifier of this event.

friend class ModuleManager(
    ModuleManager 
);

friend class Messenger(
    Messenger 
);

friend class SequentialModule(
    SequentialModule 
);

Updated on 2024-12-13 at 08:31:36 +0000