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

Input data type passed to on_step() and event handler Python functions. More...

#include <StreamManipulator.h>

Public Member Functions

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

Public Attributes

DynExp::ItemIDType ModuleID { DynExp::ItemIDNotSet }
 ID of the module invoking the on_step() or an event handler Python function for stream manipulation.
 
std::chrono::time_point< std::chrono::system_clock > LastExecutionTime {}
 Time point when the on_step() Python function was invoked last.
 
PyStreamListType InputStreams
 Vector of data stream instruments with input samples to be manipulated.
 
PyStreamListType OutputStreams
 Vector of data stream instruments to write the resulting output samples to.
 
std::string SaveFilename
 Filename and path where the Python functions invoked by the StreamManipulator module can save data. The value is set by the the DynExpModule::SetFilenameEvent event.
 

Detailed Description

Input data type passed to on_step() and event handler Python functions.

Definition at line 30 of file StreamManipulator.h.

Member Function Documentation

◆ Reset()

void DynExpModule::PyStreamManipulatorInputData::Reset ( )

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

Definition at line 33 of file StreamManipulator.cpp.

Member Data Documentation

◆ InputStreams

PyStreamListType DynExpModule::PyStreamManipulatorInputData::InputStreams

Vector of data stream instruments with input samples to be manipulated.

Definition at line 46 of file StreamManipulator.h.

◆ LastExecutionTime

std::chrono::time_point<std::chrono::system_clock> DynExpModule::PyStreamManipulatorInputData::LastExecutionTime {}

Time point when the on_step() Python function was invoked last.

Definition at line 41 of file StreamManipulator.h.

◆ ModuleID

DynExp::ItemIDType DynExpModule::PyStreamManipulatorInputData::ModuleID { DynExp::ItemIDNotSet }

ID of the module invoking the on_step() or an event handler Python function for stream manipulation.

Definition at line 36 of file StreamManipulator.h.

◆ OutputStreams

PyStreamListType DynExpModule::PyStreamManipulatorInputData::OutputStreams

Vector of data stream instruments to write the resulting output samples to.

Definition at line 51 of file StreamManipulator.h.

◆ SaveFilename

std::string DynExpModule::PyStreamManipulatorInputData::SaveFilename

Filename and path where the Python functions invoked by the StreamManipulator module can save data. The value is set by the the DynExpModule::SetFilenameEvent event.

Definition at line 57 of file StreamManipulator.h.


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