Struct FociSTM

pub struct FociSTM<const N: usize, G: FociSTMGenerator<N>> { /* private fields */ }

Datagram to produce STM by foci.

Implementations

impl<G: FociSTMGenerator<N>, const N: usize> FociSTM<N, G>

pub const fn loop_behavior(&self) -> LoopBehavior

The loop behavior of the STM.

pub const fn sampling_config(&self) -> SamplingConfig

The sampling configuration of the STM.

impl<G: FociSTMGenerator<N>, const N: usize> FociSTM<N, G>

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

Set the loop_behavior field.

impl<const N: usize, G: FociSTMGenerator<N>> FociSTM<N, G>

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

Creates a new FociSTM.

Errors

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

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

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

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

Returns the frequency of the STM.

Example

let stm = FociSTM::new(1.0 * Hz, vec![Point3::origin(), Point3::origin()])?;
assert_eq!(1.0 * Hz, stm.freq());

let stm = FociSTM::new(std::time::Duration::from_secs(1), vec![Point3::origin(), Point3::origin()])?;
assert_eq!(1.0 * Hz, stm.freq());

let stm = FociSTM::new(SamplingConfig::new(1.0 * Hz)?, vec![Point3::origin(), Point3::origin()])?;
assert_eq!(0.5 * Hz, stm.freq());

pub fn period(&self) -> Duration

Returns the period of the STM.

Example

let stm = FociSTM::new(1.0 * Hz, vec![Point3::origin(), Point3::origin()])?;
assert_eq!(std::time::Duration::from_secs(1), stm.period());

let stm = FociSTM::new(std::time::Duration::from_secs(1), vec![Point3::origin(), Point3::origin()])?;
assert_eq!(std::time::Duration::from_secs(1), stm.period());

let stm = FociSTM::new(SamplingConfig::new(1.0 * Hz)?, vec![Point3::origin(), Point3::origin()])?;
assert_eq!(std::time::Duration::from_secs(2), stm.period());

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize, G: FociSTMGenerator<N>> DatagramS for FociSTM<N, G>

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

Returns the parallel threshold.

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

Returns the timeout duration.

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

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

Formats the value using the given formatter.

impl<const N: usize, G: FociSTMGenerator<N>> Deref for FociSTM<N, G>

type Target = G

The resulting type after dereferencing.

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

Dereferences the value.

impl<const N: usize, G: FociSTMGenerator<N>> DerefMut for FociSTM<N, G>

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

Mutably dereferences the value.

impl<const N: usize, G: FociSTMGenerator<N>> HasSamplingConfig for FociSTM<N, G>