DynExpInstr::FunctionGeneratorDefs::SineFunctionDescType Struct Reference

Type describing a sine function. More...

#include <FunctionGenerator.h>

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.
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.

Public Attributes
double	PhaseInRad {}
	Phase of the function in radians.
Public Attributes inherited from DynExpInstr::FunctionGeneratorDefs::FunctionDescType
double	FrequencyInHz {}
	Frequency of the function in Hz.
double	Amplitude {}
	Amplitude of the function.
double	Offset {}
	Offset of the function to be added to each sample.

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

FrequencyInHz	Frequency of the function in Hz.
Amplitude	Amplitude of the function.
Offset	Offset of the function to be added to each sample.
PhaseInRad	Phase 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:

• FunctionGenerator.h