ChimeraTK-DeviceAccess  03.18.00
Public Member Functions | List of all members
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. More...
 
 Device (const std::string &aliasName)
 Initialize device and accociate a backend. More...
 
void open (std::string const &aliasName)
 Open a device by the given alias name from the DMAP file. More...
 
void open ()
 Re-open the device after previously closeing it by calling close(), or when it was constructed with a given aliasName. More...
 
void close ()
 Close the device. More...
 
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. More...
 
VoidRegisterAccessor getVoidRegisterAccessor (const RegisterPath &registerPathName, const AccessModeFlags &flags=AccessModeFlags({})) const
 Get a VoidRegisterAccessor object for the given register. More...
 
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. More...
 
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. More...
 
RegisterCatalogue getRegisterCatalogue () const
 Return the register catalogue with detailed information on all registers. More...
 
MetadataCatalogue getMetadataCatalogue () const
 Return the register catalogue with detailed information on all registers. More...
 
std::string readDeviceInfo () const
 Return a device information string. More...
 
bool isOpened () const
 Check if the device is currently opened. More...
 
bool isFunctional () const
 Return wether a device is working as intended, usually this means it is opened and does not have any errors. More...
 
void activateAsyncRead () noexcept
 Activate asyncronous read for all transfer elements where AccessMode::wait_for_new_data is set. More...
 
void setException (const std::string &message)
 Set the device into an exception state. More...
 
boost::shared_ptr< DeviceBackend > getBackend ()
 Obtain the backend. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 

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.

+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: