autd3-core 38.1.0

AUTD3 core traits and types
Documentation 
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

use super::Point3;

/// A ultrasound transducer.
#[derive(Clone, Debug, PartialEq)]
pub struct Transducer {
    pub(crate) idx: u8,
    pub(crate) dev_idx: u16,
    position: Point3,
}

impl Transducer {
    /// Creates a new [`Transducer`].
    #[must_use]
    pub const fn new(position: Point3) -> Self {
        Self {
            idx: 0,
            dev_idx: 0,
            position,
        }
    }

    /// Gets the local index of the transducer.
    #[must_use]
    pub const fn idx(&self) -> usize {
        self.idx as _
    }

    /// Gets the index of the device to which this transducer belongs.
    #[must_use]
    pub const fn dev_idx(&self) -> usize {
        self.dev_idx as _
    }

    /// Gets the position of the transducer.
    #[must_use]
    pub const fn position(&self) -> Point3 {
        self.position
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn idx() {
        let tr = Transducer::new(Point3::origin());
        assert_eq!(0, tr.idx());
        assert_eq!(0, tr.dev_idx());
    }
}