Type describing sweep parameters for a waveform. More...

#include <FunctionGenerator.h>

Public Types
enum class	SweepType { Disabled , Amplitude , Frequency }
	Type to determine the sweep type. More...

Public Member Functions
	SweepDescType () noexcept=default

	SweepDescType (SweepType Type, double Min, double Max, double ValueDiffPerSample, double TimeDiffPerSample_ms, bool Retrace) noexcept
	Constructs a `SweepDescType` instance.

Public Attributes
SweepType	Type = SweepType::Disabled
	Type of the sweep.

double	Min {}
	Minimal value where the sweep starts.

double	Max {}
	Maximal value where the sweep ends.

double	ValueDiffPerSample {}
	Value difference in between subsequent samples of the sweep.

double	TimeDiffPerSample_ms {}
	Time per sweep sample in milliseconds.

bool	Retrace {}
	If true, retraces the sweep going back to its start value after its end has been reached.

Detailed Description

Type describing sweep parameters for a waveform.

Definition at line 247 of file FunctionGenerator.h.

Member Enumeration Documentation

◆ SweepType

enum class DynExpInstr::FunctionGeneratorDefs::SweepDescType::SweepType

strong

Type to determine the sweep type.

Enumerator
Disabled	Sweep functionality disabled.
Amplitude	Sweep the waveform's amplitude.
Frequency	Sweep the waveform's frequency.

Definition at line 252 of file FunctionGenerator.h.

Constructor & Destructor Documentation

◆ SweepDescType() [1/2]

DynExpInstr::FunctionGeneratorDefs::SweepDescType::SweepDescType ( )

defaultnoexcept

◆ SweepDescType() [2/2]

DynExpInstr::FunctionGeneratorDefs::SweepDescType::SweepDescType	(	SweepType	Type,
		double	Min,
		double	Max,
		double	ValueDiffPerSample,
		double	TimeDiffPerSample_ms,
		bool	Retrace
	)

inlinenoexcept

Constructs a SweepDescType instance.

Parameters

Type	Type of the sweep.
Min	Minimal value where the sweep starts.
Max	Maximal value where the sweep ends.
ValueDiffPerSample	Value difference in between subsequent samples of the sweep.
TimeDiffPerSample_ms	Time per sweep sample in milliseconds.
Retrace	If true, retraces the sweep going back to its start value after its end has been reached.

Definition at line 269 of file FunctionGenerator.h.

Member Data Documentation

◆ Max

double DynExpInstr::FunctionGeneratorDefs::SweepDescType::Max {}

Maximal value where the sweep ends.

Definition at line 274 of file FunctionGenerator.h.

◆ Min

double DynExpInstr::FunctionGeneratorDefs::SweepDescType::Min {}

Minimal value where the sweep starts.

Definition at line 273 of file FunctionGenerator.h.

◆ Retrace

bool DynExpInstr::FunctionGeneratorDefs::SweepDescType::Retrace {}

If true, retraces the sweep going back to its start value after its end has been reached.

Definition at line 277 of file FunctionGenerator.h.

◆ TimeDiffPerSample_ms

double DynExpInstr::FunctionGeneratorDefs::SweepDescType::TimeDiffPerSample_ms {}

Time per sweep sample in milliseconds.

Definition at line 276 of file FunctionGenerator.h.

◆ Type

SweepType DynExpInstr::FunctionGeneratorDefs::SweepDescType::Type = SweepType::Disabled

Type of the sweep.

Definition at line 272 of file FunctionGenerator.h.

◆ ValueDiffPerSample

double DynExpInstr::FunctionGeneratorDefs::SweepDescType::ValueDiffPerSample {}

Value difference in between subsequent samples of the sweep.

Definition at line 275 of file FunctionGenerator.h.

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

FunctionGenerator.h

Public Types

Public Member Functions

Public Attributes