DynExp
Highly flexible laboratory automation for dynamically changing experiments.
DynExp::ParamsBase::LinkParamStarter Class Reference

Makes sure the object link parameters of the associated ParamsBase instance are in a ready state by performing the initialization stepwise to allow updating the UI in between. Instances of this class can only be used once. More...

Public Member Functions

 LinkParamStarter (const ParamsBase &Params) noexcept
 Constructs a LinkParamStarter instance for single use. More...
 
bool operator() ()
 Performs the initialization stepwise. This functions is to be called as long as it returns true. It returns after every step to allow doing other work in the meantime (e.g. updating the UI). More...
 

Private Attributes

const ParamsBaseParams
 Reference to a parameter class whose object link parameters have to be ready. More...
 
ParamsBase::ObjectLinkParamsType::const_iterator CurrentParam
 Iterator to the parameter which is currently being made ready. More...
 
bool EnsureReadyStateCalledForCurrentParam
 Waiting for the current parameter to become ready or moving on to the next parameter? More...
 

Detailed Description

Makes sure the object link parameters of the associated ParamsBase instance are in a ready state by performing the initialization stepwise to allow updating the UI in between. Instances of this class can only be used once.

Definition at line 1588 of file Object.h.

Constructor & Destructor Documentation

◆ LinkParamStarter()

DynExp::ParamsBase::LinkParamStarter::LinkParamStarter ( const ParamsBase Params)
inlinenoexcept

Constructs a LinkParamStarter instance for single use.

Parameters
ParamsReference to a parameter class whose object link parameters are to be moved into a ready state

Definition at line 1595 of file Object.h.

Member Function Documentation

◆ operator()()

bool DynExp::ParamsBase::LinkParamStarter::operator() ( )

Performs the initialization stepwise. This functions is to be called as long as it returns true. It returns after every step to allow doing other work in the meantime (e.g. updating the UI).

Returns
Returns true if EnsureReadyState() of every item in Params' ObjectLinkParams vector has been called, otherwise false.

Definition at line 179 of file Object.cpp.

Member Data Documentation

◆ CurrentParam

ParamsBase::ObjectLinkParamsType::const_iterator DynExp::ParamsBase::LinkParamStarter::CurrentParam
private

Iterator to the parameter which is currently being made ready.

Definition at line 1607 of file Object.h.

◆ EnsureReadyStateCalledForCurrentParam

bool DynExp::ParamsBase::LinkParamStarter::EnsureReadyStateCalledForCurrentParam
private

Waiting for the current parameter to become ready or moving on to the next parameter?

Definition at line 1608 of file Object.h.

◆ Params

const ParamsBase& DynExp::ParamsBase::LinkParamStarter::Params
private

Reference to a parameter class whose object link parameters have to be ready.

Definition at line 1606 of file Object.h.


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