DynExpInstr::FunctionGeneratorDefs::RampFunctionDescType Struct Reference

Type describing a ramp function. More...

#include <FunctionGenerator.h>

Inheritance diagram for DynExpInstr::FunctionGeneratorDefs::RampFunctionDescType:

Public Member Functions
constexpr	RampFunctionDescType () noexcept=default
constexpr	RampFunctionDescType (double FrequencyInHz, double Amplitude, double Offset, double PhaseInRad, double RiseFallRatio) noexcept
	Constructs a RampFunctionDescType 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	RiseFallRatio {}
	Ratio between the ramp's falling and rising edge lengths (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 ramp function.

Definition at line 100 of file FunctionGenerator.h.

Constructor & Destructor Documentation

RampFunctionDescType() [1/2]

constexpr DynExpInstr::FunctionGeneratorDefs::RampFunctionDescType::RampFunctionDescType ( )

constexprdefaultnoexcept

RampFunctionDescType() [2/2]

constexpr DynExpInstr::FunctionGeneratorDefs::RampFunctionDescType::RampFunctionDescType ( double  FrequencyInHz, double  Amplitude, double  Offset, double  PhaseInRad, double  RiseFallRatio  )

inlineconstexprnoexcept

Constructs a RampFunctionDescType 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.
RiseFallRatio	Ratio between the ramp's falling and rising edge lengths (in between 0 and 1)

Definition at line 112 of file FunctionGenerator.h.

Member Data Documentation

PhaseInRad

double DynExpInstr::FunctionGeneratorDefs::RampFunctionDescType::PhaseInRad {}

Phase of the function in radians.

Definition at line 115 of file FunctionGenerator.h.

RiseFallRatio

double DynExpInstr::FunctionGeneratorDefs::RampFunctionDescType::RiseFallRatio {}

Ratio between the ramp's falling and rising edge lengths (in between 0 and 1)

Definition at line 116 of file FunctionGenerator.h.

---

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

• FunctionGenerator.h