Struct Group

pub struct Group<K, D, F>
where
    K: Hash + Eq + Debug,
    D: Datagram,
    F: Fn(&Device) -> Option<K>,
    AUTDDriverError: From<<D as Datagram>::Error>,
{
    pub key_map: F,
    pub datagram_map: HashMap<K, D>,
}

Datagram that divide the devices into groups by given function and send different data to each group.

If the key is None, nothing is done for the devices corresponding to the key.

Example

use std::collections::HashMap;

Group {
    key_map: |dev| match dev.idx() {
        0 => Some("silencer"),
        1 => Some("disable"),
        _ => None,
    },
    datagram_map: HashMap::from([
        ("silencer", Silencer::default()),
        ("disable", Silencer::disable()),
    ]),
};

Fields

key_map: F

Mapping function from device to group key.

datagram_map: HashMap<K, D>

Map from group key to Datagram.

Implementations

impl<K, D, F> Group<K, D, F>

where K: Hash + Eq + Debug, D: Datagram, F: Fn(&Device) -> Option<K>, AUTDDriverError: From<<D as Datagram>::Error>,

pub const fn new(key_map: F, datagram_map: HashMap<K, D>) -> Group<K, D, F>

Creates a new Group.

Trait Implementations

impl<K, D, F> Datagram for Group<K, D, F>

where K: Hash + Eq + Debug, D: Datagram, F: Fn(&Device) -> Option<K>, AUTDDriverError: From<<D as Datagram>::Error>,

fn option(&self) -> DatagramOption

Returns the option of the datagram.

impl<K, D, F> Debug for Group<K, D, F>

where K: Hash + Eq + Debug, D: Datagram, F: Fn(&Device) -> Option<K>, AUTDDriverError: From<<D as Datagram>::Error>,

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

Formats the value using the given formatter.

impl<K, D, F> Default for Group<K, D, F>

where K: Default + Hash + Eq + Debug, D: Default + Datagram, F: Default + Fn(&Device) -> Option<K>, AUTDDriverError: From<<D as Datagram>::Error>,

fn default() -> Group<K, D, F>

Returns the “default value” for a type.

impl<K, D, F> Inspectable for Group<K, D, F>

where K: Hash + Eq + Debug, D: Datagram + Inspectable, F: Fn(&Device) -> Option<K>, AUTDDriverError: From<<D as Datagram>::Error>,

type Result = <D as Inspectable>::Result

The result of the inspection.

fn inspect( self, geometry: &Geometry, env: &Environment, _: &DeviceFilter, limits: &FirmwareLimits, ) -> Result<InspectionResult<<Group<K, D, F> as Inspectable>::Result>, AUTDDriverError>

Returns the inspection result.