ChimeraTK-DeviceAccess  03.18.00
Accessor< UserType > Class Template Reference
+ Inheritance diagram for Accessor< UserType >:
+ Collaboration diagram for Accessor< UserType >:

Public Member Functions

 Accessor ()
 
 ~Accessor () override
 
void doReadTransferSynchronously () override
 
bool doWriteTransfer (ChimeraTK::VersionNumber) override
 
void doPreWrite (TransferType, VersionNumber) override
 
void doPostWrite (TransferType, VersionNumber) override
 
void doPreRead (TransferType) override
 
void doPostRead (TransferType, bool) override
 
bool isReadOnly () const override
 
bool isReadable () const override
 
bool isWriteable () const override
 
std::vector< boost::shared_ptr< TransferElement > > getHardwareAccessingElements () override
 
std::list< boost::shared_ptr< TransferElement > > getInternalElements () override
 
- Public Member Functions inherited from ChimeraTK::NDRegisterAccessor< UserType >
 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). More...
 
UserType & accessData (size_t sample)
 Get or set register accessor's buffer content (1D version). More...
 
const UserType & accessData (size_t sample) const
 
UserType & accessData (unsigned int channel, unsigned int sample)
 Get or set register accessor's buffer content (2D version). More...
 
const UserType & accessData (unsigned int channel, unsigned int sample) const
 
std::vector< UserType > & accessChannel (unsigned int channel)
 Get or set register accessor's channel vector. More...
 
const std::vector< UserType > & accessChannel (unsigned int channel) const
 
std::vector< std::vector< UserType > > & accessChannels ()
 Get or set register accessor's 2D channel vector. More...
 
const std::vector< std::vector< UserType > > & accessChannels () const
 
unsigned int getNumberOfSamples () const
 Return number of elements per channel. More...
 
unsigned int getNumberOfChannels () const
 Return number of channels. More...
 
const std::type_info & getValueType () const override
 
template<typename COOKED_TYPE >
COOKED_TYPE getAsCooked (unsigned int channel, unsigned int sample) const
 
 DEFINE_VIRTUAL_FUNCTION_TEMPLATE_VTABLE (getAsCooked_impl, T const(unsigned int, unsigned int))
 
template<typename COOKED_TYPE >
COOKED_TYPE getAsCooked_impl (unsigned int channel, unsigned int sample) const
 
template<typename COOKED_TYPE >
void setAsCooked (unsigned int channel, unsigned int sample, COOKED_TYPE value)
 
 DEFINE_VIRTUAL_FUNCTION_TEMPLATE_VTABLE (setAsCooked_impl, void(unsigned int, unsigned int, T))
 
template<typename COOKED_TYPE >
void setAsCooked_impl (unsigned int channel, unsigned int sample, COOKED_TYPE value)
 
boost::shared_ptr< TransferElementmakeCopyRegisterDecorator () override
 

Additional Inherited Members

- Protected Member Functions inherited from ChimeraTK::NDRegisterAccessor< UserType >
 DEFINE_VIRTUAL_FUNCTION_TEMPLATE_VTABLE_FILLER (NDRegisterAccessor< UserType >, getAsCooked_impl, 2)
 
 DEFINE_VIRTUAL_FUNCTION_TEMPLATE_VTABLE_FILLER (NDRegisterAccessor< UserType >, setAsCooked_impl, 3)
 
- Protected Attributes inherited from ChimeraTK::NDRegisterAccessor< UserType >
std::vector< std::vector< UserType > > buffer_2D
 Buffer of converted data elements. More...
 

Detailed Description

template<typename UserType>
class Accessor< UserType >

Definition at line 20 of file testDataConsistencyGroup.cpp.

Constructor & Destructor Documentation

◆ Accessor()

template<typename UserType >
Accessor< UserType >::Accessor ( )
inline

Definition at line 22 of file testDataConsistencyGroup.cpp.

◆ ~Accessor()

template<typename UserType >
Accessor< UserType >::~Accessor ( )
inlineoverride

Definition at line 24 of file testDataConsistencyGroup.cpp.

Member Function Documentation

◆ doPostRead()

template<typename UserType >
void Accessor< UserType >::doPostRead ( TransferType  ,
bool   
)
inlineoverride

Definition at line 36 of file testDataConsistencyGroup.cpp.

◆ doPostWrite()

template<typename UserType >
void Accessor< UserType >::doPostWrite ( TransferType  ,
VersionNumber   
)
inlineoverride

Definition at line 32 of file testDataConsistencyGroup.cpp.

◆ doPreRead()

template<typename UserType >
void Accessor< UserType >::doPreRead ( TransferType  )
inlineoverride

Definition at line 34 of file testDataConsistencyGroup.cpp.

◆ doPreWrite()

template<typename UserType >
void Accessor< UserType >::doPreWrite ( TransferType  ,
VersionNumber   
)
inlineoverride

Definition at line 30 of file testDataConsistencyGroup.cpp.

◆ doReadTransferSynchronously()

template<typename UserType >
void Accessor< UserType >::doReadTransferSynchronously ( )
inlineoverride

Definition at line 26 of file testDataConsistencyGroup.cpp.

◆ doWriteTransfer()

template<typename UserType >
bool Accessor< UserType >::doWriteTransfer ( ChimeraTK::VersionNumber  )
inlineoverride

Definition at line 28 of file testDataConsistencyGroup.cpp.

◆ getHardwareAccessingElements()

template<typename UserType >
std::vector<boost::shared_ptr<TransferElement> > Accessor< UserType >::getHardwareAccessingElements ( )
inlineoverride

Definition at line 43 of file testDataConsistencyGroup.cpp.

◆ getInternalElements()

template<typename UserType >
std::list<boost::shared_ptr<TransferElement> > Accessor< UserType >::getInternalElements ( )
inlineoverride

Definition at line 46 of file testDataConsistencyGroup.cpp.

◆ isReadable()

template<typename UserType >
bool Accessor< UserType >::isReadable ( ) const
inlineoverride

Definition at line 40 of file testDataConsistencyGroup.cpp.

◆ isReadOnly()

template<typename UserType >
bool Accessor< UserType >::isReadOnly ( ) const
inlineoverride

Definition at line 39 of file testDataConsistencyGroup.cpp.

◆ isWriteable()

template<typename UserType >
bool Accessor< UserType >::isWriteable ( ) const
inlineoverride

Definition at line 41 of file testDataConsistencyGroup.cpp.


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