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

Type describing a sine function. More...

+ Inheritance diagram for DynExpInstr::FunctionGeneratorDefs::SineFunctionDescType:

Public Member Functions

constexpr SineFunctionDescType () noexcept=default
 
constexpr SineFunctionDescType (double FrequencyInHz, double Amplitude, double Offset, double PhaseInRad) noexcept
 Constructs a SineFunctionDescType instance. More...
 
- Public Member Functions inherited from DynExpInstr::FunctionGeneratorDefs::FunctionDescType
constexpr FunctionDescType () noexcept=default
 
constexpr FunctionDescType (double FrequencyInHz, double Amplitude, double Offset) noexcept
 Constructs a FunctionDescType instance. More...
 

Public Attributes

double PhaseInRad {}
 Phase of the function in radians. More...
 
- Public Attributes inherited from DynExpInstr::FunctionGeneratorDefs::FunctionDescType
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 sine function.

Definition at line 58 of file FunctionGenerator.h.

Constructor & Destructor Documentation

◆ SineFunctionDescType() [1/2]

constexpr DynExpInstr::FunctionGeneratorDefs::SineFunctionDescType::SineFunctionDescType ( )
constexprdefaultnoexcept

◆ SineFunctionDescType() [2/2]

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

Constructs a SineFunctionDescType instance.

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

Definition at line 69 of file FunctionGenerator.h.

Member Data Documentation

◆ PhaseInRad

double DynExpInstr::FunctionGeneratorDefs::SineFunctionDescType::PhaseInRad {}

Phase of the function in radians.

Definition at line 72 of file FunctionGenerator.h.


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