Bundles parameters to describe a data stream's stream size. More...

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

Public Member Functions
	StreamSizeParamsExtension (DynExp::ParamsBase &Owner, ParamsConfigDialog::NumberType DefaultValue=DefaultStreamSize, ParamsConfigDialog::NumberType MinValue=1, ParamsConfigDialog::NumberType MaxValue=static_cast< double >(std::numeric_limits< size_t >::max()))
	Constructs a `StreamSizeParamsExtension` 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...

Public Attributes
DynExp::ParamsBase::Param< ParamsConfigDialog::NumberType >	StreamSize
	Stream size of the related `DataStreamInstrument` instance's sample stream in samples. More...

Static Private Attributes
static constexpr ParamsConfigDialog::NumberType	DefaultStreamSize = 1000
	Default stream size in samples. More...

Detailed Description

Bundles parameters to describe a data stream's stream size.

Definition at line 666 of file DataStreamInstrument.h.

Class Documentation

◆ DynExpInstr::StreamSizeParamsExtension::ValueType

struct DynExpInstr::StreamSizeParamsExtension::ValueType

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

Definition at line 675 of file DataStreamInstrument.h.

Class Members
NumberType	StreamSize	Stream size of the related `DataStreamInstrument` instance's sample stream in samples.

Constructor & Destructor Documentation

◆ StreamSizeParamsExtension()

DynExpInstr::StreamSizeParamsExtension::StreamSizeParamsExtension	(	DynExp::ParamsBase &	Owner,
		ParamsConfigDialog::NumberType	DefaultValue = `DefaultStreamSize`,
		ParamsConfigDialog::NumberType	MinValue = `1`,
		ParamsConfigDialog::NumberType	MaxValue = `static_cast<double>(std::numeric_limits<size_t>::max())`
	)

inline

Constructs a StreamSizeParamsExtension instance.

Parameters

Owner	Parameter class owning the parameters bundled by this instance.
DefaultValue	Default value of StreamSize
MinValue	Minimal value of StreamSize
MaxValue	Maximal value of StreamSize

Definition at line 687 of file DataStreamInstrument.h.

Member Function Documentation

◆ DisableUserEditable()

void DynExpInstr::StreamSizeParamsExtension::DisableUserEditable ( )

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

Definition at line 65 of file DataStreamInstrument.cpp.

◆ Values()

ValueType DynExpInstr::StreamSizeParamsExtension::Values ( ) const

inline

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

Returns: Bundled parameters' current values

Definition at line 704 of file DataStreamInstrument.h.

Member Data Documentation

◆ DefaultStreamSize

constexpr ParamsConfigDialog::NumberType DynExpInstr::StreamSizeParamsExtension::DefaultStreamSize = 1000

staticconstexprprivate

Default stream size in samples.

Definition at line 668 of file DataStreamInstrument.h.

◆ StreamSize

DynExp::ParamsBase::Param<ParamsConfigDialog::NumberType> DynExpInstr::StreamSizeParamsExtension::StreamSize

Stream size of the related DataStreamInstrument instance's sample stream in samples.

Definition at line 710 of file DataStreamInstrument.h.

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

Classes

Public Member Functions

Public Attributes

Static Private Attributes