Allow exclusive access to some of InstrumentBase's
private methods to the instrument thread InstrumentThreadMain()
.
More...
Allow exclusive access to some of InstrumentBase's
private methods to the instrument thread InstrumentThreadMain()
.
Definition at line 456 of file Instrument.h.
◆ InstrumenThreadOnlyType()
constexpr DynExp::InstrumentBase::InstrumenThreadOnlyType::InstrumenThreadOnlyType |
( |
InstrumentBase & |
Parent | ) |
|
|
inlineconstexprprivatenoexcept |
◆ HandleTask()
bool DynExp::InstrumentBase::InstrumenThreadOnlyType::HandleTask |
( |
InstrumentInstance & |
Instance | ) |
|
|
inlineprivate |
Executes and removes the next pending task from the instrument's task queue.
- Parameters
-
Instance | Handle to the instrument thread's data |
- Returns
- Returns false if task handling (the instrument) should stop, true otherwise.
Definition at line 467 of file Instrument.h.
◆ OnError()
void DynExp::InstrumentBase::InstrumenThreadOnlyType::OnError |
( |
| ) |
|
|
inlineprivate |
Derived classes can perform critical shutdown actions after an error has occurred. Override OnErrorChild()
to adjust behavior.
Definition at line 469 of file Instrument.h.
◆ SetInitialized()
void DynExp::InstrumentBase::InstrumenThreadOnlyType::SetInitialized |
( |
| ) |
|
|
inlineprivate |
◆ UpdateData()
void DynExp::InstrumentBase::InstrumenThreadOnlyType::UpdateData |
( |
| ) |
|
|
inlineprivate |
◆ InstrumentBase
◆ InstrumentThreadMain
Instruments run in their own thread. This is the instrument thread's main function.
- Parameters
-
Instance | Handle to the instrument thread's data related to the instrument running this thread. The instrument thread is expected to let the lifetime of Instance expire upon termination. |
Instrument | Pointer to the instrument running this thread |
- Returns
- Util::DynExpErrorCodes::NoError if the thread terminated without an error, the respective error code otherwise.
Definition at line 8 of file Instrument.cpp.
◆ Parent
InstrumentBase& DynExp::InstrumentBase::InstrumenThreadOnlyType::Parent |
|
private |
The documentation for this class was generated from the following file: