Struct sensulator::Sensulator
source · pub struct Sensulator<'a, T: RngCore> { /* private fields */ }
Implementations§
source§impl<T: RngCore> Sensulator<'_, T>
impl<T: RngCore> Sensulator<'_, T>
sourcepub fn new(
ctr_val: MeasureVal,
abs_err_range: MeasureVal,
rel_err: MeasureVal,
rng: &mut T
) -> Sensulator<'_, T>
pub fn new(
ctr_val: MeasureVal,
abs_err_range: MeasureVal,
rel_err: MeasureVal,
rng: &mut T
) -> Sensulator<'_, T>
Initialize an instance with
ctr_vl
: The value that an ideal sensor would measure on every measurement.abs_err_range
: The accuracy of the sensor.rel_err
: The precision of the sensor.rng
: A random number generator to be used for simulation
sourcepub fn set_absolute_error_range(&mut self, err_range: MeasureVal)
pub fn set_absolute_error_range(&mut self, err_range: MeasureVal)
Set the range of absolute error: the accuracy of the sensor.
sourcepub fn set_absolute_error_offset(&mut self, err_offset: MeasureVal)
pub fn set_absolute_error_offset(&mut self, err_offset: MeasureVal)
Set the concrete offset of the simulator’s “sensed” measurement from the actual value.
Generally you should prefer set_absolute_error_range
instead
sourcepub fn set_relative_error(&mut self, rel_err: MeasureVal)
pub fn set_relative_error(&mut self, rel_err: MeasureVal)
Set the sensor simulator’s relative error: the precision of the sensor.
sourcepub fn set_center_value(&mut self, val: MeasureVal)
pub fn set_center_value(&mut self, val: MeasureVal)
Set the sensor simulator’s “ideal” value. This will be adjusted by absolute and relative errors to provide simulated measurement noise.
sourcepub fn measure(&mut self) -> MeasureVal
pub fn measure(&mut self) -> MeasureVal
Take a new measurement. This method updates the measured value.
sourcepub fn peek(&self) -> MeasureVal
pub fn peek(&self) -> MeasureVal
Peek at the last measured value. This does not update the measured value.