DynExp
Highly flexible laboratory automation for dynamically changing experiments.
DynExpInstr::FunctionGeneratorDefs::FunctionDescType Struct Reference

Type describing a generic periodic function. More...

+ Inheritance diagram for DynExpInstr::FunctionGeneratorDefs::FunctionDescType:

Public Member Functions

constexpr FunctionDescType () noexcept=default
 
constexpr FunctionDescType (double FrequencyInHz, double Amplitude, double Offset) noexcept
 Constructs a FunctionDescType instance. More...
 

Public Attributes

double FrequencyInHz {}
 Frequency of the function in Hz. More...
 
double Amplitude {}
 Amplitude of the function. More...
 
double Offset {}
 Offset of the function to be added to each sample. More...
 

Detailed Description

Type describing a generic periodic function.

Definition at line 37 of file FunctionGenerator.h.

Constructor & Destructor Documentation

◆ FunctionDescType() [1/2]

constexpr DynExpInstr::FunctionGeneratorDefs::FunctionDescType::FunctionDescType ( )
constexprdefaultnoexcept

◆ FunctionDescType() [2/2]

constexpr DynExpInstr::FunctionGeneratorDefs::FunctionDescType::FunctionDescType ( double  FrequencyInHz,
double  Amplitude,
double  Offset 
)
inlineconstexprnoexcept

Constructs a FunctionDescType instance.

Parameters
FrequencyInHzFrequency of the function in Hz.
AmplitudeAmplitude of the function.
OffsetOffset of the function to be added to each sample.

Definition at line 47 of file FunctionGenerator.h.

Member Data Documentation

◆ Amplitude

double DynExpInstr::FunctionGeneratorDefs::FunctionDescType::Amplitude {}

Amplitude of the function.

Definition at line 51 of file FunctionGenerator.h.

◆ FrequencyInHz

double DynExpInstr::FunctionGeneratorDefs::FunctionDescType::FrequencyInHz {}

Frequency of the function in Hz.

Definition at line 50 of file FunctionGenerator.h.

◆ Offset

double DynExpInstr::FunctionGeneratorDefs::FunctionDescType::Offset {}

Offset of the function to be added to each sample.

Definition at line 52 of file FunctionGenerator.h.


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