DynExp
Highly flexible laboratory automation for dynamically changing experiments.
Loading...
Searching...
No Matches
DynExpModule::PyStreamManipulatorOutputData Struct Reference

Output data type returned from on_step() or event handler Python functions. More...

#include <StreamManipulator.h>

Public Member Functions

void Reset ()
 Resets all member variables of this PyStreamManipulatorOutputData instance back to their default values.
 

Public Attributes

std::chrono::milliseconds MinNextExecutionDelay {}
 Time wo wait minimally before the on_step() Python function is called again when each input data stream has received new samples.
 
std::chrono::milliseconds MaxNextExecutionDelay {}
 Time to wait maximally before the on_step() Python function is called again when the input data streams have not received new samples each.
 
std::vector< size_t > LastConsumedSampleIDsPerInputStream
 Maintaining the order of input data streams in PyStreamManipulatorInputData::InputStreams as passed to the on_step() or event handler Python functions, this list contains the sample ID that has been consumed for each input data stream. These samples won't be passed to on_step() or event handler Python functions in its next call.
 

Detailed Description

Output data type returned from on_step() or event handler Python functions.

Definition at line 69 of file StreamManipulator.h.

Member Function Documentation

◆ Reset()

void DynExpModule::PyStreamManipulatorOutputData::Reset ( )

Resets all member variables of this PyStreamManipulatorOutputData instance back to their default values.

Definition at line 44 of file StreamManipulator.cpp.

Member Data Documentation

◆ LastConsumedSampleIDsPerInputStream

std::vector<size_t> DynExpModule::PyStreamManipulatorOutputData::LastConsumedSampleIDsPerInputStream

Maintaining the order of input data streams in PyStreamManipulatorInputData::InputStreams as passed to the on_step() or event handler Python functions, this list contains the sample ID that has been consumed for each input data stream. These samples won't be passed to on_step() or event handler Python functions in its next call.

Definition at line 90 of file StreamManipulator.h.

◆ MaxNextExecutionDelay

std::chrono::milliseconds DynExpModule::PyStreamManipulatorOutputData::MaxNextExecutionDelay {}

Time to wait maximally before the on_step() Python function is called again when the input data streams have not received new samples each.

Definition at line 81 of file StreamManipulator.h.

◆ MinNextExecutionDelay

std::chrono::milliseconds DynExpModule::PyStreamManipulatorOutputData::MinNextExecutionDelay {}

Time wo wait minimally before the on_step() Python function is called again when each input data stream has received new samples.

Definition at line 75 of file StreamManipulator.h.


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