python.MultipleStreamManager.AugmentedStreamBase Class Reference

Inheritance diagram for python.MultipleStreamManager.AugmentedStreamBase:

Collaboration diagram for python.MultipleStreamManager.AugmentedStreamBase:

Public Member Functions
def	__init__ (self, StreamName)
def	AddAcceptAlgs (self, algs)
	Accept Algs. More...
def	RemoveAcceptAlgs (self, algs)
def	GetAcceptAlgs (self)
def	AddRequireAlgs (self, algs)
	Require Algs. More...
def	RemoveRequireAlgs (self, algs)
def	GetRequireAlgs (self)
def	AddVetoAlgs (self, algs)
	Veto Algs (ignored by prescaler for now) More...
def	RemoveVetoAlgs (self, algs)
def	GetVetoAlgs (self)
def	AddOtherAlgsToBookkeep (self, algs)
	Other Algs (e.g. More...
def	RemoveOtherAlgsToBookkeep (self, algs)
def	GetOtherAlgsToBookkeep (self)
def	GetSkimDecisionsWriter (self)
	Skim decisions writer. More...
def	SetPrescale (self, value)
	Master prescale. More...
def	GetPrescale (self)

Public Attributes
	Name
	OtherAlgs

Private Member Functions
def	_ItemInList (self, item, aList)
def	_AddValidItemToList (self, item, aList)
def	_RemoveValidItemFromList (self, item, aList)

Private Attributes
	_Prescaler

Detailed Description

This class manages common methods of AugmentedPoolStream and AugmentedByteStream.

Definition at line 11 of file MultipleStreamManager.py.

Constructor & Destructor Documentation

__init__()

def python.MultipleStreamManager.AugmentedStreamBase.__init__	(		self,
			StreamName
	)

Definition at line 13 of file MultipleStreamManager.py.

    def  __init__(self, StreamName):
        self.Name = StreamName
        self.OtherAlgs=[]
        #the following attributes must exist in all child classes:
        #self.Stream
        #self.Print()
        #self.SetOutputFileName()
        #self.Add/Remove(MetaData)Item()
        return
 

Member Function Documentation

_AddValidItemToList()

def python.MultipleStreamManager.AugmentedStreamBase._AddValidItemToList (   self,   item,   aList  )

private

Definition at line 35 of file MultipleStreamManager.py.

    def _AddValidItemToList(self,item,aList):
        #Recursive loop if item is a list
        if isinstance(item,list):
            for i in item:
                self._AddValidItemToList(i,aList)
        #Add to list if item is a string and not already in the list
        elif isinstance(item, str):
            if not self._ItemInList(item,aList):
                aList += [item]
        else:
            raise TypeError("AugmentedPoolStream._AddValidItemToList() does not support item of type %s"%type(item))
        return
 

_ItemInList()

def python.MultipleStreamManager.AugmentedStreamBase._ItemInList (   self,   item,   aList  )

private

Definition at line 24 of file MultipleStreamManager.py.

    def _ItemInList(self,item,aList):
        #Make sure aList is a list
        if not isinstance(aList, list):
            raise TypeError("AugmentedPoolStream._ItemInList() does not support aList of type %s"%type(aList))
 
        isInList=False
        for i in aList:
            if i==item:
                isInList=True
        return isInList
 

_RemoveValidItemFromList()

def python.MultipleStreamManager.AugmentedStreamBase._RemoveValidItemFromList (   self,   item,   aList  )

private

Definition at line 48 of file MultipleStreamManager.py.

    def _RemoveValidItemFromList(self,item,aList):
        #Recursive loop if item is a list
        if isinstance(item,list):
            for i in item:
                self._RemoveValidItemFromList(i,aList)
        #Remove from list if item is a string and already in list
        elif isinstance(item, str):
            if self._ItemInList(item,aList):
                aList.remove(item)
            else:
                print(self.Name,": WARNING you asked to remove item '%s' but this item is not present",item)
        else:
            raise TypeError("AugmentedPoolStream._RemoveValidItemFromList() does not support item of type %s"%type(item))
        return
 

AddAcceptAlgs()

def python.MultipleStreamManager.AugmentedStreamBase.AddAcceptAlgs	(		self,
			algs
	)

Accept Algs.

Definition at line 65 of file MultipleStreamManager.py.

    def AddAcceptAlgs(self, algs):
        self._AddValidItemToList(algs, self.Stream.AcceptAlgs)
        return
 

AddOtherAlgsToBookkeep()

def python.MultipleStreamManager.AugmentedStreamBase.AddOtherAlgsToBookkeep	(		self,
			algs
	)

Other Algs (e.g.

those used by a FilterCombiner, but ignored by everybody else)

Definition at line 104 of file MultipleStreamManager.py.

    def AddOtherAlgsToBookkeep(self, algs):
        self._AddValidItemToList(algs, self.OtherAlgs)
        return
 

AddRequireAlgs()

def python.MultipleStreamManager.AugmentedStreamBase.AddRequireAlgs	(		self,
			algs
	)

Require Algs.

Definition at line 78 of file MultipleStreamManager.py.

    def AddRequireAlgs(self, algs):
        self._AddValidItemToList(algs, self.Stream.RequireAlgs)
        return
 

AddVetoAlgs()

def python.MultipleStreamManager.AugmentedStreamBase.AddVetoAlgs	(		self,
			algs
	)

Veto Algs (ignored by prescaler for now)

Definition at line 91 of file MultipleStreamManager.py.

    def AddVetoAlgs(self, algs):
        self._AddValidItemToList(algs, self.Stream.VetoAlgs)
        return
 

GetAcceptAlgs()

def python.MultipleStreamManager.AugmentedStreamBase.GetAcceptAlgs

(

self

)

Definition at line 73 of file MultipleStreamManager.py.

    def GetAcceptAlgs(self):
        return self.Stream.AcceptAlgs
 

GetOtherAlgsToBookkeep()

def python.MultipleStreamManager.AugmentedStreamBase.GetOtherAlgsToBookkeep

(

self

)

Definition at line 112 of file MultipleStreamManager.py.

    def GetOtherAlgsToBookkeep(self):
        return self.OtherAlgs
 

GetPrescale()

def python.MultipleStreamManager.AugmentedStreamBase.GetPrescale

(

self

)

Definition at line 156 of file MultipleStreamManager.py.

    def GetPrescale(self):
        if hasattr(self,"_Prescaler"):
            return self._Prescaler.Prescale
        else:
            return "NONE"
 
 
 

GetRequireAlgs()

def python.MultipleStreamManager.AugmentedStreamBase.GetRequireAlgs

(

self

)

Definition at line 86 of file MultipleStreamManager.py.

    def GetRequireAlgs(self):
        return self.Stream.RequireAlgs
 

GetSkimDecisionsWriter()

def python.MultipleStreamManager.AugmentedStreamBase.GetSkimDecisionsWriter

(

self

)

Skim decisions writer.

Definition at line 117 of file MultipleStreamManager.py.

    def GetSkimDecisionsWriter(self):
        from EventBookkeeperTools.BookkeepingInfoWriter import SkimDecisionsWriter
        sdw=SkimDecisionsWriter(self.Name+"_SkimDecisionsWriter")
        newContainerName=self.Name+"_"+sdw.SkimDecisionsContainerName
        sdw.SkimDecisionsContainerName=newContainerName
        #sdw.OutputLevel=2
        for a in self.GetRequireAlgs():
            sdw.addRequireAlg(a)
        for a in self.GetAcceptAlgs():
            sdw.addAcceptAlg(a)
        for a in self.GetVetoAlgs():
            sdw.addVetoAlg(a)
        for a in self.GetOtherAlgsToBookkeep():
            sdw.addOtherAlg(a)
        return sdw
 

GetVetoAlgs()

def python.MultipleStreamManager.AugmentedStreamBase.GetVetoAlgs

(

self

)

Definition at line 99 of file MultipleStreamManager.py.

    def GetVetoAlgs(self):
        return self.Stream.VetoAlgs
 

RemoveAcceptAlgs()

def python.MultipleStreamManager.AugmentedStreamBase.RemoveAcceptAlgs	(		self,
			algs
	)

Definition at line 69 of file MultipleStreamManager.py.

    def RemoveAcceptAlgs(self, algs):
        self._RemoveValidItemFromList(algs, self.Stream.AcceptAlgs)
        return
 

RemoveOtherAlgsToBookkeep()

def python.MultipleStreamManager.AugmentedStreamBase.RemoveOtherAlgsToBookkeep	(		self,
			algs
	)

Definition at line 108 of file MultipleStreamManager.py.

    def RemoveOtherAlgsToBookkeep(self, algs):
        self._RemoveValidItemFromList(algs, self.OtherAlgs)
        return
 

RemoveRequireAlgs()

def python.MultipleStreamManager.AugmentedStreamBase.RemoveRequireAlgs	(		self,
			algs
	)

Definition at line 82 of file MultipleStreamManager.py.

    def RemoveRequireAlgs(self, algs):
        self._RemoveValidItemFromList(algs, self.Stream.RequireAlgs)
        return
 

RemoveVetoAlgs()

def python.MultipleStreamManager.AugmentedStreamBase.RemoveVetoAlgs	(		self,
			algs
	)

Definition at line 95 of file MultipleStreamManager.py.

    def RemoveVetoAlgs(self, algs):
        self._RemoveValidItemFromList(algs, self.Stream.VetoAlgs)
        return
 

SetPrescale()

def python.MultipleStreamManager.AugmentedStreamBase.SetPrescale	(		self,
			value
	)

Master prescale.

Definition at line 135 of file MultipleStreamManager.py.

    def SetPrescale(self,value):
        #Set a master prescale to given value. Create the Prescaler tool if necessary.
        if not hasattr(self,"_Prescaler"):
            from PrimaryDPDMaker.PrimaryDPDMakerConf import PrimaryDPDPrescaler
            prescalerName="MasterPrescale_"+self.Name
            self._Prescaler = PrimaryDPDPrescaler(prescalerName)
            #Deep copies of the Require and Accept algs lists considered by the Master prescaler
            #Notes:
            # 1) deep copy is necessary because the Master prescaler itself will be added to the RequireAlgs list\
            # 2) this implies that SetPrescale must be the *last* algorithm added to the stream
            self._Prescaler.RequireAlgs = self.Stream.RequireAlgs[:]
            self._Prescaler.AcceptAlgs = self.Stream.AcceptAlgs[:]
 
            from AthenaCommon.AlgSequence import AlgSequence
            topSequence = AlgSequence()
            topSequence += self._Prescaler
            self.AddRequireAlgs(prescalerName)
 
        self._Prescaler.Prescale=value
        return
 

Member Data Documentation

_Prescaler

python.MultipleStreamManager.AugmentedStreamBase._Prescaler

private

Definition at line 140 of file MultipleStreamManager.py.

Name

python.MultipleStreamManager.AugmentedStreamBase.Name

Definition at line 14 of file MultipleStreamManager.py.

OtherAlgs

python.MultipleStreamManager.AugmentedStreamBase.OtherAlgs

Definition at line 15 of file MultipleStreamManager.py.

---

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

• MultipleStreamManager.py