Skip to main content

PidState

Struct PidState 

Source
pub struct PidState {
    pub integral: i32,
    pub derivative: i32,
    /* private fields */
}
Expand description

C-layout PID memory, with reset marking the next measurement as the derivative origin.

Fields§

§integral: i32

Current bounded integral.

§derivative: i32

Current bounded filtered derivative on measurement.

Implementations§

Source§

impl PidState

Source

pub fn reset(&mut self)

Clear all memory and establish a zero-derivative first sample.

Source

pub fn step( &mut self, coefficients: &Coefficients, cycle: u32, reference: i32, position: i32, ) -> Result<Command, InvalidCoefficients>

Update a conditional-integration PID with derivative on measurement.

The prior integral is used to detect output saturation. If saturation and error have the same direction, retain that integral; otherwise accept the proposed integral before computing the command. First-sample derivative is zero. Invalid coefficients leave state unchanged. Gains remain stable until reset.

Trait Implementations§

Source§

impl Clone for PidState

Source§

fn clone(&self) -> PidState

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 PidState

Source§

impl Debug for PidState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PidState

Source§

fn default() -> PidState

Returns the “default value” for a type. Read more
Source§

impl Eq for PidState

Source§

impl PartialEq for PidState

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PidState

Auto Trait Implementations§

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
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.

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.