Register accessor for accessing multiplexed 2D array registers internally of a DummyBackend implementation. More...

#include <DummyRegisterAccessor.h>

Inheritance diagram for ChimeraTK::DummyMultiplexedRegisterAccessor< T >:

Collaboration diagram for ChimeraTK::DummyMultiplexedRegisterAccessor< T >:

Public Member Functions
	DummyMultiplexedRegisterAccessor (DummyBackend *dev, std::string const &module, std::string const &name)
	Constructor should normally be called in the constructor of the DummyBackend implementation.

void	operator= (const DummyMultiplexedRegisterAccessor &rightHandSide) const =delete
	remove assignment operator since it will be confusing

	DummyMultiplexedRegisterAccessor (const DummyMultiplexedRegisterAccessor &)=default

unsigned int	getNumberOfElements ()
	return number of elements per sequence

unsigned int	getNumberOfSequences ()
	return number of sequences

proxies::DummyRegisterSequence< T >	operator[] (unsigned int sequence)
	Get or set register content by [] operators.

DummyBackend &	getBackend () const
	Return the backend.

const RegisterPath &	getRegisterPath () const
	Return the register path.

const NumericAddressedRegisterInfo &	getRegisterInfo ()

Protected Attributes
DummyBackend *	_dev
	pointer to VirtualDevice

NumericAddressedRegisterInfo	registerInfo
	register map information

RegisterPath	_path
	path of the register

std::vector< FixedPointConverter< DEPRECATED_FIXEDPOINT_DEFAULT > >	fpc
	pointer to fixed point converter

std::vector< uint32_t >	offsets
	offsets in bytes for sequences

std::vector< uint32_t >	nbytes
	number of bytes per word for sequences

int	pitch = {0}
	pitch in bytes (distance between samples of the same sequence)

unsigned int	nElements
	number of elements per sequence

Detailed Description

template<typename T>
class ChimeraTK::DummyMultiplexedRegisterAccessor< T >

Register accessor for accessing multiplexed 2D array registers internally of a DummyBackend implementation.

This accessor is similar to the DummyRegister accessor but works with multiplexed registers. The interface is similar to the DummyRegister, it just introduces a second level of the [] operator. The first [] operator takes the sequence number (aka. channel number) as an argument, the second [] operator needs the index (aka. sample numeber) inside the sequence. Returned is then again a temporary proxy element of the same type as for the DummyRegister accessor, so it can again be used mostly like a variable of the type T.

Definition at line 222 of file DummyRegisterAccessor.h.

Constructor & Destructor Documentation

◆ DummyMultiplexedRegisterAccessor() [1/2]

template<typename T >

ChimeraTK::DummyMultiplexedRegisterAccessor< T >::DummyMultiplexedRegisterAccessor	(	DummyBackend *	dev,
		std::string const &	module,
		std::string const &	name
	)

inline

Constructor should normally be called in the constructor of the DummyBackend implementation.

dev must be the pointer to the DummyBackend to be accessed. A raw pointer is needed, as used inside the DummyBackend itself. module and name denominate the register entry in the map file. Note: The string "AREA_MULTIPLEXED_SEQUENCE_" will be prepended to the name when searching for the register.

Definition at line 230 of file DummyRegisterAccessor.h.

◆ DummyMultiplexedRegisterAccessor() [2/2]

template<typename T >

ChimeraTK::DummyMultiplexedRegisterAccessor< T >::DummyMultiplexedRegisterAccessor ( const DummyMultiplexedRegisterAccessor< T > & )

default

Member Function Documentation

◆ getBackend()

template<typename T >

DummyBackend & ChimeraTK::DummyMultiplexedRegisterAccessor< T >::getBackend ( ) const

inline

Return the backend.

Definition at line 282 of file DummyRegisterAccessor.h.

◆ getNumberOfElements()

template<typename T >

unsigned int ChimeraTK::DummyMultiplexedRegisterAccessor< T >::getNumberOfElements ( )

inline

return number of elements per sequence

Definition at line 261 of file DummyRegisterAccessor.h.

◆ getNumberOfSequences()

template<typename T >

unsigned int ChimeraTK::DummyMultiplexedRegisterAccessor< T >::getNumberOfSequences ( )

inline

return number of sequences

Definition at line 264 of file DummyRegisterAccessor.h.

◆ getRegisterInfo()

template<typename T >

const NumericAddressedRegisterInfo & ChimeraTK::DummyMultiplexedRegisterAccessor< T >::getRegisterInfo ( )

inline

Definition at line 287 of file DummyRegisterAccessor.h.

◆ getRegisterPath()

template<typename T >

const RegisterPath & ChimeraTK::DummyMultiplexedRegisterAccessor< T >::getRegisterPath ( ) const

inline

Return the register path.

Definition at line 285 of file DummyRegisterAccessor.h.

◆ operator=()

template<typename T >

void ChimeraTK::DummyMultiplexedRegisterAccessor< T >::operator= ( const DummyMultiplexedRegisterAccessor< T > & rightHandSide ) const

delete

remove assignment operator since it will be confusing

◆ operator[]()

template<typename T >

proxies::DummyRegisterSequence< T > ChimeraTK::DummyMultiplexedRegisterAccessor< T >::operator[] ( unsigned int sequence )

inline

Get or set register content by [] operators.

The first [] denotes the sequence (aka. channel number), the second [] indicates the sample inside the sequence. This means that in a sense the first index is the faster counting index. Example: myMuxRegister[3][987] will give you the 988th sample of the 4th channel.

Definition at line 271 of file DummyRegisterAccessor.h.

Member Data Documentation

◆ _dev

template<typename T >

DummyBackend* ChimeraTK::DummyMultiplexedRegisterAccessor< T >::_dev

protected

pointer to VirtualDevice

Definition at line 291 of file DummyRegisterAccessor.h.

◆ _path

template<typename T >

RegisterPath ChimeraTK::DummyMultiplexedRegisterAccessor< T >::_path

protected

path of the register

Definition at line 297 of file DummyRegisterAccessor.h.

◆ fpc

template<typename T >

std::vector<FixedPointConverter<DEPRECATED_FIXEDPOINT_DEFAULT> > ChimeraTK::DummyMultiplexedRegisterAccessor< T >::fpc

protected

pointer to fixed point converter

Definition at line 300 of file DummyRegisterAccessor.h.

◆ nbytes

template<typename T >

std::vector<uint32_t> ChimeraTK::DummyMultiplexedRegisterAccessor< T >::nbytes

protected

number of bytes per word for sequences

Definition at line 306 of file DummyRegisterAccessor.h.

◆ nElements

template<typename T >

unsigned int ChimeraTK::DummyMultiplexedRegisterAccessor< T >::nElements

protected

number of elements per sequence

Definition at line 312 of file DummyRegisterAccessor.h.

◆ offsets

template<typename T >

std::vector<uint32_t> ChimeraTK::DummyMultiplexedRegisterAccessor< T >::offsets

protected

offsets in bytes for sequences

Definition at line 303 of file DummyRegisterAccessor.h.

◆ pitch

template<typename T >

int ChimeraTK::DummyMultiplexedRegisterAccessor< T >::pitch = {0}

protected

pitch in bytes (distance between samples of the same sequence)

Definition at line 309 of file DummyRegisterAccessor.h.

◆ registerInfo

template<typename T >

NumericAddressedRegisterInfo ChimeraTK::DummyMultiplexedRegisterAccessor< T >::registerInfo

protected

register map information

Definition at line 294 of file DummyRegisterAccessor.h.

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

/scratch/dragon/sources/ChimeraTK-DeviceAccess/backends/DummyBackend/include/DummyBackend.h
/scratch/dragon/sources/ChimeraTK-DeviceAccess/backends/DummyBackend/include/DummyRegisterAccessor.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DummyMultiplexedRegisterAccessor() [1/2]

◆ DummyMultiplexedRegisterAccessor() [2/2]

Member Function Documentation

◆ getBackend()

◆ getNumberOfElements()

◆ getNumberOfSequences()

◆ getRegisterInfo()

◆ getRegisterPath()

◆ operator=()

◆ operator[]()

Member Data Documentation

◆ _dev

◆ _path

◆ fpc

◆ nbytes

◆ nElements

◆ offsets

◆ pitch

◆ registerInfo