DynExpInstr::FunctionGeneratorDefs::RectFunctionDescType Struct Reference

Type describing a rectangular function. More...

#include <FunctionGenerator.h>

Inheritance diagram for DynExpInstr::FunctionGeneratorDefs::RectFunctionDescType:

Public Member Functions
constexpr	RectFunctionDescType () noexcept=default
constexpr	RectFunctionDescType (double FrequencyInHz, double Amplitude, double Offset, double PhaseInRad, double DutyCycle) noexcept
	Constructs a RectFunctionDescType 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.
double	DutyCycle {}
	Duty cycle of the function (in between 0 and 1)
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 rectangular function.

Definition at line 78 of file FunctionGenerator.h.

Constructor & Destructor Documentation

RectFunctionDescType() [1/2]

constexpr DynExpInstr::FunctionGeneratorDefs::RectFunctionDescType::RectFunctionDescType ( )

constexprdefaultnoexcept

RectFunctionDescType() [2/2]

constexpr DynExpInstr::FunctionGeneratorDefs::RectFunctionDescType::RectFunctionDescType ( double  FrequencyInHz, double  Amplitude, double  Offset, double  PhaseInRad, double  DutyCycle  )

inlineconstexprnoexcept

Constructs a RectFunctionDescType 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.
DutyCycle	Duty cycle of the function (in between 0 and 1)

Definition at line 90 of file FunctionGenerator.h.

Member Data Documentation

DutyCycle

double DynExpInstr::FunctionGeneratorDefs::RectFunctionDescType::DutyCycle {}

Duty cycle of the function (in between 0 and 1)

Definition at line 94 of file FunctionGenerator.h.

PhaseInRad

double DynExpInstr::FunctionGeneratorDefs::RectFunctionDescType::PhaseInRad {}

Phase of the function in radians.

Definition at line 93 of file FunctionGenerator.h.

---

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

• FunctionGenerator.h