GainSTM

Struct GainSTM 

Source
pub struct GainSTM<T, C> {
    pub gains: T,
    pub config: C,
    pub option: GainSTMOption,
}
Expand description

Datagram to produce STM by Gain.

Fields§

§gains: T

The sequence of Gains.

§config: C

The STM configuration.

§option: GainSTMOption

The STM option.

Implementations§

Source§

impl<'a, T: GainSTMGenerator<'a>, C> GainSTM<T, C>

Source

pub const fn new(gains: T, config: C, option: GainSTMOption) -> Self

Create a new GainSTM.

Source§

impl<'a, T: GainSTMGenerator<'a>> GainSTM<T, Freq<f32>>

Source

pub fn into_nearest(self) -> GainSTM<T, FreqNearest>

Convert to STM with the closest frequency among the possible frequencies.

Source§

impl<'a, T: GainSTMGenerator<'a>> GainSTM<T, Duration>

Source

pub fn into_nearest(self) -> GainSTM<T, PeriodNearest>

Convert to STM with the closest frequency among the possible period.

Source§

impl<'a, T: GainSTMGenerator<'a>, C: Into<STMConfig> + Copy> GainSTM<T, C>

Source

pub fn sampling_config(&self) -> Result<SamplingConfig, AUTDDriverError>

The sampling configuration of the STM.

Trait Implementations§

Source§

impl<T: Clone, C: Clone> Clone for GainSTM<T, C>

Source§

fn clone(&self) -> GainSTM<T, C>

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<'a, G: GainSTMGenerator<'a>, C: Into<STMConfig> + Debug> DatagramL<'a> for GainSTM<G, C>

Source§

fn option(&self) -> DatagramOption

Returns the option of the datagram.
Source§

impl<T: Debug, C: Debug> Debug for GainSTM<T, C>

Source§

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

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

impl<'a, T: GainSTMGenerator<'a>, C: Into<STMConfig> + Copy + Debug> Inspectable<'a> for GainSTM<T, C>

Source§

type Result = GainSTMInspectionResult

The result of the inspection.
Source§

fn inspect( self, geometry: &'a Geometry, env: &Environment, filter: &DeviceMask, _: &FirmwareLimits, ) -> Result<InspectionResult<<Self as Inspectable<'a>>::Result>, <Self as Datagram<'a>>::Error>

Returns the inspection result.

Auto Trait Implementations§

§

impl<T, C> Freeze for GainSTM<T, C>
where T: Freeze, C: Freeze,

§

impl<T, C> RefUnwindSafe for GainSTM<T, C>

§

impl<T, C> Send for GainSTM<T, C>
where T: Send, C: Send,

§

impl<T, C> Sync for GainSTM<T, C>
where T: Sync, C: Sync,

§

impl<T, C> Unpin for GainSTM<T, C>
where T: Unpin, C: Unpin,

§

impl<T, C> UnwindSafe for GainSTM<T, C>
where T: UnwindSafe, C: UnwindSafe,

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<'a, D> Datagram<'a> for D
where D: DatagramS<'a>,

Source§

type G = <D as DatagramS<'a>>::G

Source§

type Error = <D as DatagramS<'a>>::Error

Source§

fn operation_generator( self, geometry: &'a Geometry, env: &Environment, filter: &DeviceMask, limits: &FirmwareLimits, ) -> Result<<D as Datagram<'a>>::G, <D as Datagram<'a>>::Error>

Source§

fn option(&self) -> DatagramOption

Returns the option of the datagram.
Source§

impl<'a, D> DatagramS<'a> for D
where D: DatagramL<'a>,

Source§

type G = <D as DatagramL<'a>>::G

Source§

type Error = <D as DatagramL<'a>>::Error

Source§

fn operation_generator_with_segment( self, geometry: &'a Geometry, env: &Environment, filter: &DeviceMask, limits: &FirmwareLimits, segment: Segment, transition_params: TransitionModeParams, ) -> Result<<D as DatagramS<'a>>::G, <D as DatagramS<'a>>::Error>

Source§

fn option(&self) -> DatagramOption

Returns the option of the datagram.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

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.