ChimeraTK::BackendRegisterInfoBase Class Reference

DeviceBackend-independent register description. More...

#include <BackendRegisterInfoBase.h>

Inheritance diagram for ChimeraTK::BackendRegisterInfoBase:

Public Member Functions
virtual	~BackendRegisterInfoBase ()=default
	Virtual destructor.
virtual RegisterPath	getRegisterName () const =0
	Return full path name of the register (including modules)
virtual unsigned int	getNumberOfElements () const =0
	Return number of elements per channel.
virtual unsigned int	getNumberOfChannels () const =0
	Return number of channels in register.
unsigned int	getNumberOfDimensions () const
	Return number of dimensions of this register.
virtual const DataDescriptor &	getDataDescriptor () const =0
	Return description of the actual payload data for this register.
virtual bool	isReadable () const =0
	Return whether the register is readable.
virtual bool	isWriteable () const =0
	Return whether the register is writeable.
virtual AccessModeFlags	getSupportedAccessModes () const =0
	Return all supported AccessModes for this register.
virtual std::unique_ptr< BackendRegisterInfoBase >	clone () const =0
	Create copy of the object.
virtual std::vector< size_t >	getQualifiedAsyncId () const
	Return the fully qualified async::SubDomain ID.
virtual std::set< std::string >	getTags () const
	Get the list of tags associated with this register.
virtual bool	isHidden () const
	Returns whether the register is "hidden", meaning it won't be listed when iterating the catalogue.

Detailed Description

DeviceBackend-independent register description.

Definition at line 16 of file BackendRegisterInfoBase.h.

Constructor & Destructor Documentation

~BackendRegisterInfoBase()

virtual ChimeraTK::BackendRegisterInfoBase::~BackendRegisterInfoBase ( )

virtualdefault

Virtual destructor.

Member Function Documentation

clone()

virtual std::unique_ptr< BackendRegisterInfoBase > ChimeraTK::BackendRegisterInfoBase::clone ( ) const

pure virtual

Create copy of the object.

Implemented in ChimeraTK::LNMBackendRegisterInfo, ChimeraTK::NumericAddressedRegisterInfo, and myRegisterInfo.

getDataDescriptor()

virtual const DataDescriptor & ChimeraTK::BackendRegisterInfoBase::getDataDescriptor ( ) const

pure virtual

Return description of the actual payload data for this register.

See the description of DataDescriptor for more information.

Implemented in ChimeraTK::LNMBackendRegisterInfo, ChimeraTK::NumericAddressedRegisterInfo, and myRegisterInfo.

getNumberOfChannels()

virtual unsigned int ChimeraTK::BackendRegisterInfoBase::getNumberOfChannels ( ) const

pure virtual

Return number of channels in register.

Implemented in ChimeraTK::LNMBackendRegisterInfo, ChimeraTK::NumericAddressedRegisterInfo, and myRegisterInfo.

getNumberOfDimensions()

unsigned int ChimeraTK::BackendRegisterInfoBase::getNumberOfDimensions ( ) const

inline

Return number of dimensions of this register.

Definition at line 72 of file BackendRegisterInfoBase.h.

getNumberOfElements()

virtual unsigned int ChimeraTK::BackendRegisterInfoBase::getNumberOfElements ( ) const

pure virtual

Return number of elements per channel.

Implemented in ChimeraTK::LNMBackendRegisterInfo, ChimeraTK::NumericAddressedRegisterInfo, and myRegisterInfo.

getQualifiedAsyncId()

virtual std::vector< size_t > ChimeraTK::BackendRegisterInfoBase::getQualifiedAsyncId ( ) const

inlinevirtual

Return the fully qualified async::SubDomain ID.

The default implementation returns an empty vector.

Reimplemented in ChimeraTK::NumericAddressedRegisterInfo.

Definition at line 53 of file BackendRegisterInfoBase.h.

getRegisterName()

virtual RegisterPath ChimeraTK::BackendRegisterInfoBase::getRegisterName ( ) const

pure virtual

Return full path name of the register (including modules)

Implemented in ChimeraTK::LNMBackendRegisterInfo, ChimeraTK::NumericAddressedRegisterInfo, and myRegisterInfo.

getSupportedAccessModes()

virtual AccessModeFlags ChimeraTK::BackendRegisterInfoBase::getSupportedAccessModes ( ) const

pure virtual

Return all supported AccessModes for this register.

Implemented in ChimeraTK::LNMBackendRegisterInfo, ChimeraTK::NumericAddressedRegisterInfo, and myRegisterInfo.

getTags()

virtual std::set< std::string > ChimeraTK::BackendRegisterInfoBase::getTags ( ) const

inlinevirtual

Get the list of tags associated with this register.

The default implementation returns an empty list.

Reimplemented in ChimeraTK::LNMBackendRegisterInfo.

Definition at line 60 of file BackendRegisterInfoBase.h.

isHidden()

virtual bool ChimeraTK::BackendRegisterInfoBase::isHidden ( ) const

inlinevirtual

Returns whether the register is "hidden", meaning it won't be listed when iterating the catalogue.

Hidden registers can be explicitly iterated, but the ordinary iterators will not show them.

Reimplemented in ChimeraTK::NumericAddressedRegisterInfo, and myRegisterInfo.

Definition at line 67 of file BackendRegisterInfoBase.h.

isReadable()

virtual bool ChimeraTK::BackendRegisterInfoBase::isReadable ( ) const

pure virtual

Return whether the register is readable.

Implemented in ChimeraTK::LNMBackendRegisterInfo, ChimeraTK::NumericAddressedRegisterInfo, and myRegisterInfo.

isWriteable()

virtual bool ChimeraTK::BackendRegisterInfoBase::isWriteable ( ) const

pure virtual

Return whether the register is writeable.

Implemented in ChimeraTK::LNMBackendRegisterInfo, ChimeraTK::NumericAddressedRegisterInfo, and myRegisterInfo.

---

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

• /scratch/dragon/sources/ChimeraTK-DeviceAccess/include/BackendRegisterInfoBase.h