Class base_waveform

• Defined in File base_waveform.hpp

Inheritance Relationships

Derived Types

• public rcppsw::control::constant_waveform (Class constant_waveform)

• public rcppsw::control::null_waveform (Class null_waveform)

• public rcppsw::control::sawtooth_waveform (Class sawtooth_waveform)

• public rcppsw::control::sine_waveform (Class sine_waveform)

• public rcppsw::control::square_waveform (Class square_waveform)

Class Documentation

class base_waveform

Base class for all types of waveforms (in the control theory sense). All waveforms have [frequency, phase, amplitude, offset] components.

Subclassed by rcppsw::control::constant_waveform, rcppsw::control::null_waveform, rcppsw::control::sawtooth_waveform, rcppsw::control::sine_waveform, rcppsw::control::square_waveform

Public Functions

inline explicit base_waveform(const struct config::waveform_config *const config)

virtual ~base_waveform(void) = default

inline double amplitude(void) const

Get the amplitude of the waveform.

inline double frequency(void) const

Get the frequency of the waveform.

inline double offset(void) const

Get the offset of the waveform.

inline const math::radians &phase(void) const

Get the phase of the waveform in radians.

virtual double value(double time) = 0

Get the current value of the waveform at time t.