GenericMonitoringTool.GenericMonitoringTool Class Reference

Inheritance diagram for GenericMonitoringTool.GenericMonitoringTool:

Collaboration diagram for GenericMonitoringTool.GenericMonitoringTool:

Public Member Functions
def	__init__ (self, flags, name='GenericMonitoringTool', **kwargs)
def	convention (self)
def	convention (self, value)
def	defaultDuration (self)
def	defaultDuration (self, value)
def	defineHistogram (self, *args, **kwargs)
def	defineTree (self, *args, **kwargs)

Private Member Functions
def	_coreDefine (self, deffunc, *args, **kwargs)

Private Attributes
	_configFlags
	_convention
	_defaultDuration

Static Private Attributes
tuple	__slots__ = ('_configFlags', '_convention', '_defaultDuration')

Detailed Description

GenericMonitoringTool configurable class

Definition at line 12 of file GenericMonitoringTool.py.

Constructor & Destructor Documentation

__init__()

def GenericMonitoringTool.GenericMonitoringTool.__init__	(		self,
			flags,
			name = 'GenericMonitoringTool',
		**	kwargs
	)

Definition at line 17 of file GenericMonitoringTool.py.

    def __init__(self, flags, name='GenericMonitoringTool', **kwargs):
        self._configFlags = flags
        self._convention = ''
        self._defaultDuration = kwargs.pop('defaultDuration', None)
        super().__init__(name, **kwargs)
 

Member Function Documentation

_coreDefine()

def GenericMonitoringTool.GenericMonitoringTool._coreDefine (   self,   deffunc, *  args, **  kwargs  )

private

Definition at line 39 of file GenericMonitoringTool.py.

    def _coreDefine(self, deffunc, *args, **kwargs):
        if 'convention' in kwargs:
            # only if someone really knows what they're doing
            pass
        else:
            duration = kwargs.pop('duration', self.defaultDuration)
            if duration is not None:
                kwargs['convention'] = self.convention + ':' + duration
        # if an overall path for tool is specified, can leave path argument empty
        if getattr(self, 'HistPath', '') != '':
            kwargs.setdefault('path', '')
        toadd = deffunc(self._configFlags, *args, **kwargs)
        if toadd:
            self.Histograms.append(toadd)
 

convention() [1/2]

def GenericMonitoringTool.GenericMonitoringTool.convention

(

self

)

Definition at line 24 of file GenericMonitoringTool.py.

    def convention(self):
        return self._convention
 

convention() [2/2]

def GenericMonitoringTool.GenericMonitoringTool.convention	(		self,
			value
	)

Definition at line 28 of file GenericMonitoringTool.py.

    def convention(self, value):
        self._convention = value
 

defaultDuration() [1/2]

def GenericMonitoringTool.GenericMonitoringTool.defaultDuration

(

self

)

Definition at line 32 of file GenericMonitoringTool.py.

    def defaultDuration(self):
        return self._defaultDuration
 

defaultDuration() [2/2]

def GenericMonitoringTool.GenericMonitoringTool.defaultDuration	(		self,
			value
	)

Definition at line 36 of file GenericMonitoringTool.py.

    def defaultDuration(self, value):
        self._defaultDuration = value
 

defineHistogram()

def GenericMonitoringTool.GenericMonitoringTool.defineHistogram	(		self,
		*	args,
		**	kwargs
	)

Definition at line 54 of file GenericMonitoringTool.py.

    def defineHistogram(self, *args, **kwargs):
        self._coreDefine(defineHistogram, *args, **kwargs)
 

defineTree()

def GenericMonitoringTool.GenericMonitoringTool.defineTree	(		self,
		*	args,
		**	kwargs
	)

Definition at line 57 of file GenericMonitoringTool.py.

    def defineTree(self, *args, **kwargs):
        self._coreDefine(defineTree, *args, **kwargs)
 
 

Member Data Documentation

__slots__

tuple GenericMonitoringTool.GenericMonitoringTool.__slots__ = ('_configFlags', '_convention', '_defaultDuration')

staticprivate

Definition at line 15 of file GenericMonitoringTool.py.

_configFlags

GenericMonitoringTool.GenericMonitoringTool._configFlags

private

Definition at line 18 of file GenericMonitoringTool.py.

_convention

GenericMonitoringTool.GenericMonitoringTool._convention

private

Definition at line 19 of file GenericMonitoringTool.py.

_defaultDuration

GenericMonitoringTool.GenericMonitoringTool._defaultDuration

private

Definition at line 20 of file GenericMonitoringTool.py.

---

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

• GenericMonitoringTool.py