deviceaccess.RegisterCatalogue

class deviceaccess.RegisterCatalogue

Bases: pybind11_object

__init__(self: deviceaccess.RegisterCatalogue, arg0: deviceaccess.RegisterCatalogue) → None: Catalogue of register information.

Methods

`__init__`(self, arg0)	Catalogue of register information.
`getNumberOfRegisters`(self)	Get number of registers in the catalogue.
`getRegister`(self, registerPathName)	Get register information for a given full path name.
`hasRegister`(self, registerPathName)	Check if register with the given path name exists.
`hiddenRegisters`(self)	Return list of all hidden registers in the catalogue.

__init__(self: deviceaccess.RegisterCatalogue, arg0: deviceaccess.RegisterCatalogue) → None: Catalogue of register information.

getNumberOfRegisters(self: deviceaccess.RegisterCatalogue) → int

Get number of registers in the catalogue.

Returns:
int: Number of registers in the catalogue.

getRegister(self: deviceaccess.RegisterCatalogue, registerPathName: ChimeraTK::RegisterPath) → ChimeraTK::RegisterInfo

Get register information for a given full path name.

Args:
registerPathName (str): Full path name of the register.

Returns:
RegisterInfo: Register information.

Raises:
ChimeraTK::logic_error: If register does not exist in the catalogue.

hasRegister(self: deviceaccess.RegisterCatalogue, registerPathName: ChimeraTK::RegisterPath) → bool

Check if register with the given path name exists.

Args:
registerPathName (str): Full path name of the register.

Returns:
bool: True if register exists in the catalogue, false otherwise.

hiddenRegisters(self: deviceaccess.RegisterCatalogue) → list

Return list of all hidden registers in the catalogue.

Returns:
list[deviceaccess.RegisterInfo]: A list of hidden RegisterInfo objects.