SortModuleTimes.EntryDataClass Class Reference

Inheritance diagram for SortModuleTimes.EntryDataClass:

Public Member Functions
def	__init__ (self, eventKey, kargs)
def	__getattr__ (self, attrName)
def	time (self)
def	isModule (self)
def	isEvent (self)
def	isMissing (self)
def	SetMissing (self)
def	__str__ (self)

Public Attributes
	data
	eventKey

Detailed Description

A flexible data structure for per-event information.

The object is associated to a specific, unique event.
It can represent either the execution of the full event, or of a specific
module on that event.
The object gathers custom data; the standard data members:
- time (default: None): seconds elapsed by the event
- module (default: not defined): the module identification
If time is None, we assume this event was never completed.
The presence of a module data member implies that this object descrivbes a
module execution rather than the whole event.

Definition at line 142 of file SortModuleTimes.py.

Constructor & Destructor Documentation

def SortModuleTimes.EntryDataClass.__init__	(		self,
			eventKey,
			kargs
	)

Definition at line 155 of file SortModuleTimes.py.

        def __init__(self, eventKey, **kargs):
                self.data = kargs
                self.data.setdefault('time', None)
                self.eventKey = eventKey

Member Function Documentation

def SortModuleTimes.EntryDataClass.__getattr__	(		self,
			attrName
	)

Definition at line 161 of file SortModuleTimes.py.

        def __getattr__(self, attrName):
                # we expect this will be called only if no attrName already exists
                try: return self.data[attrName]
                except KeyError: raise AttributeError(attrName)

def SortModuleTimes.EntryDataClass.__str__

(

self

)

Definition at line 183 of file SortModuleTimes.py.

        def __str__(self):
                s = str(self.eventKey)
                if self.isModule(): s += " module " + str(self.module)
                else:               s += " event"
                s += ": ";
                if self.time() is None: s += "(n/a)"
                else: s += "%g s" % self.time()
                return s

def SortModuleTimes.EntryDataClass.isEvent

(

self

)

Definition at line 177 of file SortModuleTimes.py.

        def isEvent(self): return not self.isModule()

def SortModuleTimes.EntryDataClass.isMissing

(

self

)

Definition at line 179 of file SortModuleTimes.py.

        def isMissing(self): return self.time() is None

def SortModuleTimes.EntryDataClass.isModule

(

self

)

Definition at line 172 of file SortModuleTimes.py.

        def isModule(self):
                try: return bool(self.module)
                except AttributeError: return False

def SortModuleTimes.EntryDataClass.SetMissing

(

self

)

Definition at line 181 of file SortModuleTimes.py.

        def SetMissing(self): self.data['time'] = None

def SortModuleTimes.EntryDataClass.time

(

self

)

Definition at line 167 of file SortModuleTimes.py.

        def time(self):
                try: return self.data['time']
                except KeyError: return None

Member Data Documentation

SortModuleTimes.EntryDataClass.data

Definition at line 156 of file SortModuleTimes.py.

SortModuleTimes.EntryDataClass.eventKey

Definition at line 158 of file SortModuleTimes.py.

---

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

• larutils/scripts/SortModuleTimes.py