Skip to main content

MultiOtg

Struct MultiOtg 

Source
pub struct MultiOtg<const N: usize> { /* private fields */ }
Expand description

N Otgs with the same limits, stepped together, optionally synchronised so that all axes arrive at their targets at the same time (the faster axes are slowed down).

Implementations§

Source§

impl<const N: usize> MultiOtg<N>

Source

pub fn new( position: [f64; N], limits: OtgLimits, synchronize: bool, ) -> FrankaResult<Self>

A generator at rest at position, whose target is position.

§Errors

FrankaError::InvalidArgument if a coordinate is not finite or a limit is not finite and positive.

Source

pub fn with_limits( position: [f64; N], limits: [OtgLimits; N], synchronize: bool, ) -> FrankaResult<Self>

MultiOtg::new with limits of its own for every axis, which is what seven joints with seven different envelopes need.

§Errors

FrankaError::InvalidArgument if a coordinate is not finite or a limit is not finite and positive.

Source

pub fn set_target(&mut self, target: [f64; N]) -> FrankaResult<()>

Sets the target position; the next step re-plans towards it.

§Errors

FrankaError::InvalidArgument, with the target unchanged, if a coordinate is not finite.

Source

pub fn step(&mut self, dt: f64) -> [f64; N]

Advances every axis by dt seconds and returns the new position. A dt that is not positive and finite leaves the state untouched.

Source

pub fn position(&self) -> [f64; N]

The current position.

Source

pub fn axes(&self) -> &[Otg; N]

The per-axis generators, for their velocities, accelerations and targets.

Source

pub fn set_position(&mut self, position: [f64; N]) -> FrankaResult<()>

Re-anchors every axis on the position actually commanded; see Otg::set_position.

§Errors

FrankaError::InvalidArgument, with the state unchanged, if a coordinate is not finite.

Source

pub fn set_state( &mut self, p: [f64; N], v: [f64; N], a: [f64; N], ) -> FrankaResult<()>

Sets every axis’s state; see Otg::set_state for what the velocity and acceleration must be.

§Errors

FrankaError::InvalidArgument, with the state unchanged, if a value is not finite.

Source

pub fn reset(&mut self, position: [f64; N])

Puts every axis at rest at position, with the target there too.

Trait Implementations§

Source§

impl<const N: usize> Clone for MultiOtg<N>

Source§

fn clone(&self) -> MultiOtg<N>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<const N: usize> Copy for MultiOtg<N>

Source§

impl<const N: usize> Debug for MultiOtg<N>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<const N: usize> Freeze for MultiOtg<N>

§

impl<const N: usize> RefUnwindSafe for MultiOtg<N>

§

impl<const N: usize> Send for MultiOtg<N>

§

impl<const N: usize> Sync for MultiOtg<N>

§

impl<const N: usize> Unpin for MultiOtg<N>

§

impl<const N: usize> UnsafeUnpin for MultiOtg<N>

§

impl<const N: usize> UnwindSafe for MultiOtg<N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.