Bundles parameters to describe a NumericSampleStream's sampling properties. More...

Classes
struct	ValueType
	Type containing the values of all the parameters belonging to `NumericSampleStreamParamsExtension`. More...

Public Types
enum	SamplingModeType { Single , Continuous }
	Type to determine how to record/play back to/from the stream. More...

Public Member Functions
	NumericSampleStreamParamsExtension (DynExp::ParamsBase &Owner)
	Constructs a `NumericSampleStreamParamsExtension` instance. More...

void	DisableUserEditable ()
	Calls DynExp::ParamsBase::DisableUserEditable() on all bundled parameters. More...

ValueType	Values () const
	Creates and returns a `ValueType` instance containing the bundled parameters' values. More...

Static Public Member Functions
static Util::TextValueListType< SamplingModeType >	SamplingModeTypeStrList ()
	Maps description strings to the `SamplingModeType` enum's items. More...

Public Attributes
DynExp::ParamsBase::Param< ParamsConfigDialog::NumberType >	SamplingRate
	Sampling rate of the related `DataStreamInstrument` instance's sample stream in samples per second. More...

DynExp::ParamsBase::Param< SamplingModeType >	SamplingMode
	Sampling mode of the related `DataStreamInstrument` instance's sample stream. Indicates whether reading/writing happens only once or continuously. More...

Static Private Attributes
static constexpr ParamsConfigDialog::NumberType	DefaultSamplingRate = 1
	Default sampling rate in samples/s. More...

static constexpr SamplingModeType	DefaultSamplingMode = SamplingModeType::Single
	Default sampling mode. More...

Detailed Description

Bundles parameters to describe a NumericSampleStream's sampling properties.

Definition at line 716 of file DataStreamInstrument.h.

Class Documentation

◆ DynExpInstr::NumericSampleStreamParamsExtension::ValueType

struct DynExpInstr::NumericSampleStreamParamsExtension::ValueType

Type containing the values of all the parameters belonging to NumericSampleStreamParamsExtension.

Definition at line 742 of file DataStreamInstrument.h.

Class Members
SamplingModeType	SamplingMode	Sampling mode of the related `DataStreamInstrument` instance's sample stream. Indicates whether reading/writing happens only once or continuously.
NumberType	SamplingRate	Sampling rate of the related `DataStreamInstrument` instance's sample stream in samples per second.

Member Enumeration Documentation

◆ SamplingModeType

enum DynExpInstr::NumericSampleStreamParamsExtension::SamplingModeType

Type to determine how to record/play back to/from the stream.

Enumerator
Single	Record/play back to/from the stream only once (until the stream is full or all data has been read).
Continuous	Record/play back to/from the stream continuously.

Definition at line 722 of file DataStreamInstrument.h.

Constructor & Destructor Documentation

◆ NumericSampleStreamParamsExtension()

DynExpInstr::NumericSampleStreamParamsExtension::NumericSampleStreamParamsExtension ( DynExp::ParamsBase & Owner )

inline

Constructs a NumericSampleStreamParamsExtension instance.

Parameters

Owner Parameter class owning the parameters bundled by this instance.

Definition at line 758 of file DataStreamInstrument.h.

Member Function Documentation

◆ DisableUserEditable()

void DynExpInstr::NumericSampleStreamParamsExtension::DisableUserEditable ( )

Calls DynExp::ParamsBase::DisableUserEditable() on all bundled parameters.

Definition at line 80 of file DataStreamInstrument.cpp.

◆ SamplingModeTypeStrList()

Util::TextValueListType< NumericSampleStreamParamsExtension::SamplingModeType > DynExpInstr::NumericSampleStreamParamsExtension::SamplingModeTypeStrList ( )

static

Maps description strings to the SamplingModeType enum's items.

Returns: List containing the description-value mapping

Definition at line 70 of file DataStreamInstrument.cpp.

◆ Values()

ValueType DynExpInstr::NumericSampleStreamParamsExtension::Values ( ) const

inline

Creates and returns a ValueType instance containing the bundled parameters' values.

Returns: Bundled parameters' current values

Definition at line 775 of file DataStreamInstrument.h.

Member Data Documentation

◆ DefaultSamplingMode

constexpr SamplingModeType DynExpInstr::NumericSampleStreamParamsExtension::DefaultSamplingMode = SamplingModeType::Single

staticconstexprprivate

Default sampling mode.

Definition at line 735 of file DataStreamInstrument.h.

◆ DefaultSamplingRate

constexpr ParamsConfigDialog::NumberType DynExpInstr::NumericSampleStreamParamsExtension::DefaultSamplingRate = 1

staticconstexprprivate

Default sampling rate in samples/s.

Definition at line 734 of file DataStreamInstrument.h.

◆ SamplingMode

DynExp::ParamsBase::Param<SamplingModeType> DynExpInstr::NumericSampleStreamParamsExtension::SamplingMode

Sampling mode of the related DataStreamInstrument instance's sample stream. Indicates whether reading/writing happens only once or continuously.

Definition at line 787 of file DataStreamInstrument.h.

◆ SamplingRate

DynExp::ParamsBase::Param<ParamsConfigDialog::NumberType> DynExpInstr::NumericSampleStreamParamsExtension::SamplingRate

Sampling rate of the related DataStreamInstrument instance's sample stream in samples per second.

Definition at line 781 of file DataStreamInstrument.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Attributes