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

#include <PyModules.h>

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.

Static Public Member Functions
static void	import ()
	Make the Python interpreter import this module as `PyModuleDataStreamInstrument`. GIL has to be acquired before.

Public Attributes
bool	IsTimeUsed {}
	Contains the result of DynExpInstr::DataStreamBase::IsBasicSampleTimeUsed().

DataStreamInstrumentData::UnitType	ValueUnit {DataStreamInstrumentData::UnitType::Arbitrary}
	Refer to DynExpInstr::DataStreamInstrumentData::UnitType.

size_t	StreamSizeRead {}
	Contains the result of DynExpInstr::DataStreamBase::GetStreamSizeRead().

size_t	StreamSizeWrite {}
	Contains the result of DynExpInstr::DataStreamBase::GetStreamSizeWrite().

size_t	NumSamplesWritten {}
	Contains the result of DynExpInstr::DataStreamBase::GetNumSamplesWritten().

DataStreamBase::BasicSampleListType	Samples
	Samples of the data stream instrument.

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

NumConsumedSamples Number 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

DataStreamInstrumentData::UnitType DynExpInstr::PyDataStreamInstrument::ValueUnit {DataStreamInstrumentData::UnitType::Arbitrary}

Refer to DynExpInstr::DataStreamInstrumentData::UnitType.

Definition at line 43 of file PyModules.h.

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

Public Member Functions

Static Public Member Functions

Public Attributes