EventCountLimiter Class Reference

Inheritance diagram for EventCountLimiter:

Collaboration diagram for EventCountLimiter:

Public Member Functions
def	__init__ (self, maxCount)
def	initialize (self)
def	terminate (self)
def	beginRun (self)
def	endRun (self)
def	event (self)

Public Attributes
	maxCount
	internal copy of the event-counter upper limit
	eventCounter
	internal event counter

Detailed Description

Report when the event counter has reached or exceeded its limit

Definition at line 23 of file EventCountLimiter.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			maxCount
	)

Constructor

Argument:
    maxCount (int): number of events to be processed

Definition at line 26 of file EventCountLimiter.py.

    def __init__(self, maxCount):
        """Constructor
 
        Argument:
            maxCount (int): number of events to be processed
        """
        super().__init__()
        
        self.maxCount = maxCount if (maxCount >= 0) else (1 << 31)
        
        self.eventCounter = 0
 

Member Function Documentation

beginRun()

def beginRun

(

self

)

Handle begin of run (nothing to do here)

Definition at line 44 of file EventCountLimiter.py.

    def beginRun(self):
        """Handle begin of run (nothing to do here)"""
 

endRun()

def endRun

(

self

)

Handle end of run (nothing to do here)

Definition at line 47 of file EventCountLimiter.py.

    def endRun(self):
        """Handle end of run (nothing to do here)"""
 

event()

def event

(

self

)

Process one event: has eventCounter reached or exceeded its limit?

Definition at line 50 of file EventCountLimiter.py.

    def event(self):
        """Process one event: has eventCounter reached or exceeded its limit?"""
        self.eventCounter += 1
        super().return_value(self.eventCounter < self.maxCount)

initialize()

def initialize

(

self

)

Handle job initialization (nothing to do here)

Definition at line 38 of file EventCountLimiter.py.

    def initialize(self):
        """Handle job initialization (nothing to do here)"""
 

terminate()

def terminate

(

self

)

Handle job termination (nothing to do here)

Definition at line 41 of file EventCountLimiter.py.

    def terminate(self):
        """Handle job termination (nothing to do here)"""
 

Member Data Documentation

eventCounter

eventCounter

internal event counter

Definition at line 36 of file EventCountLimiter.py.

maxCount

maxCount

internal copy of the event-counter upper limit

Definition at line 34 of file EventCountLimiter.py.

---

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

• klm/bklm/scripts/EventCountLimiter.py