#include <SubdeviceRegisterAccessor.h>

Inheritance diagram for ChimeraTK::SubdeviceRegisterAccessor:

Collaboration diagram for ChimeraTK::SubdeviceRegisterAccessor:

Public Member Functions
	SubdeviceRegisterAccessor (boost::shared_ptr< SubdeviceBackend > backend, const std::string &registerPathName, boost::shared_ptr< NDRegisterAccessor< int32_t > > accAddress, boost::shared_ptr< NDRegisterAccessor< int32_t > > accDataArea, boost::shared_ptr< NDRegisterAccessor< int32_t > > accStatus, size_t byteOffset, size_t numberOfWords)

void	doReadTransferSynchronously () override
	Implementation version of readTransfer() for synchronous reads.

bool	doWriteTransfer (ChimeraTK::VersionNumber versionNumber) override
	Implementation version of writeTransfer().

void	doPreRead (TransferType type) override
	Backend specific implementation of preRead().

void	doPostRead (TransferType type, bool hasNewData) override
	Backend specific implementation of postRead().

void	doPreWrite (TransferType type, VersionNumber) override
	Backend specific implementation of preWrite().

void	doPostWrite (TransferType type, VersionNumber) override
	Backend specific implementation of postWrite().

bool	mayReplaceOther (const boost::shared_ptr< TransferElement const > &) const override
	Check whether the TransferElement can be used in places where the TransferElement "other" is currently used, e.g.

bool	isReadOnly () const override
	Check if transfer element is read only, i.e.

bool	isReadable () const override
	Check if transfer element is readable.

bool	isWriteable () const override
	Check if transfer element is writeable.

Public Member Functions inherited from ChimeraTK::NDRegisterAccessor< int32_t >
	NDRegisterAccessor (std::string const &name, AccessModeFlags accessModeFlags, std::string const &unit=std::string(TransferElement::unitNotSet), std::string const &description=std::string())
	Creates an NDRegisterAccessor with the specified name (passed on to the transfer element).

int32_t &	accessData (size_t sample)
	Get or set register accessor's buffer content (1D version).

const int32_t &	accessData (size_t sample) const

int32_t &	accessData (unsigned int channel, unsigned int sample)
	Get or set register accessor's buffer content (2D version).

const int32_t &	accessData (unsigned int channel, unsigned int sample) const

std::vector< int32_t > &	accessChannel (unsigned int channel)
	Get or set register accessor's channel vector.

const std::vector< int32_t > &	accessChannel (unsigned int channel) const

std::vector< std::vector< int32_t > > &	accessChannels ()
	Get or set register accessor's 2D channel vector.

const std::vector< std::vector< int32_t > > &	accessChannels () const

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

unsigned int	getNumberOfChannels () const
	Return number of channels.

const std::type_info &	getValueType () const override
	Returns the `std::type_info` for the value type of this transfer element.

COOKED_TYPE	getAsCooked (unsigned int channel, unsigned int sample) const

	DEFINE_VIRTUAL_FUNCTION_TEMPLATE_VTABLE (getAsCooked_impl, T const (unsigned int, unsigned int))

	DEFINE_VIRTUAL_FUNCTION_TEMPLATE_VTABLE (setAsCooked_impl, void(unsigned int, unsigned int, T))

COOKED_TYPE	getAsCooked_impl (unsigned int channel, unsigned int sample) const

void	setAsCooked (unsigned int channel, unsigned int sample, COOKED_TYPE value)

void	setAsCooked_impl (unsigned int channel, unsigned int sample, COOKED_TYPE value)

boost::shared_ptr< TransferElement >	makeCopyRegisterDecorator () override
	Create a CopyRegisterDecorator of the right type decorating this TransferElement.

virtual boost::shared_ptr< NDRegisterAccessor< int32_t > >	decorateDeepInside (std::function< boost::shared_ptr< NDRegisterAccessor< int32_t > >(const boost::shared_ptr< NDRegisterAccessor< int32_t > > &)> factory)
	Decorate the innermost TransferElement of the stack of decorators or decorator-like accessors.

Public Member Functions inherited from ChimeraTK::TransferElement
	TransferElement (std::string name, AccessModeFlags accessModeFlags, std::string unit=std::string(unitNotSet), std::string description=std::string())
	Creates a transfer element with the specified name.

	TransferElement (const TransferElement &other)=delete
	Copying and moving is not allowed.

	TransferElement (TransferElement &&other)=delete

TransferElement &	operator= (const TransferElement &other)=delete

TransferElement &	operator= (TransferElement &&other)=delete

virtual	~TransferElement ()=default
	Abstract base classes need a virtual destructor.

const std::string &	getName () const
	Returns the name that identifies the process variable.

const std::string &	getUnit () const
	Returns the engineering unit.

const std::string &	getDescription () const
	Returns the description of this variable/register.

AccessModeFlags	getAccessModeFlags () const
	Return the AccessModeFlags for this TransferElement.

void	setDataValidity (DataValidity validity=DataValidity::ok)
	Set the current DataValidity for this TransferElement.

DataValidity	dataValidity () const
	Return current validity of the data.

void	read ()
	Read the data from the device.

bool	readNonBlocking ()
	Read the next value, if available in the input buffer.

bool	readLatest ()
	Read the latest value, discarding any other update since the last read if present.

bool	write (ChimeraTK::VersionNumber versionNumber={})
	Write the data to device.

bool	writeDestructively (ChimeraTK::VersionNumber versionNumber={})
	Just like write(), but allows the implementation to destroy the content of the user buffer in the process.

ChimeraTK::VersionNumber	getVersionNumber () const
	Returns the version number that is associated with the last transfer (i.e.

void	setActiveException (std::exception_ptr &setThisException)
	Set an active exception.

virtual void	setExceptionBackend (boost::shared_ptr< DeviceBackend > exceptionBackend)
	Set the backend to which the exception has to be reported.

boost::shared_ptr< DeviceBackend >	getExceptionBackend ()
	Return the exception backend.

cppext::future_queue< void >	getReadQueue ()
	Function to get a copy of the read queue.

void	readTransfer ()
	Read the data from the device but do not fill it into the user buffer of this TransferElement.

bool	readTransferNonBlocking ()
	Read the data from the device but do not fill it into the user buffer of this TransferElement.

void	preRead (TransferType type)
	Perform any pre-read tasks if necessary.

void	postRead (TransferType type, bool updateDataBuffer)
	Transfer the data from the device receive buffer into the user buffer, while converting the data into the user data format if needed.

void	preWrite (TransferType type, ChimeraTK::VersionNumber versionNumber)
	Transfer the data from the user buffer into the device send buffer, while converting the data from then user data format if needed.

void	postWrite (TransferType type, VersionNumber versionNumber)
	Perform any post-write clean-ups if necessary.

bool	writeTransfer (ChimeraTK::VersionNumber versionNumber)
	Write the data to the device.

bool	writeTransferDestructively (ChimeraTK::VersionNumber versionNumber)
	Write the data to the device.

virtual boost::shared_ptr< TransferElement >	getHighLevelImplElement ()
	Obtain the highest level implementation TransferElement.

virtual void	setPersistentDataStorage (boost::shared_ptr< ChimeraTK::PersistentDataStorage >)
	Associate a persistent data storage object to be updated on each write operation of this ProcessArray.

TransferElementID	getId () const
	Obtain unique ID for this TransferElement, see TransferElementID for details.

virtual void	interrupt ()
	Return from a blocking read immediately and throw boost::thread_interrupted.

template<typename QUEUE_TYPE >
void	interrupt_impl (QUEUE_TYPE &dataTransportQueue)
	Implementation of interrupt()

bool	isReadTransactionInProgress () const
	Check whether a read transaction is in progress, i.e.

bool	isWriteTransactionInProgress () const
	Check whether a write transaction is in progress, i.e.

ReadAnyGroup *	getReadAnyGroup () const
	Obtain the ReadAnyGroup this TransferElement is part of, or nullptr if not in a ReadAnyGroup.

Protected Member Functions
std::vector< boost::shared_ptr< TransferElement > >	getHardwareAccessingElements () override
	Obtain the underlying TransferElements with actual hardware access.

std::list< boost::shared_ptr< TransferElement > >	getInternalElements () override
	Obtain the full list of TransferElements internally used by this TransferElement.

void	replaceTransferElement (boost::shared_ptr< TransferElement > newElement) override
	Search for all underlying TransferElements which are considered identical (see sameRegister()) with the given TransferElement.

Protected Member Functions inherited from ChimeraTK::NDRegisterAccessor< int32_t >
	DEFINE_VIRTUAL_FUNCTION_TEMPLATE_VTABLE_FILLER (NDRegisterAccessor< int32_t >, getAsCooked_impl, 2)

	DEFINE_VIRTUAL_FUNCTION_TEMPLATE_VTABLE_FILLER (NDRegisterAccessor< int32_t >, setAsCooked_impl, 3)

Protected Member Functions inherited from ChimeraTK::TransferElement
virtual bool	doWriteTransferDestructively (ChimeraTK::VersionNumber versionNumber)
	Implementation version of writeTransferDestructively().

void	makeUniqueId ()
	Allow generating a unique ID from derived classes.

Protected Attributes
boost::shared_ptr< SubdeviceBackend >	_backend
	Pointer to the backend.

boost::shared_ptr< NDRegisterAccessor< int32_t > >	_accAddress
	Pointers to the three accessors.

boost::shared_ptr< NDRegisterAccessor< int32_t > >	_accDataArea

boost::shared_ptr< NDRegisterAccessor< int32_t > >	_accStatus

size_t	_startAddress
	start address and length

size_t	_numberOfWords

std::vector< int32_t >	_buffer
	internal buffer

Protected Attributes inherited from ChimeraTK::NDRegisterAccessor< int32_t >
std::vector< std::vector< int32_t > >	buffer_2D
	Buffer of converted data elements.

Protected Attributes inherited from ChimeraTK::TransferElement
boost::shared_ptr< DeviceBackend >	_exceptionBackend
	The backend to which the runtime_errors are reported via DeviceBackend::setException().

std::string	_name
	Identifier uniquely identifying the TransferElement.

std::string	_unit
	Engineering unit.

std::string	_description
	Description of this variable/register.

TransferElementID	_id
	The ID of this TransferElement.

bool	_isInTransferGroup {false}
	Flag whether this TransferElement has been added to a TransferGroup or not.

ReadAnyGroup *	_inReadAnyGroup {nullptr}
	ReadAnyGroup this TransferElement has been added to, nullptr if not in a ReadAnyGroup.

AccessModeFlags	_accessModeFlags
	The access mode flags for this transfer element.

cppext::future_queue< void >	_readQueue
	The queue for asynchronous read transfers.

VersionNumber	_versionNumber {nullptr}
	The version number of the last successful transfer.

DataValidity	_dataValidity {DataValidity::ok}
	The validity of the data in the application buffer.

std::exception_ptr	_activeException {nullptr}
	Exception to be rethrown in postXXX() in case hasSeenException == true Can be set via setActiveException().

Additional Inherited Members
Public Types inherited from ChimeraTK::TransferElement
using	SharedPtr = boost::shared_ptr< TransferElement >
	A typedef for more compact syntax.

Static Public Attributes inherited from ChimeraTK::TransferElement
static constexpr char	unitNotSet [] = "n./a."
	Constant string to be used as a unit when the unit is not provided or known.

Detailed Description

Definition at line 14 of file SubdeviceRegisterAccessor.h.

Constructor & Destructor Documentation

◆ SubdeviceRegisterAccessor()

ChimeraTK::SubdeviceRegisterAccessor::SubdeviceRegisterAccessor	(	boost::shared_ptr< SubdeviceBackend >	backend,
		const std::string &	registerPathName,
		boost::shared_ptr< NDRegisterAccessor< int32_t > >	accAddress,
		boost::shared_ptr< NDRegisterAccessor< int32_t > >	accDataArea,
		boost::shared_ptr< NDRegisterAccessor< int32_t > >	accStatus,
		size_t	byteOffset,
		size_t	numberOfWords
	)

Definition at line 12 of file SubdeviceRegisterAccessor.cc.

Member Function Documentation

◆ doPostRead()

void ChimeraTK::SubdeviceRegisterAccessor::doPostRead	(	TransferType	,
		bool
	)

overridevirtual

Backend specific implementation of postRead().

postRead() will call this function, but it will make sure that it gets called only once per transfer.

No actual communication may be done. Hence, no runtime_error exception may be thrown by this function. Also it must be acceptable to call this function while the device is closed or not functional (see isFunctional()) and no exception is thrown.

Notes for backend implementations:

If the flag updateDataBuffer is false, the data buffer must stay unaltered. Full implementations (backends) must also leave the meta data (version number and data validity) unchanged. Decorators are allowed to change the meta data (for instance set the DataValidity::faulty).

Reimplemented from ChimeraTK::TransferElement.

Definition at line 109 of file SubdeviceRegisterAccessor.cc.

◆ doPostWrite()

void ChimeraTK::SubdeviceRegisterAccessor::doPostWrite	(	TransferType	,
		VersionNumber
	)

overridevirtual

Backend specific implementation of postWrite().

postWrite() will call this function, but it will make sure that it gets called only once per transfer.

No actual communication may be done. Hence, no runtime_error exception may be thrown by this function. Also it must be acceptable to call this function while the device is closed or not functional (see isFunctional()) and no exception is thrown.

Reimplemented from ChimeraTK::TransferElement.

Definition at line 142 of file SubdeviceRegisterAccessor.cc.

◆ doPreRead()

void ChimeraTK::SubdeviceRegisterAccessor::doPreRead ( TransferType )

overridevirtual

Backend specific implementation of preRead().

preRead() will call this function, but it will make sure that it gets called only once per transfer.

No actual communication may be done. Hence, no runtime_error exception may be thrown by this function. Also it must be acceptable to call this function while the device is closed or not functional (see isFunctional()) and no exception is thrown.

Reimplemented from ChimeraTK::TransferElement.

Definition at line 103 of file SubdeviceRegisterAccessor.cc.

◆ doPreWrite()

void ChimeraTK::SubdeviceRegisterAccessor::doPreWrite	(	TransferType	,
		VersionNumber
	)

overridevirtual

Backend specific implementation of preWrite().

preWrite() will call this function, but it will make sure that it gets called only once per transfer.

No actual communication may be done. Hence, no runtime_error exception may be thrown by this function. Also it must be acceptable to call this function while the device is closed or not functional (see isFunctional()) and no exception is thrown.

Reimplemented from ChimeraTK::TransferElement.

Definition at line 115 of file SubdeviceRegisterAccessor.cc.

Here is the call graph for this function:

◆ doReadTransferSynchronously()

void ChimeraTK::SubdeviceRegisterAccessor::doReadTransferSynchronously ( )

overridevirtual

Implementation version of readTransfer() for synchronous reads.

This function must be implemented by the backend. For the functional description read the documentation of readTransfer().

Implementation notes:

This function must return within ~1 second after both boost::thread::interrupt() (on the thread calling this function) and TransferElement::interrupt() have been called (reliable termination requires both calls; implementation needs to react to one of the call only).
Decorators must delegate the call to readTransfer() of the decorated target.
Delegations within the same object should go to the "do" version, e.g. to BaseClass::doReadTransferSynchronously()

Implements ChimeraTK::TransferElement.

Definition at line 26 of file SubdeviceRegisterAccessor.cc.

◆ doWriteTransfer()

bool ChimeraTK::SubdeviceRegisterAccessor::doWriteTransfer ( ChimeraTK::VersionNumber versionNumber )

overridevirtual

Implementation version of writeTransfer().

This function must be implemented by the backend. For the functional description read the documentation of writeTransfer().

Implementation notes:

Decorators must delegate the call to writeTransfer() of the decorated target.

Implements ChimeraTK::TransferElement.

Definition at line 32 of file SubdeviceRegisterAccessor.cc.

Here is the call graph for this function:

◆ getHardwareAccessingElements()

std::vector< boost::shared_ptr< TransferElement > > ChimeraTK::SubdeviceRegisterAccessor::getHardwareAccessingElements ( )

overrideprotectedvirtual

Obtain the underlying TransferElements with actual hardware access.

If this transfer element is directly reading from / writing to the hardware, it will return a list just containing a shared pointer of itself.

Note: Avoid using this in application code, since it will break the abstraction!

Implements ChimeraTK::TransferElement.

Definition at line 172 of file SubdeviceRegisterAccessor.cc.

◆ getInternalElements()

std::list< boost::shared_ptr< TransferElement > > ChimeraTK::SubdeviceRegisterAccessor::getInternalElements ( )

overrideprotectedvirtual

Obtain the full list of TransferElements internally used by this TransferElement.

The function is recursive, i.e. elements used by the elements returned by this function are also added to the list. It is guaranteed that the directly used elements are first in the list and the result from recursion is appended to the list.

Example: A decorator would return a list with its target TransferElement followed by the result of getInternalElements() called on its target TransferElement.

If this TransferElement is not using any other element, it should return an empty vector. Thus those elements which return a list just containing themselves in getHardwareAccessingElements() will return an empty list here in getInternalElements().

Note: Avoid using this in application code, since it will break the abstraction!

Implements ChimeraTK::TransferElement.

Definition at line 178 of file SubdeviceRegisterAccessor.cc.

◆ isReadable()

bool ChimeraTK::SubdeviceRegisterAccessor::isReadable ( ) const

overridevirtual

Check if transfer element is readable.

It throws an exception if you try to read and isReadable() is not true.

Implements ChimeraTK::TransferElement.

Definition at line 160 of file SubdeviceRegisterAccessor.cc.

◆ isReadOnly()

bool ChimeraTK::SubdeviceRegisterAccessor::isReadOnly ( ) const

overridevirtual

Check if transfer element is read only, i.e.

it is readable but not writeable.

Implements ChimeraTK::TransferElement.

Definition at line 154 of file SubdeviceRegisterAccessor.cc.

◆ isWriteable()

bool ChimeraTK::SubdeviceRegisterAccessor::isWriteable ( ) const

overridevirtual

Check if transfer element is writeable.

It throws an exception if you try to write and isWriteable() is not true.

Implements ChimeraTK::TransferElement.

Definition at line 166 of file SubdeviceRegisterAccessor.cc.

◆ mayReplaceOther()

bool ChimeraTK::SubdeviceRegisterAccessor::mayReplaceOther ( const boost::shared_ptr< TransferElement const > & other ) const

overridevirtual

Check whether the TransferElement can be used in places where the TransferElement "other" is currently used, e.g.

to merge the two transfers. This function must be used in replaceTransferElement() by implementations which use other TransferElements, to determine if a used TransferElement shall be replaced with the TransferElement "other".

The purpose of this function is not to determine if at any point in the hierarchy an replacement could be done. This function only works on a single level. It is not used by the TransferGroup to determine replaceTransferElement() whether shall be used (it is always called). Instead this function can be used by decorators etc. inside their implementation of replaceTransferElement() to determine if they might swap their implementation(s).

Note for decorators and similar implementations: This function must not be decorated. It should only return true if this should actually be replaced with other in the call to replaceTransferElement() one level up in the hierarchy. If the replacement should be done further down in the hierarchy, simply return false. It should only return if other is fully identical to this (i.e. behaves identical in all situations but might be another instance).

Reimplemented from ChimeraTK::TransferElement.

Definition at line 148 of file SubdeviceRegisterAccessor.cc.

◆ replaceTransferElement()

void ChimeraTK::SubdeviceRegisterAccessor::replaceTransferElement ( boost::shared_ptr< TransferElement > newElement )

overrideprotectedvirtual

Search for all underlying TransferElements which are considered identical (see sameRegister()) with the given TransferElement.

These TransferElements are then replaced with the new element. If no underlying element matches the new element, this function has no effect.

Reimplemented from ChimeraTK::TransferElement.

Definition at line 184 of file SubdeviceRegisterAccessor.cc.

Member Data Documentation

◆ _accAddress

boost::shared_ptr<NDRegisterAccessor<int32_t> > ChimeraTK::SubdeviceRegisterAccessor::_accAddress

protected

Pointers to the three accessors.

Definition at line 46 of file SubdeviceRegisterAccessor.h.

◆ _accDataArea

boost::shared_ptr<NDRegisterAccessor<int32_t> > ChimeraTK::SubdeviceRegisterAccessor::_accDataArea

protected

Definition at line 47 of file SubdeviceRegisterAccessor.h.

◆ _accStatus

boost::shared_ptr<NDRegisterAccessor<int32_t> > ChimeraTK::SubdeviceRegisterAccessor::_accStatus

protected

Definition at line 48 of file SubdeviceRegisterAccessor.h.

◆ _backend

boost::shared_ptr<SubdeviceBackend> ChimeraTK::SubdeviceRegisterAccessor::_backend

protected

Pointer to the backend.

Definition at line 43 of file SubdeviceRegisterAccessor.h.

◆ _buffer

std::vector<int32_t> ChimeraTK::SubdeviceRegisterAccessor::_buffer

protected

internal buffer

Definition at line 54 of file SubdeviceRegisterAccessor.h.

◆ _numberOfWords

size_t ChimeraTK::SubdeviceRegisterAccessor::_numberOfWords

protected

Definition at line 51 of file SubdeviceRegisterAccessor.h.

◆ _startAddress

size_t ChimeraTK::SubdeviceRegisterAccessor::_startAddress

protected

start address and length

Definition at line 51 of file SubdeviceRegisterAccessor.h.

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

/scratch/dragon/sources/ChimeraTK-DeviceAccess/backends/Subdevice/include/SubdeviceRegisterAccessor.h
/scratch/dragon/sources/ChimeraTK-DeviceAccess/backends/Subdevice/src/SubdeviceRegisterAccessor.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SubdeviceRegisterAccessor()

Member Function Documentation

◆ doPostRead()

◆ doPostWrite()

◆ doPreRead()

◆ doPreWrite()

◆ doReadTransferSynchronously()

◆ doWriteTransfer()

◆ getHardwareAccessingElements()

◆ getInternalElements()

◆ isReadable()

◆ isReadOnly()

◆ isWriteable()

◆ mayReplaceOther()

◆ replaceTransferElement()

Member Data Documentation

◆ _accAddress

◆ _accDataArea

◆ _accStatus

◆ _backend

◆ _buffer

◆ _numberOfWords

◆ _startAddress