Struct accel_stepper::CummulativeSteps

pub struct CummulativeSteps { /* fields omitted */ }

A helper type for determining the number of steps to take when moving a distance in the real world, taking rounding errors into consideration.

Methods

impl CummulativeSteps

pub const fn new(steps_per_unit: f32) -> CummulativeSteps

Create a new CummulativeSteps which will use the provided ratio as the number of steps to take per "real" unit.

pub const fn real_location(&self) -> f32

The current location in "real" units.

pub const fn steps_per_unit(&self) -> f32

Get the number of steps travelled per "real" unit.

pub const fn with_steps_per_unit(&self, steps_per_unit: f32) -> CummulativeSteps

pub fn move_by(&mut self, delta: f32) -> i64

Execute a relative movement, retrieving the number of steps to take.

Trait Implementations

impl PartialEq<CummulativeSteps> for CummulativeSteps

fn eq(&self, other: &CummulativeSteps) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CummulativeSteps) -> bool

This method tests for !=.

impl Clone for CummulativeSteps

fn clone(&self) -> CummulativeSteps

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CummulativeSteps

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.