REDAC HybridController
Firmware for LUCIDAC/REDAC Teensy
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
platform::interfaces::FrontPlaneSignalGeneratorHAL_Common Class Referenceabstract

#include <signal_generator.h>

Inheritance diagram for platform::interfaces::FrontPlaneSignalGeneratorHAL_Common:
Inheritance graph
[legend]
Collaboration diagram for platform::interfaces::FrontPlaneSignalGeneratorHAL_Common:
Collaboration graph
[legend]

Public Member Functions

 FrontPlaneSignalGeneratorHAL_Common ()
 SignalGeneratorHAL.
 
virtual UnitResult init ()
 
virtual UnitResult set_parameter (WaveForm form, uint8_t index, Parameter param, float value)
 
virtual float get_parameter (WaveForm form, Parameter param)
 
virtual bool toggle (bool enable, WaveForm form)
 

Protected Types

enum  PINS {
  DAC_AMPLITUDE_CH , DAC_SQUARE_HIGH_CH , DAC_SQUARE_LOW_CH , DAC_OFFSET_CH ,
  DAC_OUT0_CH , DAC_OUT1_CH
}
 

Protected Member Functions

virtual uint8_t get_pin (PINS pin_type)=0
 
virtual UnitResult set_sine_param (Parameter param, float value)=0
 
UnitResult set_square_param (Parameter param, float value)
 
UnitResult set_const_param (Parameter param, uint8_t index, float value)
 
UnitResult write_pin (PINS pin, float value, bool with_levelshift=true)
 

Static Protected Member Functions

static constexpr float _map_dac_levelshift (float x)
 Remapping for the built in levelshift on some dac outputs.
 

Protected Attributes

const char * pin_status_msg [6]
 
const functions::DAC60508 digital_analog_converter
 
functions::AD9834 function_generator
 
UnitResult last_status = UnitResult::ok()
 

Static Protected Attributes

static constexpr uint8_t FUNCTION_GENERATOR_IDX = 2
 
static constexpr uint8_t DAC_IDX = 3
 

Detailed Description

Definition at line 22 of file signal_generator.h.

Member Enumeration Documentation

◆ PINS

enum platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::PINS
protected
Enumerator
DAC_AMPLITUDE_CH 
DAC_SQUARE_HIGH_CH 
DAC_SQUARE_LOW_CH 
DAC_OFFSET_CH 
DAC_OUT0_CH 
DAC_OUT1_CH 

Definition at line 37 of file signal_generator.h.

Constructor & Destructor Documentation

◆ FrontPlaneSignalGeneratorHAL_Common()

platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::FrontPlaneSignalGeneratorHAL_Common ( )

SignalGeneratorHAL.

Definition at line 8 of file signal_generator.cpp.

References DAC_IDX, digital_analog_converter, function_generator, and FUNCTION_GENERATOR_IDX.

Member Function Documentation

◆ _map_dac_levelshift()

static constexpr float platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::_map_dac_levelshift ( float x)
inlinestaticconstexprprotected

Remapping for the built in levelshift on some dac outputs.

Definition at line 72 of file signal_generator.h.

Referenced by write_pin().

◆ get_parameter()

float platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::get_parameter ( WaveForm form,
Parameter param )
virtual

Definition at line 41 of file signal_generator.cpp.

References function_generator.

◆ get_pin()

virtual uint8_t platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::get_pin ( PINS pin_type)
protectedpure virtual

Implemented in platform::interfaces::FrontPlaneSignalgeneratorHAL_V_1_1_X, and platform::interfaces::FrontPlaneSignalgeneratorHAL_V_1_2_X.

Referenced by write_pin().

◆ init()

UnitResult platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::init ( )
virtual

Definition at line 12 of file signal_generator.cpp.

References digital_analog_converter, and function_generator.

◆ set_const_param()

UnitResult platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::set_const_param ( Parameter param,
uint8_t index,
float value )
protected

Definition at line 89 of file signal_generator.cpp.

References DAC_OUT0_CH, DAC_OUT1_CH, index(), and write_pin().

Referenced by set_parameter().

◆ set_parameter()

UnitResult platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::set_parameter ( WaveForm form,
uint8_t index,
Parameter param,
float value )
virtual

Definition at line 21 of file signal_generator.cpp.

References index(), set_const_param(), set_sine_param(), and set_square_param().

◆ set_sine_param()

virtual UnitResult platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::set_sine_param ( Parameter param,
float value )
protectedpure virtual

Implemented in platform::interfaces::FrontPlaneSignalgeneratorHAL_V_1_1_X, and platform::interfaces::FrontPlaneSignalgeneratorHAL_V_1_2_X.

References index().

Referenced by set_parameter().

◆ set_square_param()

UnitResult platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::set_square_param ( Parameter param,
float value )
protected

Definition at line 66 of file signal_generator.cpp.

References DAC_SQUARE_HIGH_CH, DAC_SQUARE_LOW_CH, function_generator, and write_pin().

Referenced by set_parameter().

◆ toggle()

bool platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::toggle ( bool enable,
WaveForm form )
virtual

Definition at line 52 of file signal_generator.cpp.

References function_generator.

◆ write_pin()

UnitResult platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::write_pin ( PINS pin,
float value,
bool with_levelshift = true )
protected

Definition at line 100 of file signal_generator.cpp.

References _map_dac_levelshift(), digital_analog_converter, get_pin(), and pin_status_msg.

Referenced by set_const_param(), platform::interfaces::FrontPlaneSignalgeneratorHAL_V_1_1_X::set_sine_param(), platform::interfaces::FrontPlaneSignalgeneratorHAL_V_1_2_X::set_sine_param(), and set_square_param().

Member Data Documentation

◆ DAC_IDX

uint8_t platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::DAC_IDX = 3
staticconstexprprotected

Definition at line 65 of file signal_generator.h.

Referenced by FrontPlaneSignalGeneratorHAL_Common().

◆ digital_analog_converter

const functions::DAC60508 platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::digital_analog_converter
protected

Definition at line 67 of file signal_generator.h.

Referenced by FrontPlaneSignalGeneratorHAL_Common(), init(), and write_pin().

◆ function_generator

functions::AD9834 platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::function_generator
protected

Definition at line 68 of file signal_generator.h.

Referenced by FrontPlaneSignalGeneratorHAL_Common(), get_parameter(), init(), platform::interfaces::FrontPlaneSignalgeneratorHAL_V_1_1_X::set_sine_param(), platform::interfaces::FrontPlaneSignalgeneratorHAL_V_1_2_X::set_sine_param(), set_square_param(), and toggle().

◆ FUNCTION_GENERATOR_IDX

uint8_t platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::FUNCTION_GENERATOR_IDX = 2
staticconstexprprotected

Definition at line 64 of file signal_generator.h.

Referenced by FrontPlaneSignalGeneratorHAL_Common().

◆ last_status

UnitResult platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::last_status = UnitResult::ok()
protected

Definition at line 69 of file signal_generator.h.

◆ pin_status_msg

const char* platform::interfaces::FrontPlaneSignalGeneratorHAL_Common::pin_status_msg[6]
protected
Initial value:
= {
"FP DAC",
"FP DSLC",
"FP DSHC",
"FP DOC",
"FP DO0C",
"FP DO1C"
}

Definition at line 54 of file signal_generator.h.

Referenced by write_pin().

The documentation for this class was generated from the following files: