python.sugar.runlumi.RunLumiType Class Reference

Inheritance diagram for python.sugar.runlumi.RunLumiType:

Collaboration diagram for python.sugar.runlumi.RunLumiType:

Public Member Functions
def	make (cls, *args)
def	__repr__ (self)
def	__str__ (self)
def	__add__ (self, what)
def	__sub__ (self, what)
def	start_nextrun (self)
def	run (self)
def	lumi (self)

Static Public Attributes
bool	is_time = False

Static Private Attributes
tuple	__slots__ = ()

Detailed Description

Syntactic sugar for an IoV key.

This class intentionally has no constructor so that we can benefit from the
speed of the builtin long constructor. (Since we use it a lot!)

On the python side though, it is useful to have a constructor which takes 
(Run, Lumiblock). This is provided by the make() class method, which is
aliased as RunLumi.

Definition at line 18 of file runlumi.py.

Member Function Documentation

__add__()

def python.sugar.runlumi.RunLumiType.__add__	(		self,
			what
	)

How to add something to an LB: in case of a numeric type, do the normal
thing. In case of a tuple, use the first element as a run number count
and the second element as a luminosity block count.

Definition at line 61 of file runlumi.py.

    def __add__(self, what):
        """ 
        How to add something to an LB: in case of a numeric type, do the normal
        thing. In case of a tuple, use the first element as a run number count
        and the second element as a luminosity block count.
        """
        if isinstance(what, tuple):
            nrun, nlumi = what
            return RunLumiType((self.run + nrun << 32) + (self.lumi + nlumi))
            
        return RunLumiType(int.__add__(self, what))
    

__repr__()

def python.sugar.runlumi.RunLumiType.__repr__

(

self

)

Pretty representation for an IoV key

Definition at line 49 of file runlumi.py.

    def __repr__(self):
        """
        Pretty representation for an IoV key
        """
        run, lumi = self.run, self.lumi
        if run == RUN_MAX: run = "[MAX]"
        if lumi == LB_MAX: lumi = "[MAX]"
        return "%5s:%5s" % (run, lumi)
    

__str__()

def python.sugar.runlumi.RunLumiType.__str__

(

self

)

Definition at line 58 of file runlumi.py.

    def __str__(self):
        return self.__repr__()
    

__sub__()

def python.sugar.runlumi.RunLumiType.__sub__	(		self,
			what
	)

Definition at line 73 of file runlumi.py.

    def __sub__(self, what):
        return RunLumiType(int.__sub__(self, what))
    

lumi()

def python.sugar.runlumi.RunLumiType.lumi

(

self

)

Definition at line 87 of file runlumi.py.

    def lumi(self):
        return self & 0xFFFFFFFF
 

make()

def python.sugar.runlumi.RunLumiType.make	(		cls,
		*	args
	)

Create a RunLumiType in a smarter (but slower) way, depending on whether 
one or two args are passed.

Definition at line 34 of file runlumi.py.

    def make(cls, *args):
        """
        Create a RunLumiType in a smarter (but slower) way, depending on whether 
        one or two args are passed.
        """
        if len(args) == 1:
            if isinstance(args[0], tuple):
                run, lumi = args[0]
                return cls(run << 32 | lumi)
            return cls(args[0])
        elif len(args) == 2:
            run, lumi = args
            return cls(run << 32 | lumi)
        raise RuntimeError("Invalid argument to RunLumiType.make")
    

run()

def python.sugar.runlumi.RunLumiType.run

(

self

)

Definition at line 83 of file runlumi.py.

    def run(self):
        return self >> 32
        

start_nextrun()

def python.sugar.runlumi.RunLumiType.start_nextrun

(

self

)

Return a new RunLumiType with run number += 1 and lumi = 1

Definition at line 76 of file runlumi.py.

    def start_nextrun(self):
        """
        Return a new RunLumiType with run number += 1 and lumi = 1
        """
        return self + (1, -self.lumi) + (0, 1)
    

Member Data Documentation

__slots__

tuple python.sugar.runlumi.RunLumiType.__slots__ = ()

staticprivate

Definition at line 29 of file runlumi.py.

is_time

bool python.sugar.runlumi.RunLumiType.is_time = False

static

Definition at line 31 of file runlumi.py.

---

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

• runlumi.py