ChimeraTK-ApplicationCore 04.06.00
Loading...
Searching...
No Matches
ChimeraTK::RecoveryHelper Struct Reference

A Helper struct to store an accessor and a version number. More...

#include <RecoveryHelper.h>

Public Types

enum class  Direction { fromDevice , toDevice }
 

Public Member Functions

 RecoveryHelper (boost::shared_ptr< TransferElement > a, VersionNumber v=VersionNumber(nullptr), uint64_t order=0, Direction direction=Direction::toDevice)
 
 RecoveryHelper ()=default
 

Public Attributes

boost::shared_ptr< TransferElement > accessor
 
VersionNumber versionNumber
 
uint64_t writeOrder {0}
 
bool wasWritten {false}
 
cppext::future_queue< void > notificationQueue
 
Direction recoveryDirection {Direction::toDevice}
 

Detailed Description

A Helper struct to store an accessor and a version number.

Like this you can set the user buffer of the accessors and the version number which shall be used when the accessor is written, but delay the writing do a later point in time.

Definition at line 15 of file RecoveryHelper.h.

Member Enumeration Documentation

◆ Direction

Enumerator
fromDevice 
toDevice 

Definition at line 16 of file RecoveryHelper.h.

Constructor & Destructor Documentation

◆ RecoveryHelper() [1/2]

ChimeraTK::RecoveryHelper::RecoveryHelper ( boost::shared_ptr< TransferElement >  a,
VersionNumber  v = VersionNumber(nullptr),
uint64_t  order = 0,
Direction  direction = Direction::toDevice 
)
inlineexplicit

Definition at line 24 of file RecoveryHelper.h.

◆ RecoveryHelper() [2/2]

ChimeraTK::RecoveryHelper::RecoveryHelper ( )
default

Member Data Documentation

◆ accessor

boost::shared_ptr<TransferElement> ChimeraTK::RecoveryHelper::accessor

Definition at line 17 of file RecoveryHelper.h.

◆ notificationQueue

cppext::future_queue<void> ChimeraTK::RecoveryHelper::notificationQueue

Definition at line 21 of file RecoveryHelper.h.

◆ recoveryDirection

Direction ChimeraTK::RecoveryHelper::recoveryDirection {Direction::toDevice}

Definition at line 22 of file RecoveryHelper.h.

◆ versionNumber

VersionNumber ChimeraTK::RecoveryHelper::versionNumber

Definition at line 18 of file RecoveryHelper.h.

◆ wasWritten

bool ChimeraTK::RecoveryHelper::wasWritten {false}

Definition at line 20 of file RecoveryHelper.h.

◆ writeOrder

uint64_t ChimeraTK::RecoveryHelper::writeOrder {0}

Definition at line 19 of file RecoveryHelper.h.


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