PositionDerivativeDependentPIDKValues

Struct PositionDerivativeDependentPIDKValues 

Source
pub struct PositionDerivativeDependentPIDKValues {
    pub position: PIDKValues,
    pub velocity: PIDKValues,
    pub acceleration: PIDKValues,
}
Expand description

A set of PID k-values for controlling each position derivative.

Fields§

§position: PIDKValues

Use these k-values when controlling position.

§velocity: PIDKValues

Use these k-values when controlling velocity.

§acceleration: PIDKValues

Use these k-values when controlling acceleration.

Implementations§

Source§

impl PositionDerivativeDependentPIDKValues

Source

pub const fn new( position: PIDKValues, velocity: PIDKValues, acceleration: PIDKValues, ) -> Self

Examples found in repository?
examples/devices.rs (lines 8-12)
8const K_VALUES: PositionDerivativeDependentPIDKValues = PositionDerivativeDependentPIDKValues::new(
9    PIDKValues::new(1.0, 0.01, 0.1),
10    PIDKValues::new(1.0, 0.01, 0.1),
11    PIDKValues::new(1.0, 0.01, 0.1),
12);
Source

pub fn get_k_values( &self, position_derivative: PositionDerivative, ) -> PIDKValues

Get the k-values for a specific position derivative.

Examples found in repository?
examples/devices.rs (line 71)
67fn main() {
68    println!("Commanding Motor to {:?}", COMMAND);
69    println!(
70        "K values are {:?}",
71        K_VALUES.get_k_values(PositionDerivative::from(COMMAND))
72    );
73    let motor = Motor::new();
74    let mut motor_wrapper =
75        devices::wrappers::PIDWrapper::new(motor, Time(0), STATE, COMMAND, K_VALUES);
76    let encoder = Encoder::default();
77    let mut encoder_wrapper = devices::wrappers::GetterStateDeviceWrapper::new(encoder);
78    connect(motor_wrapper.get_terminal(), encoder_wrapper.get_terminal());
79    for _ in 0..5 {
80        motor_wrapper.update().unwrap();
81        encoder_wrapper.update().unwrap();
82    }
83}
Source

pub fn evaluate( &self, position_derivative: PositionDerivative, error: f32, error_integral: f32, error_derivative: f32, ) -> f32

Calculate the control variable using the coefficients for a given position derivative given error, its integral, and its derivative.

Trait Implementations§

Source§

impl Clone for PositionDerivativeDependentPIDKValues

Source§

fn clone(&self) -> PositionDerivativeDependentPIDKValues

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PositionDerivativeDependentPIDKValues

Source§

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

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

impl PartialEq for PositionDerivativeDependentPIDKValues

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for PositionDerivativeDependentPIDKValues

Source§

impl StructuralPartialEq for PositionDerivativeDependentPIDKValues

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