autd3_driver::datagram

Struct GainSTM

Source 
pub struct GainSTM<G: GainSTMGenerator> { /* private fields */ }
Expand description

Datagram to produce STM by Gain.

Implementations§

Source§

impl<G: GainSTMGenerator> GainSTM<G>

Source

pub const fn loop_behavior(&self) -> LoopBehavior

The loop behavior of the STM.

Source

pub const fn sampling_config(&self) -> SamplingConfig

The sampling configuration of the STM.

Source

pub const fn mode(&self) -> GainSTMMode

The mode of the STM. The default is GainSTMMode::PhaseIntensityFull.

Source§

impl<G: GainSTMGenerator> GainSTM<G>

Source

pub const fn with_loop_behavior(self, loop_behavior: LoopBehavior) -> Self

Set the loop_behavior field.

Source

pub const fn with_mode(self, mode: GainSTMMode) -> Self

Set the mode field.

Source§

impl<G: GainSTMGenerator> GainSTM<G>

Source

pub fn new<T: IntoGainSTMGenerator<G = G>>( config: impl Into<STMConfig>, iter: T, ) -> Result<Self, AUTDDriverError>

Creates a new GainSTM.

§Errors

Returns AUTDDriverError::SamplingFreqOutOfRangeF, AUTDDriverError::SamplingFreqInvalidF, or AUTDDriverError::STMPeriodInvalid if the frequency or period cannot be set strictly.

Source

pub fn new_nearest<T: IntoGainSTMGenerator<G = G>>( config: impl Into<STMConfigNearest>, iter: T, ) -> Self

Creates a new GainSTM with the nearest frequency or period to the specified value of the possible values.

Source

pub fn freq(&self) -> Freq<f32>

Returns the frequency of the STM. See also FociSTM::freq.

Source

pub fn period(&self) -> Duration

Returns the period of the STM. See also FociSTM::period.

Trait Implementations§

Source§

impl<G: Clone + GainSTMGenerator> Clone for GainSTM<G>

Source§

fn clone(&self) -> GainSTM<G>

Returns a copy 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<I: GainSTMGenerator> DatagramS for GainSTM<I>

Source§

fn parallel_threshold(&self) -> Option<usize>

Returns the parallel threshold.
Source§

fn timeout(&self) -> Option<Duration>

Returns the timeout duration.
Source§

impl<G: Debug + GainSTMGenerator> Debug for GainSTM<G>

Source§

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

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

impl<G: GainSTMGenerator> Deref for GainSTM<G>

Source§

type Target = G

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<G: GainSTMGenerator> DerefMut for GainSTM<G>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<G: GainSTMGenerator> HasSamplingConfig for GainSTM<G>

Auto Trait Implementations§

§

impl<G> Freeze for GainSTM<G>
where G: Freeze,

§

impl<G> RefUnwindSafe for GainSTM<G>
where G: RefUnwindSafe,

§

impl<G> Send for GainSTM<G>
where G: Send,

§

impl<G> Sync for GainSTM<G>
where G: Sync,

§

impl<G> Unpin for GainSTM<G>
where G: Unpin,

§

impl<G> UnwindSafe for GainSTM<G>
where G: 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, dst: *mut u8)

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

impl<D> Datagram for D
where D: DatagramS,

Source§

type G = <D as DatagramS>::G

Source§

fn operation_generator( self, geometry: &Geometry, ) -> Result<<D as Datagram>::G, AUTDDriverError>

Source§

fn timeout(&self) -> Option<Duration>

Returns the timeout duration.
Source§

fn parallel_threshold(&self) -> Option<usize>

Returns the parallel threshold.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<D> IntoDatagramWithParallelThreshold<D> for D
where D: Datagram,

Source§

fn with_parallel_threshold( self, threshold: Option<usize>, ) -> DatagramWithParallelThreshold<D>

Convert Datagram to DatagramWithParallelThreshold.
Source§

impl<D> IntoDatagramWithSegment<D> for D
where D: DatagramS,

Source§

fn with_segment( self, segment: Segment, transition_mode: Option<TransitionMode>, ) -> DatagramWithSegment<D>

Convert DatagramS to DatagramWithSegment.
Source§

impl<D> IntoDatagramWithTimeout<D> for D
where D: Datagram,

Source§

fn with_timeout(self, timeout: Option<Duration>) -> DatagramWithTimeout<D>

Convert Datagram to DatagramWithTimeout.
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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more