#include <salutilities.h>

Public Member Functions
	RampSmoother (const Sample initial_value, const Time sampling_frequency) noexcept

Sample	GetNextValue () noexcept

Sample	GetNextValue (const Int num_jumps) noexcept

void	GetNextValuesMultiply (const Sample input_data, const Int num_samples, Sample output_data) noexcept

void	GetNextValuesMultiplyAdd (const Sample input_data, const Int num_samples, Sample input_output_data) noexcept

void	PredictNextValuesAndMultiply (const Sample input_data, const Int num_samples, Sample output_data) const noexcept

Sample	target_value () const noexcept

void	SetTargetValue (const Sample target_value, const Time ramp_time) noexcept

bool	IsUpdating () const noexcept

Constructor & Destructor Documentation

sal::RampSmoother::RampSmoother	(	const Sample	initial_value,
		const Time	sampling_frequency
	)

inlinenoexcept

Parameters

[in] initial_value The initial assigned value.

Member Function Documentation

Sample sal::RampSmoother::GetNextValue ( )

inlinenoexcept

Sample sal::RampSmoother::GetNextValue ( const Int num_jumps )

inlinenoexcept

void sal::RampSmoother::GetNextValuesMultiply	(	const Sample *	input_data,
		const Int	num_samples,
		Sample *	output_data
	)

inlinenoexcept

Takes an array of values (input_data), multiplies them by the next values coming out of the smoother, and writes the result into an output array (output_data).

Parameters

[in]	input_data	The input data.
[in]	num_samples	The number of samples.
[out]	output_data	The output array (data already there will be overwritten.

void sal::RampSmoother::GetNextValuesMultiplyAdd	(	const Sample *	input_data,
		const Int	num_samples,
		Sample *	input_output_data
	)

inlinenoexcept

Takes an array of values (input_data), multiplies them by the next values coming out of the smoother, and adds the result to an input-output array (input_output_data).

Parameters

[in]	input_data	The input data to multiply by.
[in]	num_samples	The number of samples to be handled.
[in,out]	input_output_data	The data onto which we will add the result of the multiplication.

bool sal::RampSmoother::IsUpdating ( ) const

inlinenoexcept

void sal::RampSmoother::PredictNextValuesAndMultiply	(	const Sample *	input_data,
		const Int	num_samples,
		Sample *	output_data
	)		const

inlinenoexcept

Does the same as GetNextValuesAndMultiply, but without modifying the object.

void sal::RampSmoother::SetTargetValue	(	const Sample	target_value,
		const Time	ramp_time
	)

inlinenoexcept

Sample sal::RampSmoother::target_value ( ) const

inlinenoexcept

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

sal/include/salutilities.h

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation