Skip to main content

Otg

Struct Otg 

Source
pub struct Otg { /* private fields */ }
Expand description

A single-axis online trajectory generator; see the module documentation.

Implementations§

Source§

impl Otg

Source

pub fn new(position: f64, limits: OtgLimits) -> FrankaResult<Self>

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

§Errors

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

Source

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

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

§Errors

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

Source

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

Re-anchors the generator on the position actually commanded – the robot’s echo of the last command – keeping its own velocity, acceleration and target, so that whatever runs behind it can shape one command but never build up a lag it plans against.

§Errors

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

Source

pub fn set_state( &mut self, position: f64, velocity: f64, acceleration: f64, ) -> FrankaResult<()>

Sets the whole state; the target is kept. The velocity and acceleration are clamped into the limits. They must be the state at the end of the last cycle, as this generator’s are: a finite difference such as the robot’s O_dP_EE_c is the mean over the cycle, half an acceleration step behind, and re-anchoring on that every cycle throttles the plan to a crawl – use set_position with an echo.

§Errors

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

Source

pub fn reset(&mut self, position: f64)

Puts the generator at rest at position, with the target there too.

Source

pub fn step(&mut self, dt: f64) -> f64

Advances the state by dt seconds along the re-planned profile and returns the new position. A dt that is not positive and finite leaves the state untouched.

Source

pub fn position(&self) -> f64

The current position.

Source

pub fn velocity(&self) -> f64

The current velocity.

Source

pub fn acceleration(&self) -> f64

The current acceleration.

Source

pub fn target(&self) -> f64

The current target.

Source

pub fn duration(&self) -> f64

The duration of the time-optimal profile from the current state to rest at the target; zero when at rest there.

Trait Implementations§

Source§

impl Clone for Otg

Source§

fn clone(&self) -> Otg

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 Copy for Otg

Source§

impl Debug for Otg

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Otg

§

impl RefUnwindSafe for Otg

§

impl Send for Otg

§

impl Sync for Otg

§

impl Unpin for Otg

§

impl UnsafeUnpin for Otg

§

impl UnwindSafe for Otg

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.