GaudiKernel.GaudiHandles.GaudiHandle Class Reference

Inheritance diagram for GaudiKernel.GaudiHandles.GaudiHandle:

Public Member Functions
	__init__ (self, typeAndName)
	__repr__ (self)
	__str__ (self)
	__opt_value__ (self)
	toStringProperty (self)
	getType (self)
	getName (self)
	getGaudiHandle (self)
	getFullName (self)
	__eq__ (self, other)

Public Attributes
	typeAndName = typeAndName

Static Public Attributes
str	componentType = "Unspecified"
bool	isPublic = True

Static Private Attributes
tuple	__slots__ = ("typeAndName",)

Detailed Description

Definition at line 31 of file GaudiHandles.py.

Constructor & Destructor Documentation

__init__()

GaudiKernel.GaudiHandles.GaudiHandle.__init__	(		self,
			typeAndName )

Definition at line 37 of file GaudiHandles.py.

    def __init__(self, typeAndName):
        object.__init__(self)
        if hasattr(typeAndName, "toStringProperty"):
            # this is a GaudiHandle or equivalent
            typeAndName = typeAndName.toStringProperty()
        if not isinstance(typeAndName, str):
            raise TypeError(
                f"Argument to {self.__class__.__name__} must be a string. Got a {type(typeAndName).__name__} instead"
            )
        self.typeAndName = typeAndName
 

Member Function Documentation

__eq__()

GaudiKernel.GaudiHandles.GaudiHandle.__eq__	(		self,
			other )

Definition at line 93 of file GaudiHandles.py.

    def __eq__(self, other):
        return type(self) is type(other) and self.typeAndName == other.typeAndName
 
 

__opt_value__()

GaudiKernel.GaudiHandles.GaudiHandle.__opt_value__

(

self

)

Definition at line 56 of file GaudiHandles.py.

    def __opt_value__(self):
        return self.toStringProperty()
 

__repr__()

GaudiKernel.GaudiHandles.GaudiHandle.__repr__

(

self

)

Definition at line 48 of file GaudiHandles.py.

    def __repr__(self):
        return f"{self.__class__.__name__}({self.toStringProperty()!r})"
 

__str__()

GaudiKernel.GaudiHandles.GaudiHandle.__str__

(

self

)

Definition at line 51 of file GaudiHandles.py.

    def __str__(self):
        # FIXME: (Patch #1668) this creates problem with 2.5
        # return "%s:%s" % (self.__class__.__name__, self.toStringProperty())
        return self.toStringProperty()
 

getFullName()

GaudiKernel.GaudiHandles.GaudiHandle.getFullName

(

self

)

Definition at line 90 of file GaudiHandles.py.

    def getFullName(self):
        return self.toStringProperty()
 

getGaudiHandle()

GaudiKernel.GaudiHandles.GaudiHandle.getGaudiHandle

(

self

)

Definition at line 87 of file GaudiHandles.py.

    def getGaudiHandle(self):
        return self
 

getName()

GaudiKernel.GaudiHandles.GaudiHandle.getName

(

self

)

Get the 'name' part of the \"type/name\" string.
If only a type is given, this will be returned as the name.
If the \"type/name\" string is empty, it will return an emtpy string.

Definition at line 75 of file GaudiHandles.py.

    def getName(self):
        """Get the 'name' part of the \"type/name\" string.
        If only a type is given, this will be returned as the name.
        If the \"type/name\" string is empty, it will return an emtpy string."""
        slash = self.typeAndName.find("/")
        if slash != -1:
            # explicit name. Return part after the /
            return self.typeAndName[slash + 1 :]
        else:
            # only type is given. return type as default name
            return self.typeAndName
 

getType()

GaudiKernel.GaudiHandles.GaudiHandle.getType

(

self

)

Get the 'type' part of the \"type/name\" string.

Definition at line 65 of file GaudiHandles.py.

    def getType(self):
        """Get the 'type' part of the \"type/name\" string."""
        slash = self.typeAndName.find("/")
        if slash != -1:
            # includes name. Return part before /
            return self.typeAndName[0:slash]
        else:
            # only type is given, return full string
            return self.typeAndName
 

toStringProperty()

GaudiKernel.GaudiHandles.GaudiHandle.toStringProperty

(

self

)

Definition at line 62 of file GaudiHandles.py.

    def toStringProperty(self):
        return self.typeAndName
 

Member Data Documentation

__slots__

tuple GaudiKernel.GaudiHandles.GaudiHandle.__slots__ = ("typeAndName",)

staticprivate

Definition at line 35 of file GaudiHandles.py.

componentType

str GaudiKernel.GaudiHandles.GaudiHandle.componentType = "Unspecified"

static

Definition at line 32 of file GaudiHandles.py.

isPublic

bool GaudiKernel.GaudiHandles.GaudiHandle.isPublic = True

static

Definition at line 33 of file GaudiHandles.py.

typeAndName

GaudiKernel.GaudiHandles.GaudiHandle.typeAndName = typeAndName

Definition at line 46 of file GaudiHandles.py.

---

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

• GaudiKernel/python/GaudiKernel/GaudiHandles.py