DynExp
Highly flexible laboratory automation for dynamically changing experiments.
DynExpInstr::PyDataStreamInstrument Class Reference

Python mapping of a DynExpInstr::DataStreamInstrument's DynExpInstr::DataStreamBase instance. More...

Public Member Functions

size_t CalcLastConsumedSampleID (size_t NumConsumedSamples)
 Allows to calculate the ID of the last consumed sample based on the amount of samples consumed from the stream. More...
 

Static Public Member Functions

static void import ()
 Make the Python interpreter import this module as PyModuleDataStreamInstrument. GIL has to be acquired before. More...
 

Public Attributes

bool IsTimeUsed {}
 Contains the result of DynExpInstr::DataStreamBase::IsBasicSampleTimeUsed(). More...
 
DataStreamInstrumentData::UnitType ValueUnit {DataStreamInstrumentData::UnitType::Arbitrary}
 Refer to DynExpInstr::DataStreamInstrumentData::UnitType. More...
 
size_t StreamSizeRead {}
 Contains the result of DynExpInstr::DataStreamBase::GetStreamSizeRead(). More...
 
size_t StreamSizeWrite {}
 Contains the result of DynExpInstr::DataStreamBase::GetStreamSizeWrite(). More...
 
size_t NumSamplesWritten {}
 Contains the result of DynExpInstr::DataStreamBase::GetNumSamplesWritten(). More...
 
DataStreamBase::BasicSampleListType Samples
 Samples of the data stream instrument. More...
 

Detailed Description

Python mapping of a DynExpInstr::DataStreamInstrument's DynExpInstr::DataStreamBase instance.

Definition at line 19 of file PyModules.h.

Member Function Documentation

◆ CalcLastConsumedSampleID()

size_t DynExpInstr::PyDataStreamInstrument::CalcLastConsumedSampleID ( size_t  NumConsumedSamples)

Allows to calculate the ID of the last consumed sample based on the amount of samples consumed from the stream.

Parameters
NumConsumedSamplesNumber of samples consumed from Samples
Returns
ID of the last consumed sample

Definition at line 54 of file PyModules.cpp.

◆ import()

void DynExpInstr::PyDataStreamInstrument::import ( )
static

Make the Python interpreter import this module as PyModuleDataStreamInstrument. GIL has to be acquired before.

Definition at line 49 of file PyModules.cpp.

Member Data Documentation

◆ IsTimeUsed

bool DynExpInstr::PyDataStreamInstrument::IsTimeUsed {}

Contains the result of DynExpInstr::DataStreamBase::IsBasicSampleTimeUsed().

Definition at line 38 of file PyModules.h.

◆ NumSamplesWritten

size_t DynExpInstr::PyDataStreamInstrument::NumSamplesWritten {}

Contains the result of DynExpInstr::DataStreamBase::GetNumSamplesWritten().

Definition at line 58 of file PyModules.h.

◆ Samples

DataStreamBase::BasicSampleListType DynExpInstr::PyDataStreamInstrument::Samples

Samples of the data stream instrument.

Definition at line 63 of file PyModules.h.

◆ StreamSizeRead

size_t DynExpInstr::PyDataStreamInstrument::StreamSizeRead {}

Contains the result of DynExpInstr::DataStreamBase::GetStreamSizeRead().

Definition at line 48 of file PyModules.h.

◆ StreamSizeWrite

size_t DynExpInstr::PyDataStreamInstrument::StreamSizeWrite {}

Contains the result of DynExpInstr::DataStreamBase::GetStreamSizeWrite().

Definition at line 53 of file PyModules.h.

◆ ValueUnit

Refer to DynExpInstr::DataStreamInstrumentData::UnitType.

Definition at line 43 of file PyModules.h.


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