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. More...
virtual RegisterPath	getRegisterName () const =0
	Return full path name of the register (including modules) More...
virtual unsigned int	getNumberOfElements () const =0
	Return number of elements per channel. More...
virtual unsigned int	getNumberOfChannels () const =0
	Return number of channels in register. More...
unsigned int	getNumberOfDimensions () const
	Return number of dimensions of this register. More...
virtual const DataDescriptor &	getDataDescriptor () const =0
	Return desciption of the actual payload data for this register. More...
virtual bool	isReadable () const =0
	Return whether the register is readable. More...
virtual bool	isWriteable () const =0
	Return whether the register is writeable. More...
virtual AccessModeFlags	getSupportedAccessModes () const =0
	Return all supported AccessModes for this register. More...
virtual std::unique_ptr< BackendRegisterInfoBase >	clone () const =0
	Create copy of the object. More...
virtual std::vector< size_t >	getQualifiedAsyncId () const
	Return the fully qualified async::SubDomain ID. More...

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::NumericAddressedRegisterInfo, ChimeraTK::LNMBackendRegisterInfo, and myRegisterInfo.

Here is the caller graph for this function:

getDataDescriptor()

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

pure virtual

Return desciption of the actual payload data for this register.

See the description of DataDescriptor for more information.

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

getNumberOfChannels()

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

pure virtual

Return number of channels in register.

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

Here is the caller graph for this function:

getNumberOfDimensions()

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

inline

Return number of dimensions of this register.

Definition at line 58 of file BackendRegisterInfoBase.h.

Here is the call graph for this function:

Here is the caller graph for this function:

getNumberOfElements()

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

pure virtual

Return number of elements per channel.

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

Here is the caller graph for this function:

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::NumericAddressedRegisterInfo, ChimeraTK::LNMBackendRegisterInfo, and myRegisterInfo.

getSupportedAccessModes()

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

pure virtual

Return all supported AccessModes for this register.

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

isReadable()

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

pure virtual

Return whether the register is readable.

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

isWriteable()

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

pure virtual

Return whether the register is writeable.

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

---

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

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