autd3_driver/datagram/
with_segment.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
use std::time::Duration;

use super::{Datagram, OperationGenerator};
use crate::{
    defined::DEFAULT_TIMEOUT,
    error::AUTDDriverError,
    firmware::fpga::{Segment, TransitionMode},
    geometry::Geometry,
};

use autd3_derive::Builder;
use derive_more::Deref;

/// [`DatagramS`] represents a [`Datagram`] that can specify [`Segment`] to write the data.
pub trait DatagramS: std::fmt::Debug {
    #[doc(hidden)]
    type G: OperationGenerator;

    #[doc(hidden)]
    fn operation_generator_with_segment(
        self,
        geometry: &Geometry,
        segment: Segment,
        transition_mode: Option<TransitionMode>,
    ) -> Result<Self::G, AUTDDriverError>;

    /// Returns the timeout duration.
    fn timeout(&self) -> Option<Duration> {
        Some(DEFAULT_TIMEOUT)
    }

    /// Returns the parallel threshold.
    fn parallel_threshold(&self) -> Option<usize> {
        Some(usize::MAX)
    }
}

/// A wrapper to set [`Segment`] of [`DatagramS`].
#[derive(Builder, Clone, Deref, Debug)]
pub struct DatagramWithSegment<D: DatagramS> {
    #[deref]
    datagram: D,
    #[get]
    /// Segment to write the data.
    segment: Segment,
    #[get]
    /// Transition mode. If `None`, the data is written to the segment, but the transition does not occur.     
    /// See [`TransitionMode`] for details.
    transition_mode: Option<TransitionMode>,
}

impl<D: DatagramS> Datagram for DatagramWithSegment<D> {
    type G = D::G;

    fn operation_generator(self, geometry: &Geometry) -> Result<Self::G, AUTDDriverError> {
        self.datagram
            .operation_generator_with_segment(geometry, self.segment, self.transition_mode)
    }

    fn timeout(&self) -> Option<Duration> {
        self.datagram.timeout()
    }

    fn parallel_threshold(&self) -> Option<usize> {
        self.datagram.parallel_threshold()
    }
}

impl<D: DatagramS> Datagram for D {
    type G = D::G;

    fn operation_generator(self, geometry: &Geometry) -> Result<Self::G, AUTDDriverError> {
        self.operation_generator_with_segment(
            geometry,
            Segment::S0,
            Some(TransitionMode::Immediate),
        )
    }

    fn timeout(&self) -> Option<Duration> {
        <Self as DatagramS>::timeout(self)
    }

    fn parallel_threshold(&self) -> Option<usize> {
        <Self as DatagramS>::parallel_threshold(self)
    }
}

/// A trait to convert [`DatagramS`] to [`DatagramWithSegment`].
pub trait IntoDatagramWithSegment<D: DatagramS> {
    /// Convert [`DatagramS`] to [`DatagramWithSegment`].
    fn with_segment(
        self,
        segment: Segment,
        transition_mode: Option<TransitionMode>,
    ) -> DatagramWithSegment<D>;
}

impl<D: DatagramS> IntoDatagramWithSegment<D> for D {
    fn with_segment(
        self,
        segment: Segment,
        transition_mode: Option<TransitionMode>,
    ) -> DatagramWithSegment<D> {
        DatagramWithSegment {
            datagram: self,
            segment,
            transition_mode,
        }
    }
}