TestableDevice Class Reference

Inheritance diagram for TestableDevice:

Collaboration diagram for TestableDevice:

Public Member Functions
boost::shared_ptr< ChimeraTK::DeviceBackend >	getBackend ()
Public Member Functions inherited from ChimeraTK::Device
	Device ()=default
	Create device instance without associating a backend yet.
	Device (const std::string &aliasName)
	Initialize device and accociate a backend.
void	open (std::string const &aliasName)
	Open a device by the given alias name from the DMAP file.
void	open ()
	Re-open the device after previously closeing it by calling close(), or when it was constructed with a given aliasName.
void	close ()
	Close the device.
template<typename UserType >
ScalarRegisterAccessor< UserType >	getScalarRegisterAccessor (const RegisterPath &registerPathName, size_t wordOffsetInRegister=0, const AccessModeFlags &flags=AccessModeFlags({})) const
	Get a ScalarRegisterObject object for the given register.
VoidRegisterAccessor	getVoidRegisterAccessor (const RegisterPath &registerPathName, const AccessModeFlags &flags=AccessModeFlags({})) const
	Get a VoidRegisterAccessor object for the given register.
template<typename UserType >
OneDRegisterAccessor< UserType >	getOneDRegisterAccessor (const RegisterPath &registerPathName, size_t numberOfWords=0, size_t wordOffsetInRegister=0, const AccessModeFlags &flags=AccessModeFlags({})) const
	Get a OneDRegisterAccessor object for the given register.
template<typename UserType >
TwoDRegisterAccessor< UserType >	getTwoDRegisterAccessor (const RegisterPath &registerPathName, size_t numberOfElements=0, size_t elementsOffset=0, const AccessModeFlags &flags=AccessModeFlags({})) const
	Get a TwoDRegisterAccessor object for the given register.
RegisterCatalogue	getRegisterCatalogue () const
	Return the register catalogue with detailed information on all registers.
MetadataCatalogue	getMetadataCatalogue () const
	Return the register catalogue with detailed information on all registers.
std::string	readDeviceInfo () const
	Return a device information string.
bool	isOpened () const
	Check if the device is currently opened.
bool	isFunctional () const
	Return wether a device is working as intended, usually this means it is opened and does not have any errors.
void	activateAsyncRead () noexcept
	Activate asyncronous read for all transfer elements where AccessMode::wait_for_new_data is set.
void	setException (const std::string &message)
	Set the device into an exception state.
boost::shared_ptr< DeviceBackend >	getBackend ()
	Obtain the backend.
std::set< DeviceBackend::BackendID >	getInvolvedBackendIDs ()
	Recursively obtain the set of all backend IDs that are used withing the device.
template<typename UserType >
UserType	read (const RegisterPath &registerPathName, const AccessModeFlags &flags=AccessModeFlags({})) const
	Inefficient convenience function to read a single-word register without obtaining an accessor.
template<typename UserType >
std::vector< UserType >	read (const RegisterPath &registerPathName, size_t numberOfWords, size_t wordOffsetInRegister=0, const AccessModeFlags &flags=AccessModeFlags({})) const
	Inefficient convenience function to read a multi-word register without obtaining an accessor.
template<typename UserType >
void	write (const RegisterPath &registerPathName, UserType value, const AccessModeFlags &flags=AccessModeFlags({}))
	Inefficient convenience function to write a single-word register without obtaining an accessor.
template<typename UserType >
void	write (const RegisterPath &registerPathName, const std::vector< UserType > &vector, size_t wordOffsetInRegister=0, const AccessModeFlags &flags=AccessModeFlags({}))
	Inefficient convenience function to write a multi-word register without obtaining an accessor.

Additional Inherited Members
Protected Member Functions inherited from ChimeraTK::Device
void	checkPointersAreNotNull () const
Protected Attributes inherited from ChimeraTK::Device
boost::shared_ptr< DeviceBackend >	_deviceBackendPointer

Detailed Description

Definition at line 21 of file testDevice.cpp.

Member Function Documentation

getBackend()

boost::shared_ptr< ChimeraTK::DeviceBackend > TestableDevice::getBackend ( )

inline

Definition at line 23 of file testDevice.cpp.

---

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

• /scratch/dragon/sources/ChimeraTK-DeviceAccess/tests/executables_src/testDevice.cpp