Struct FociSTM 

pub struct FociSTM<const N: usize, T: FociSTMGenerator<N>, C> {
    pub foci: T,
    pub config: C,
}

Datagram to produce STM by foci.

Fields

foci: T

The sequence of foci.

config: C

The STM configuration.

Implementations

impl<const N: usize, T: FociSTMGenerator<N>, C> FociSTM<N, T, C>

pub const fn new(foci: T, config: C) -> Self

Create a new FociSTM.

impl<const N: usize, T: FociSTMGenerator<N>> FociSTM<N, T, Freq<f32>>

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

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

impl<const N: usize, T: FociSTMGenerator<N>> FociSTM<N, T, Duration>

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

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

impl<const N: usize, T: FociSTMGenerator<N>, C: Into<STMConfig> + Copy> FociSTM<N, T, C>

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

The sampling configuration of the STM.

Trait Implementations

impl<const N: usize, T: Clone + FociSTMGenerator<N>, C: Clone> Clone for FociSTM<N, T, C>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize, G: FociSTMGenerator<N> + Debug, C: Into<STMConfig> + Debug> DatagramL<'_> for FociSTM<N, G, C>

fn option(&self) -> DatagramOption

Returns the option of the datagram.

impl<const N: usize, T: Debug + FociSTMGenerator<N>, C: Debug> Debug for FociSTM<N, T, C>

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

Formats the value using the given formatter.

impl<'a, const N: usize, G: FociSTMGenerator<N> + Debug, C: Into<STMConfig> + Copy + Debug> Inspectable<'a> for FociSTM<N, G, C>

type Result = FociSTMInspectionResult<N>

The result of the inspection.

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

Returns the inspection result.

impl<const N: usize, T: PartialEq + FociSTMGenerator<N>, C: PartialEq> PartialEq for FociSTM<N, T, C>

fn eq(&self, other: &FociSTM<N, T, C>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize, T: FociSTMGenerator<N>, C> StructuralPartialEq for FociSTM<N, T, C>