ChimeraTK::async::GenericAsyncVariable< SourceType, UserType > Class Template Reference

#include <VariableDistributor.h>

Inheritance diagram for ChimeraTK::async::GenericAsyncVariable< SourceType, UserType >:

Collaboration diagram for ChimeraTK::async::GenericAsyncVariable< SourceType, UserType >:

Public Member Functions
	GenericAsyncVariable (SourceType &dataBuffer, VersionNumber &v, unsigned int nChannels, unsigned int nElements)
const std::string &	getUnit () override
	Make template specialisations on the SourceType in case the source data contains a unit. More...
const std::string &	getDescription () override
	Make template specialisations on the SourceType in case the source data contains a description. More...
Public Member Functions inherited from ChimeraTK::async::AsyncVariableImpl< UserType >
	AsyncVariableImpl (size_t nChannels, size_t nElements)
void	send () final
	Send the value from the _sendBuffer of the AsyncVariableImpl. More...
void	sendException (std::exception_ptr e) final
	Send an exception to all subscribers. More...
unsigned int	getNumberOfChannels () override
	Helper functions for the creation of an AsyncNDRegisterAccessor. More...
unsigned int	getNumberOfSamples () override
Public Member Functions inherited from ChimeraTK::async::AsyncVariable
virtual	~AsyncVariable ()=default
virtual void	fillSendBuffer ()=0
	Fill the send buffer with data and version number. More...

Protected Attributes
std::string	_emptyString {}
SourceType &	_dataBuffer
VersionNumber &	_version

Additional Inherited Members
Public Attributes inherited from ChimeraTK::async::AsyncVariableImpl< UserType >
NDRegisterAccessor< UserType >::Buffer	_sendBuffer

Detailed Description

template<typename SourceType, typename UserType>
class ChimeraTK::async::GenericAsyncVariable< SourceType, UserType >

Definition at line 27 of file VariableDistributor.h.

Constructor & Destructor Documentation

GenericAsyncVariable()

template<typename SourceType , typename UserType >

ChimeraTK::async::GenericAsyncVariable< SourceType, UserType >::GenericAsyncVariable ( SourceType &  dataBuffer, VersionNumber &  v, unsigned int  nChannels, unsigned int  nElements  )

inline

Definition at line 29 of file VariableDistributor.h.

Member Function Documentation

getDescription()

template<typename SourceType , typename UserType >

const std::string& ChimeraTK::async::GenericAsyncVariable< SourceType, UserType >::getDescription ( )

inlineoverridevirtual

Make template specialisations on the SourceType in case the source data contains a description.

Implements ChimeraTK::async::AsyncVariable.

Definition at line 40 of file VariableDistributor.h.

getUnit()

template<typename SourceType , typename UserType >

const std::string& ChimeraTK::async::GenericAsyncVariable< SourceType, UserType >::getUnit ( )

inlineoverridevirtual

Make template specialisations on the SourceType in case the source data contains a unit.

Implements ChimeraTK::async::AsyncVariable.

Definition at line 36 of file VariableDistributor.h.

Member Data Documentation

_dataBuffer

template<typename SourceType , typename UserType >

SourceType& ChimeraTK::async::GenericAsyncVariable< SourceType, UserType >::_dataBuffer

protected

Definition at line 44 of file VariableDistributor.h.

_emptyString

template<typename SourceType , typename UserType >

std::string ChimeraTK::async::GenericAsyncVariable< SourceType, UserType >::_emptyString {}

protected

Definition at line 43 of file VariableDistributor.h.

_version

template<typename SourceType , typename UserType >

VersionNumber& ChimeraTK::async::GenericAsyncVariable< SourceType, UserType >::_version

protected

Definition at line 45 of file VariableDistributor.h.

---

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

• /scratch/dragon/sources/ChimeraTK-DeviceAccess/include/async/VariableDistributor.h