Group several registers (= TransferElement) which ensures data consistency across multiple variables through an algorithm which matches the VersionNumber. More...

#include <DataConsistencyGroup.h>

Public Types
enum	MatchingMode { MatchingMode::none, MatchingMode::exact }
	Enum describing the matching mode of a DataConsistencyGroup. More...

Public Member Functions
	DataConsistencyGroup ()
	Construct empty group. More...

	DataConsistencyGroup (std::initializer_list< TransferElementAbstractor > list)
	Construct this group with elements from the list using the add() function. More...

	DataConsistencyGroup (std::initializer_list< boost::shared_ptr< TransferElement >> list)

template<typename ITERATOR >
	DataConsistencyGroup (ITERATOR first, ITERATOR last)

void	add (const TransferElementAbstractor &element)
	Add register to group. More...

void	add (boost::shared_ptr< TransferElement > element)

bool	update (const TransferElementID &transferelementid)
	This function updates consistentElements, a set of TransferElementID. More...

void	setMatchingMode (MatchingMode newMode)
	Change the matching mode. More...

MatchingMode	getMatchingMode () const
	Return the current matching mode. More...

const std::map< TransferElementID, TransferElementAbstractor > &	getElements () const
	For inspection of contents. More...

bool	isConsistent () const
	returns true if consistent state is reached More...

Detailed Description

Group several registers (= TransferElement) which ensures data consistency across multiple variables through an algorithm which matches the VersionNumber.

This group does not read on its own. It should work together with a ReadAnyGroup. You should wait for changed variable and transfer it to this group by calling ChimeraTK::DataConsistencyGroup::update. If a consistent state is reached, this function returns true.

Definition at line 19 of file DataConsistencyGroup.h.

Member Enumeration Documentation

◆ MatchingMode

enum ChimeraTK::DataConsistencyGroup::MatchingMode

strong

Enum describing the matching mode of a DataConsistencyGroup.

Enumerator
none	No matching, effectively disable the DataConsitencyGroup. update() will always return true.
exact	Require an exact match of the VersionNumber of all current values of the group's members.

Definition at line 41 of file DataConsistencyGroup.h.

Constructor & Destructor Documentation

◆ DataConsistencyGroup() [1/4]

ChimeraTK::DataConsistencyGroup::DataConsistencyGroup ( )

default

Construct empty group.

Elements can later be added using the add() function.

◆ DataConsistencyGroup() [2/4]

ChimeraTK::DataConsistencyGroup::DataConsistencyGroup ( std::initializer_list< TransferElementAbstractor > list )

Construct this group with elements from the list using the add() function.

Definition at line 14 of file DataConsistencyGroup.cc.