Accessor class to read and write void-typed registers. More...

#include <VoidRegisterAccessor.h>

Inheritance diagram for ChimeraTK::VoidRegisterAccessor:

Collaboration diagram for ChimeraTK::VoidRegisterAccessor:

Public Member Functions
	VoidRegisterAccessor (const boost::shared_ptr< NDRegisterAccessor< Void > > &impl)
	Construct from pointer to implementation.

	VoidRegisterAccessor ()=default
	Placeholder constructer, to allow late initialisation of the accessor, e.g.

bool	isReadOnly () const

bool	isReadable () const

void	read ()

bool	readNonBlocking ()

bool	readLatest ()

Public Member Functions inherited from ChimeraTK::NDRegisterAccessorAbstractor< ChimeraTK::Void >
	NDRegisterAccessorAbstractor ()=default
	Create an uninitialised abstractor - just for late initialisation.

	NDRegisterAccessorAbstractor (const NDRegisterAccessorAbstractor &)=default
	Declare that we want the default copy constructor although we delete the assigmnent operator.

void	replace (const NDRegisterAccessorAbstractor< UserType > &newAccessor)
	Assign a new accessor to this NDRegisterAccessorAbstractor.

void	replace (boost::shared_ptr< NDRegisterAccessor< UserType > > newImpl)
	Alternative signature of replace() with the same functionality, used when a pointer to the implementation has been obtained directly (instead of a NDRegisterAccessorAbstractor).

const NDRegisterAccessorAbstractor &	operator= (const NDRegisterAccessorAbstractor &rightHandSide) const=delete
	Prevent copying by operator=, since it will be confusing (operator= may also be overloaded to access the content of the buffer!)

boost::shared_ptr< NDRegisterAccessor< UserType > >	getImpl ()

Public Member Functions inherited from ChimeraTK::TransferElementAbstractor
	TransferElementAbstractor (boost::shared_ptr< TransferElement > impl)
	Construct from TransferElement implementation.

	TransferElementAbstractor ()=default
	Create an uninitialised abstractor - just for late initialisation.

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.

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

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

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.

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

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.

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

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

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

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

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

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

bool	isInitialised () const
	Return if the accessor is properly initialised.

void	replace (const TransferElementAbstractor &newAccessor)
	Assign a new accessor to this TransferElementAbstractor.

void	replace (boost::shared_ptr< TransferElement > newImpl)
	Alternative signature of relace() with the same functionality, used when a pointer to the implementation has been obtained directly (instead of a TransferElementAbstractor).

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

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

TransferElementID	getId () const
	Obtain unique ID for the actual implementation of this TransferElement.

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

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

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

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

Additional Inherited Members
Public Types inherited from ChimeraTK::NDRegisterAccessorAbstractor< ChimeraTK::Void >
using	value_type = UserType

Protected Member Functions inherited from ChimeraTK::NDRegisterAccessorAbstractor< ChimeraTK::Void >
	NDRegisterAccessorAbstractor (boost::shared_ptr< NDRegisterAccessor< UserType > > impl)

NDRegisterAccessor< UserType > *	get ()

const NDRegisterAccessor< UserType > *	get () const

Protected Attributes inherited from ChimeraTK::TransferElementAbstractor
boost::shared_ptr< TransferElement >	_impl
	Untyped pointer to implementation.

Detailed Description

Accessor class to read and write void-typed registers.

Definition at line 14 of file VoidRegisterAccessor.h.

Constructor & Destructor Documentation

◆ VoidRegisterAccessor() [1/2]

ChimeraTK::VoidRegisterAccessor::VoidRegisterAccessor ( const boost::shared_ptr< NDRegisterAccessor< Void > > & impl )

Construct from pointer to implementation.

Normally not called by the user, use Device::getVoidRegisterAccessor() instead.

Definition at line 10 of file VoidRegisterAccessor.cc.

◆ VoidRegisterAccessor() [2/2]

ChimeraTK::VoidRegisterAccessor::VoidRegisterAccessor ( )

default

Placeholder constructer, to allow late initialisation of the accessor, e.g.

in the open function.

Attention: Accessors created with this constructors will be dysfunctional, calling any member function will throw an exception (by the boost::shared_ptr)!

Member Function Documentation

◆ isReadable()

bool ChimeraTK::VoidRegisterAccessor::isReadable ( ) const

Definition at line 31 of file VoidRegisterAccessor.cc.

◆ isReadOnly()

bool ChimeraTK::VoidRegisterAccessor::isReadOnly ( ) const

Definition at line 21 of file VoidRegisterAccessor.cc.

◆ read()

void ChimeraTK::VoidRegisterAccessor::read ( )

inline

Definition at line 44 of file VoidRegisterAccessor.h.

◆ readLatest()

bool ChimeraTK::VoidRegisterAccessor::readLatest ( )

inline

Definition at line 62 of file VoidRegisterAccessor.h.

◆ readNonBlocking()

bool ChimeraTK::VoidRegisterAccessor::readNonBlocking ( )

inline

Definition at line 53 of file VoidRegisterAccessor.h.

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

/scratch/dragon/sources/ChimeraTK-DeviceAccess/include/VoidRegisterAccessor.h
/scratch/dragon/sources/ChimeraTK-DeviceAccess/src/VoidRegisterAccessor.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VoidRegisterAccessor() [1/2]

◆ VoidRegisterAccessor() [2/2]

Member Function Documentation

◆ isReadable()

◆ isReadOnly()

◆ read()

◆ readLatest()

◆ readNonBlocking()