GaudiPython.Bindings.iDataSvc Class Reference

Inheritance diagram for GaudiPython.Bindings.iDataSvc:

Collaboration diagram for GaudiPython.Bindings.iDataSvc:

Public Member Functions
	__init__ (self, name, idp)
	registerObject (self, path, obj)
	unregisterObject (self, path)
	retrieveObject (self, path)
	findObject (self, path)
	getObject (self, path, *args)
	__getitem__ (self, path)
	__setitem__ (self, path, obj)
	__delitem__ (self, path)
	leaves (self, node=cppyy.nullptr)
	dump (self, node=cppyy.nullptr)
	getList (self, node=cppyy.nullptr, lst=[], rootFID=None)
	getHistoNames (self, node=cppyy.nullptr, lst=[])
	setRoot (self, name, obj)
	selectOnlyStore (self)
	selectStore (self, n)
	clearStore (self)
Public Member Functions inherited from GaudiPython.Bindings.iService
	__init__ (self, name, isvc=cppyy.nullptr)
	retrieveInterface (self)
	initialize (self)
	start (self)
	stop (self)
	finalize (self)
	reinitialize (self)
	restart (self)
	isValid (self)
Public Member Functions inherited from GaudiPython.Bindings.iProperty
	__init__ (self, name, ip=cppyy.nullptr)
	getInterface (self)
	__call_interface_method__ (self, ifname, method, *args)
	__setattr__ (self, name, value)
	__getattr__ (self, name)
	properties (self)
	name (self)

Protected Attributes
	_idp
	_idm
	_ihwb
Protected Attributes inherited from GaudiPython.Bindings.iService
	_isvc
Protected Attributes inherited from GaudiPython.Bindings.iProperty
	_ip
	_svcloc
	_name

Detailed Description

Definition at line 516 of file Bindings.py.

Constructor & Destructor Documentation

__init__()

GaudiPython.Bindings.iDataSvc.__init__	(		self,
			name,
			idp )

Definition at line 517 of file Bindings.py.

    def __init__(self, name, idp):
        iService.__init__(self, name, idp)
        self.__dict__["_idp"] = InterfaceCast(gbl.IDataProviderSvc)(idp)
        self.__dict__["_idm"] = InterfaceCast(gbl.IDataManagerSvc)(idp)
        # do not use InterfaceCast as it prints an error on failure
        self.__dict__["_ihwb"] = None
        ip = makeNullPointer(gbl.IHiveWhiteBoard)
        if idp.queryInterface(gbl.IHiveWhiteBoard.interfaceID(), ip).isSuccess():
            self.__dict__["_ihwb"] = ip
 

Member Function Documentation

__delitem__()

GaudiPython.Bindings.iDataSvc.__delitem__	(		self,
			path )

Definition at line 611 of file Bindings.py.

    def __delitem__(self, path):
        if not self._idp:
            raise IndexError(
                "C++ service {} does not exist".format(self.__dict__["_name"])
            )
        return self.unregisterObject(path)
 

__getitem__()

GaudiPython.Bindings.iDataSvc.__getitem__	(		self,
			path )

Definition at line 597 of file Bindings.py.

    def __getitem__(self, path):
        if not self._idp:
            raise IndexError(
                "C++ service {} does not exist".format(self.__dict__["_name"])
            )
        return Helper.dataobject(self._idp, path)
 

__setitem__()

GaudiPython.Bindings.iDataSvc.__setitem__	(		self,
			path,
			obj )

Definition at line 604 of file Bindings.py.

    def __setitem__(self, path, obj):
        if not self._idp:
            raise IndexError(
                "C++ service {} does not exist".format(self.__dict__["_name"])
            )
        return self.registerObject(path, obj)
 

clearStore()

GaudiPython.Bindings.iDataSvc.clearStore

(

self

)

Definition at line 703 of file Bindings.py.

    def clearStore(self):
        if not self._idm:
            raise IndexError(
                "C++ service {} does not exist".format(self.__dict__["_name"])
            )
        return self._idm.clearStore()
 
 
# ----iHistogramSvc class------------------------------------------------------

dump()

GaudiPython.Bindings.iDataSvc.dump	(		self,
			node = cppyy.nullptr )

Definition at line 627 of file Bindings.py.

    def dump(self, node=cppyy.nullptr):
        if node == cppyy.nullptr:
            root = self.retrieveObject("")
            if root:
                node = root.registry()
            else:
                return
        print(node.identifier())
        if node.object():
            for l in self.leaves(node):
                self.dump(l)
 

findObject()

GaudiPython.Bindings.iDataSvc.findObject	(		self,
			path )

Get the existing object in TransientStore for the given location

- loading of object from persistency is NOT triggered
- 'data-on-demand' action is NOT triggered

>>> svc  =  ...                     ## get the service
>>> path =  ...                     ## get the path in Transient Store
>>> data = svc.findObject ( path )  ## use the method

Definition at line 548 of file Bindings.py.

    def findObject(self, path):
        """
 
        Get the existing object in TransientStore for the given location
 
        - loading of object from persistency is NOT triggered
        - 'data-on-demand' action is NOT triggered
 
        >>> svc  =  ...                     ## get the service
        >>> path =  ...                     ## get the path in Transient Store
        >>> data = svc.findObject ( path )  ## use the method
 
        """
        if not self._idp:
            raise IndexError(
                "C++ service {} does not exist".format(self.__dict__["_name"])
            )
        return Helper.findobject(self._idp, path)
 

getHistoNames()

GaudiPython.Bindings.iDataSvc.getHistoNames	(		self,
			node = cppyy.nullptr,
			lst = [] )

Definition at line 658 of file Bindings.py.

    def getHistoNames(self, node=cppyy.nullptr, lst=[]):
        if node == cppyy.nullptr:
            root = self.retrieveObject("")
            if root:
                node = root.registry()
                # rootFID = node.address().par()
                lst = []
            else:
                return
        Helper.dataobject(self._idp, node.identifier())
        if node.object():
            lst.append(node.identifier())
            for l in self.leaves(node):
                if l.name():  # and l.address().par() == rootFID :
                    self.getHistoNames(l, lst)
                else:
                    continue
        return lst
 

getList()

GaudiPython.Bindings.iDataSvc.getList	(		self,
			node = cppyy.nullptr,
			lst = [],
			rootFID = None )

Definition at line 639 of file Bindings.py.

    def getList(self, node=cppyy.nullptr, lst=[], rootFID=None):
        if node == cppyy.nullptr:
            root = self.retrieveObject("")
            if root:
                node = root.registry()
                rootFID = node.address().par()
                lst = []
            else:
                return
        Helper.dataobject(self._idp, node.identifier())
        if node.object():
            lst.append(node.identifier())
            for l in self.leaves(node):
                if l.address() and l.address().par() == rootFID:
                    self.getList(l, lst, rootFID)
                else:
                    continue
        return lst
 

getObject()

GaudiPython.Bindings.iDataSvc.getObject	(		self,
			path,
		*	args )

Get object from Transient Store  for the given location

arguments :
- path                           : Location of object in Transient Store
- retrieve          (bool) True  : retrieve versus find
- disable on-demand (bool) False : temporary disable 'on-demand' actions

>>> svc  = ...   ## get the service
>>> path = ...   ## get the path

>>> data = svc.getObject ( path , False )  ## find object in Transient Store

## find object in Transient Store
#  load form tape or use 'on-demand' action  for missing objects :
>>> data = svc.getObject ( path , True  )

## find object in Transient Store
#  load from tape or for missing objects, disable 'on-demand'-actions
>>> data = svc.getObject ( path , True  , True )

Definition at line 568 of file Bindings.py.

    def getObject(self, path, *args):
        """
        Get object from Transient Store  for the given location
 
        arguments :
        - path                           : Location of object in Transient Store
        - retrieve          (bool) True  : retrieve versus find
        - disable on-demand (bool) False : temporary disable 'on-demand' actions
 
        >>> svc  = ...   ## get the service
        >>> path = ...   ## get the path
 
        >>> data = svc.getObject ( path , False )  ## find object in Transient Store
 
        ## find object in Transient Store
        #  load form tape or use 'on-demand' action  for missing objects :
        >>> data = svc.getObject ( path , True  )
 
        ## find object in Transient Store
        #  load from tape or for missing objects, disable 'on-demand'-actions
        >>> data = svc.getObject ( path , True  , True )
 
        """
        if not self._idp:
            raise IndexError(
                "C++ service {} does not exist".format(self.__dict__["_name"])
            )
        return Helper.getobject(self._idp, path, *args)
 

leaves()

GaudiPython.Bindings.iDataSvc.leaves	(		self,
			node = cppyy.nullptr )

Definition at line 618 of file Bindings.py.

    def leaves(self, node=cppyy.nullptr):
        if node == cppyy.nullptr:
            node = self.retrieveObject("")
        ll = gbl.std.vector("IRegistry*")()
        if isinstance(node, str):
            _ = self.retrieveObject(node)
        if self._idm.objectLeaves(node, ll).isSuccess():
            return ll
 

registerObject()

GaudiPython.Bindings.iDataSvc.registerObject	(		self,
			path,
			obj )

Definition at line 527 of file Bindings.py.

    def registerObject(self, path, obj):
        if not self._idp:
            raise AttributeError(
                "C++ service {} does not exist".format(self.__dict__["_name"])
            )
        return Helper.registerObject(self._idp, path, obj)
 

retrieveObject()

GaudiPython.Bindings.iDataSvc.retrieveObject	(		self,
			path )

Definition at line 541 of file Bindings.py.

    def retrieveObject(self, path):
        if not self._idp:
            return cppyy.nullptr
        return Helper.dataobject(self._idp, path)
 

selectOnlyStore()

GaudiPython.Bindings.iDataSvc.selectOnlyStore

(

self

)

Definition at line 684 of file Bindings.py.

    def selectOnlyStore(self):
        # nothing to do if GaudiHive is not used
        if not self._ihwb:
            return
        # check we have a single store raise an error if it' not the case
        if self._ihwb.getNumberOfStores() > 1:
            raise IndexError(
                "Several stores available in Gaudihive mode, unable to figure out which one to use.\nPlease call selectStore instead of selectSingleStore\nIf you're only using GaudiPython, make sure you configure a single thread"
            )
        # select the only store
        self.selectStore(0)
 

selectStore()

GaudiPython.Bindings.iDataSvc.selectStore	(		self,
			n )

Definition at line 696 of file Bindings.py.

    def selectStore(self, n):
        if not self._ihwb:
            raise IndexError(
                "C++ service {} does not exist".format(self.__dict__["_name"])
            )
        return self._ihwb.selectStore(n)
 

setRoot()

GaudiPython.Bindings.iDataSvc.setRoot	(		self,
			name,
			obj )

Definition at line 677 of file Bindings.py.

    def setRoot(self, name, obj):
        if not self._idm:
            raise IndexError(
                "C++ service {} does not exist".format(self.__dict__["_name"])
            )
        return self._idm.setRoot(name, obj)
 

unregisterObject()

GaudiPython.Bindings.iDataSvc.unregisterObject	(		self,
			path )

Definition at line 534 of file Bindings.py.

    def unregisterObject(self, path):
        if not self._idp:
            raise AttributeError(
                "C++ service {} does not exist".format(self.__dict__["_name"])
            )
        return Helper.unregisterObject(self._idp, path)
 

Member Data Documentation

_idm

GaudiPython.Bindings.iDataSvc._idm

protected

Definition at line 678 of file Bindings.py.

_idp

GaudiPython.Bindings.iDataSvc._idp

protected

Definition at line 528 of file Bindings.py.

_ihwb

GaudiPython.Bindings.iDataSvc._ihwb

protected

Definition at line 686 of file Bindings.py.

---

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

• GaudiPython/python/GaudiPython/Bindings.py