Inheritance diagram for myRegisterInfo:

Collaboration diagram for myRegisterInfo:

Public Member Functions
	myRegisterInfo (std::string path, unsigned int nbOfElements, unsigned int nbOfChannels, unsigned int nbOfDimensions, DataDescriptor dataDescriptor, bool readable, bool writeable, AccessModeFlags supportedFlags, bool hidden=false)

	myRegisterInfo ()=default

RegisterPath	getRegisterName () const override
	Return full path name of the register (including modules)

unsigned int	getNumberOfElements () const override
	Return number of elements per channel.

unsigned int	getNumberOfChannels () const override
	Return number of channels in register.

const DataDescriptor &	getDataDescriptor () const override
	Return description of the actual payload data for this register.

bool	isReadable () const override
	Return whether the register is readable.

bool	isWriteable () const override
	Return whether the register is writeable.

AccessModeFlags	getSupportedAccessModes () const override
	Return all supported AccessModes for this register.

bool	isHidden () const override
	Returns whether the register is "hidden", meaning it won't be listed when iterating the catalogue.

std::unique_ptr< BackendRegisterInfoBase >	clone () const override
	Create copy of the object.

bool	operator== (const myRegisterInfo &other) const

Public Member Functions inherited from ChimeraTK::BackendRegisterInfoBase
virtual	~BackendRegisterInfoBase ()=default
	Virtual destructor.

unsigned int	getNumberOfDimensions () const
	Return number of dimensions of this register.

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.

Protected Attributes
RegisterPath	_path

unsigned int	_nbOfElements

unsigned int	_nbOfChannels

unsigned int	_nbOfDimensions

DataDescriptor	_dataDescriptor

bool	_readable

bool	_writeable

AccessModeFlags	_supportedFlags

bool	_hidden

Detailed Description

Definition at line 16 of file testRegisterCatalogue.cpp.

Constructor & Destructor Documentation

◆ myRegisterInfo() [1/2]

myRegisterInfo::myRegisterInfo	(	std::string	path,
		unsigned int	nbOfElements,
		unsigned int	nbOfChannels,
		unsigned int	nbOfDimensions,
		DataDescriptor	dataDescriptor,
		bool	readable,
		bool	writeable,
		AccessModeFlags	supportedFlags,
		bool	hidden = `false`
	)

inline

Definition at line 18 of file testRegisterCatalogue.cpp.

◆ myRegisterInfo() [2/2]

myRegisterInfo::myRegisterInfo ( )

default

Member Function Documentation

◆ clone()

std::unique_ptr< BackendRegisterInfoBase > myRegisterInfo::clone ( ) const

inlineoverridevirtual

Create copy of the object.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 42 of file testRegisterCatalogue.cpp.

◆ getDataDescriptor()

const DataDescriptor & myRegisterInfo::getDataDescriptor ( ) const

inlineoverridevirtual

Return description of the actual payload data for this register.

See the description of DataDescriptor for more information.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 32 of file testRegisterCatalogue.cpp.

◆ getNumberOfChannels()

unsigned int myRegisterInfo::getNumberOfChannels ( ) const

inlineoverridevirtual

Return number of channels in register.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 30 of file testRegisterCatalogue.cpp.

◆ getNumberOfElements()

unsigned int myRegisterInfo::getNumberOfElements ( ) const

inlineoverridevirtual

Return number of elements per channel.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 28 of file testRegisterCatalogue.cpp.

◆ getRegisterName()

RegisterPath myRegisterInfo::getRegisterName ( ) const

inlineoverridevirtual

Return full path name of the register (including modules)

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 26 of file testRegisterCatalogue.cpp.

◆ getSupportedAccessModes()

AccessModeFlags myRegisterInfo::getSupportedAccessModes ( ) const

inlineoverridevirtual

Return all supported AccessModes for this register.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 38 of file testRegisterCatalogue.cpp.

◆ isHidden()

bool myRegisterInfo::isHidden ( ) const

inlineoverridevirtual

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 from ChimeraTK::BackendRegisterInfoBase.

Definition at line 40 of file testRegisterCatalogue.cpp.

◆ isReadable()

bool myRegisterInfo::isReadable ( ) const

inlineoverridevirtual

Return whether the register is readable.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 34 of file testRegisterCatalogue.cpp.

◆ isWriteable()

bool myRegisterInfo::isWriteable ( ) const

inlineoverridevirtual

Return whether the register is writeable.

Implements ChimeraTK::BackendRegisterInfoBase.

Definition at line 36 of file testRegisterCatalogue.cpp.

◆ operator==()

bool myRegisterInfo::operator== ( const myRegisterInfo & other ) const

inline

Definition at line 47 of file testRegisterCatalogue.cpp.

Member Data Documentation

◆ _dataDescriptor

DataDescriptor myRegisterInfo::_dataDescriptor

protected

Definition at line 56 of file testRegisterCatalogue.cpp.

◆ _hidden

bool myRegisterInfo::_hidden

protected

Definition at line 59 of file testRegisterCatalogue.cpp.

◆ _nbOfChannels

unsigned int myRegisterInfo::_nbOfChannels

protected

Definition at line 55 of file testRegisterCatalogue.cpp.

◆ _nbOfDimensions

unsigned int myRegisterInfo::_nbOfDimensions

protected

Definition at line 55 of file testRegisterCatalogue.cpp.

◆ _nbOfElements

unsigned int myRegisterInfo::_nbOfElements

protected

Definition at line 55 of file testRegisterCatalogue.cpp.

◆ _path

RegisterPath myRegisterInfo::_path

protected

Definition at line 54 of file testRegisterCatalogue.cpp.

◆ _readable

bool myRegisterInfo::_readable

protected

Definition at line 57 of file testRegisterCatalogue.cpp.

◆ _supportedFlags

AccessModeFlags myRegisterInfo::_supportedFlags

protected

Definition at line 58 of file testRegisterCatalogue.cpp.

◆ _writeable

bool myRegisterInfo::_writeable

protected

Definition at line 57 of file testRegisterCatalogue.cpp.

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

/scratch/dragon/sources/ChimeraTK-DeviceAccess/tests/executables_src/testRegisterCatalogue.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ myRegisterInfo() [1/2]

◆ myRegisterInfo() [2/2]

Member Function Documentation

◆ clone()

◆ getDataDescriptor()

◆ getNumberOfChannels()

◆ getNumberOfElements()

◆ getRegisterName()

◆ getSupportedAccessModes()

◆ isHidden()

◆ isReadable()

◆ isWriteable()

◆ operator==()

Member Data Documentation

◆ _dataDescriptor

◆ _hidden

◆ _nbOfChannels

◆ _nbOfDimensions

◆ _nbOfElements

◆ _path

◆ _readable

◆ _supportedFlags

◆ _writeable