deviceaccess.RegisterInfo

class deviceaccess.RegisterInfo

Bases: pybind11_object

__init__(self: deviceaccess.RegisterInfo, arg0: deviceaccess.RegisterInfo) → None

Catalogue of register information.

Methods

__init__(self, arg0)	Catalogue of register information.
getDataDescriptor(self)	Return description of the actual payload data for this register.
getNumberOfChannels(self)	Return the number of channels in the register.
getNumberOfDimensions(self)	Return the number of dimensions of this register.
getNumberOfElements(self)	Return the number of elements per channel.
getQualifiedAsyncId(self)	Get the fully qualified async::SubDomain ID.
getRegisterName(self)	Return the full path name of the register.
getSupportedAccessModes(self)	Return all supported AccessModes for this register.
getTags(self)	Get the list of tags that are associated with this register.
isReadable(self)	Check whether the register is readable.
isValid(self)	Check whether the RegisterInfo object is valid.
isWriteable(self)	Check whether the register is writeable.

__init__(self: deviceaccess.RegisterInfo, arg0: deviceaccess.RegisterInfo) → None

Catalogue of register information.

getDataDescriptor(self: deviceaccess.RegisterInfo) → ChimeraTK::DataDescriptor

Return description of the actual payload data for this register.

Returns:

DataDescriptor: Object containing information about the data format.

getNumberOfChannels(self: deviceaccess.RegisterInfo) → int

Return the number of channels in the register.

Returns:

int: Number of channels.

getNumberOfDimensions(self: deviceaccess.RegisterInfo) → int

Return the number of dimensions of this register.

Returns:

int: Number of dimensions (0=scalar, 1=1D array, 2=2D array).

getNumberOfElements(self: deviceaccess.RegisterInfo) → int

Return the number of elements per channel.

Returns:

int: Number of elements per channel.

getQualifiedAsyncId(self: deviceaccess.RegisterInfo) → std::vector<unsigned long, std::allocator<unsigned long> >

Get the fully qualified async::SubDomain ID.

If the register does not support wait_for_new_data it will be empty. Note: At the moment using async::Domain and async::SubDomain is not mandatory yet, so the ID might be empty even if the register supports wait_for_new_data.

Returns:

list[int]: List of IDs forming the fully qualified async::SubDomain ID.

getRegisterName(self: deviceaccess.RegisterInfo) → str

Return the full path name of the register.

Returns:

RegisterPath: Full path name of the register (including modules).

getSupportedAccessModes(self: deviceaccess.RegisterInfo) → list

Return all supported AccessModes for this register.

Returns:

list[AccessMode]: Flags indicating supported access modes.

getTags(self: deviceaccess.RegisterInfo) → std::set<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::less<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >

Get the list of tags that are associated with this register.

Returns:

set[str]: Set of tags associated with this register.

isReadable(self: deviceaccess.RegisterInfo) → bool

Check whether the register is readable.

Returns:

bool: True if the register is readable, false otherwise.

isValid(self: deviceaccess.RegisterInfo) → bool

Check whether the RegisterInfo object is valid.

Returns:

bool: True if the object contains a valid implementation, false otherwise.

isWriteable(self: deviceaccess.RegisterInfo) → bool

Check whether the register is writeable.

Returns:

bool: True if the register is writeable, false otherwise.