ChimeraTK::async::PolledAsyncVariable< UserType > Struct Template Reference

Implementation of the PolledAsyncVariable for the concrete UserType. More...

#include <TriggeredPollDistributor.h>

Inheritance diagram for ChimeraTK::async::PolledAsyncVariable< UserType >:

Collaboration diagram for ChimeraTK::async::PolledAsyncVariable< UserType >:

Public Member Functions
void	fillSendBuffer () final
	Fill the send buffer with data and version number.
	PolledAsyncVariable (boost::shared_ptr< NDRegisterAccessor< UserType > > syncAccessor_, TriggeredPollDistributor &owner)
	The constructor takes an already created synchronous accessor and a reference to the owing distributor.
unsigned int	getNumberOfChannels () override
	Helper functions for the creation of an AsyncNDRegisterAccessor.
unsigned int	getNumberOfSamples () override
const std::string &	getUnit () override
const std::string &	getDescription () override
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.
void	sendException (std::exception_ptr e) final
	Send an exception to all subscribers.
Public Member Functions inherited from ChimeraTK::async::AsyncVariable
virtual	~AsyncVariable ()=default

Protected Attributes
boost::shared_ptr< NDRegisterAccessor< UserType > >	_syncAccessor
TriggeredPollDistributor &	_owner

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

Detailed Description

template<typename UserType>
struct ChimeraTK::async::PolledAsyncVariable< UserType >

Implementation of the PolledAsyncVariable for the concrete UserType.

Definition at line 48 of file TriggeredPollDistributor.h.

Constructor & Destructor Documentation

PolledAsyncVariable()

template<typename UserType >

ChimeraTK::async::PolledAsyncVariable< UserType >::PolledAsyncVariable ( boost::shared_ptr< NDRegisterAccessor< UserType > >  syncAccessor_, TriggeredPollDistributor &  owner  )

explicit

The constructor takes an already created synchronous accessor and a reference to the owing distributor.

Definition at line 102 of file TriggeredPollDistributor.h.

Member Function Documentation

fillSendBuffer()

template<typename UserType >

void ChimeraTK::async::PolledAsyncVariable< UserType >::fillSendBuffer ( )

finalvirtual

Fill the send buffer with data and version number.

It is implementation specific where this information is coming from.

Implements ChimeraTK::async::AsyncVariable.

Definition at line 94 of file TriggeredPollDistributor.h.

getDescription()

template<typename UserType >

const std::string & ChimeraTK::async::PolledAsyncVariable< UserType >::getDescription ( )

inlineoverridevirtual

Implements ChimeraTK::async::AsyncVariable.

Definition at line 58 of file TriggeredPollDistributor.h.

getNumberOfChannels()

template<typename UserType >

unsigned int ChimeraTK::async::PolledAsyncVariable< UserType >::getNumberOfChannels ( )

inlineoverridevirtual

Helper functions for the creation of an AsyncNDRegisterAccessor.

As the creating code cannot use the catalogue, each backend has to implement these functions appropriately.

Reimplemented from ChimeraTK::async::AsyncVariableImpl< UserType >.

Definition at line 55 of file TriggeredPollDistributor.h.

getNumberOfSamples()

template<typename UserType >

unsigned int ChimeraTK::async::PolledAsyncVariable< UserType >::getNumberOfSamples ( )

inlineoverridevirtual

Reimplemented from ChimeraTK::async::AsyncVariableImpl< UserType >.

Definition at line 56 of file TriggeredPollDistributor.h.

getUnit()

template<typename UserType >

const std::string & ChimeraTK::async::PolledAsyncVariable< UserType >::getUnit ( )

inlineoverridevirtual

Implements ChimeraTK::async::AsyncVariable.

Definition at line 57 of file TriggeredPollDistributor.h.

Member Data Documentation

_owner

template<typename UserType >

TriggeredPollDistributor& ChimeraTK::async::PolledAsyncVariable< UserType >::_owner

protected

Definition at line 63 of file TriggeredPollDistributor.h.

_syncAccessor

template<typename UserType >

boost::shared_ptr<NDRegisterAccessor<UserType> > ChimeraTK::async::PolledAsyncVariable< UserType >::_syncAccessor

protected

Definition at line 61 of file TriggeredPollDistributor.h.

---

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

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