#include <RegisterInfo.h>

Collaboration diagram for ChimeraTK::RegisterInfo:

Public Member Functions
	RegisterInfo (std::unique_ptr< BackendRegisterInfoBase > &&impl)

	RegisterInfo (const RegisterInfo &other)

	RegisterInfo (RegisterInfo &&other)=default

RegisterInfo &	operator= (const RegisterInfo &other)

RegisterInfo &	operator= (RegisterInfo &&other)=default

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

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

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

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

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

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

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

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

bool	isValid () const
	Check whether the RegisterPath object is valid (i.e.

BackendRegisterInfoBase &	getImpl ()
	Return a reference to the implementation object.

const BackendRegisterInfoBase &	getImpl () const
	Return a const reference to the implementation object.

std::vector< size_t >	getQualifiedAsyncId () const
	Get the fully qualified async::SubDomain ID.

std::set< std::string >	getTags () const
	Get the list of tags that are associated with this register.

Protected Attributes
std::unique_ptr< BackendRegisterInfoBase >	_impl

Detailed Description

Definition at line 12 of file RegisterInfo.h.

Constructor & Destructor Documentation

◆ RegisterInfo() [1/3]

ChimeraTK::RegisterInfo::RegisterInfo ( std::unique_ptr< BackendRegisterInfoBase > && impl )

explicit

Definition at line 10 of file RegisterInfo.cpp.

◆ RegisterInfo() [2/3]

ChimeraTK::RegisterInfo::RegisterInfo ( const RegisterInfo & other )

Definition at line 14 of file RegisterInfo.cpp.

◆ RegisterInfo() [3/3]

ChimeraTK::RegisterInfo::RegisterInfo ( RegisterInfo && other )

default

Member Function Documentation

◆ getDataDescriptor()

const DataDescriptor & ChimeraTK::RegisterInfo::getDataDescriptor ( ) const

Return desciption of the actual payload data for this register.

See the description of DataDescriptor for more information.

Definition at line 56 of file RegisterInfo.cpp.

◆ getImpl() [1/2]

BackendRegisterInfoBase & ChimeraTK::RegisterInfo::getImpl ( )

Return a reference to the implementation object.

Only for advanced use, e.g. when backend-depending code shall be written.

Definition at line 86 of file RegisterInfo.cpp.

◆ getImpl() [2/2]

const BackendRegisterInfoBase & ChimeraTK::RegisterInfo::getImpl ( ) const

Return a const reference to the implementation object.

Only for advanced use, e.g. when backend-depending code shall be written.

Definition at line 92 of file RegisterInfo.cpp.

◆ getNumberOfChannels()

unsigned int ChimeraTK::RegisterInfo::getNumberOfChannels ( ) const

Return number of channels in register.

Definition at line 44 of file RegisterInfo.cpp.

◆ getNumberOfDimensions()

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

Return number of dimensions of this register.

Definition at line 50 of file RegisterInfo.cpp.

◆ getNumberOfElements()

unsigned int ChimeraTK::RegisterInfo::getNumberOfElements ( ) const

Return number of elements per channel.

Definition at line 38 of file RegisterInfo.cpp.

◆ getQualifiedAsyncId()

std::vector< size_t > ChimeraTK::RegisterInfo::getQualifiedAsyncId ( ) const

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.

Definition at line 98 of file RegisterInfo.cpp.

◆ getRegisterName()

RegisterPath ChimeraTK::RegisterInfo::getRegisterName ( ) const

Return full path name of the register (including modules)

Definition at line 32 of file RegisterInfo.cpp.

◆ getSupportedAccessModes()

AccessModeFlags ChimeraTK::RegisterInfo::getSupportedAccessModes ( ) const

Return all supported AccessModes for this register.

Definition at line 74 of file RegisterInfo.cpp.

◆ getTags()

std::set< std::string > ChimeraTK::RegisterInfo::getTags ( ) const

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

See also: ChimeraTK::SystemTags for a list of pre-defined tags.

Definition at line 104 of file RegisterInfo.cpp.

◆ isReadable()

bool ChimeraTK::RegisterInfo::isReadable ( ) const

Return whether the register is readable.

Definition at line 62 of file RegisterInfo.cpp.

◆ isValid()

bool ChimeraTK::RegisterInfo::isValid ( ) const

Check whether the RegisterPath object is valid (i.e.

contains an implementation object)

Definition at line 80 of file RegisterInfo.cpp.

◆ isWriteable()

bool ChimeraTK::RegisterInfo::isWriteable ( ) const

Return whether the register is writeable.

Definition at line 68 of file RegisterInfo.cpp.

◆ operator=() [1/2]

RegisterInfo & ChimeraTK::RegisterInfo::operator= ( const RegisterInfo & other )

Definition at line 20 of file RegisterInfo.cpp.

◆ operator=() [2/2]

RegisterInfo & ChimeraTK::RegisterInfo::operator= ( RegisterInfo && other )