micromanager 0.2.0

Rust port of the MicroManager microscopy control framework
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
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
112
113
114
115
116
117

use crate::error::{MmError, MmResult};
use crate::property::PropertyMap;
use crate::traits::{Device, Shutter};
use crate::types::{DeviceType, PropertyValue};

/// Demo shutter.
pub struct DemoShutter {
    props: PropertyMap,
    initialized: bool,
    open: bool,
}

impl DemoShutter {
    pub fn new() -> Self {
        let mut props = PropertyMap::new();
        props.define_property("State", PropertyValue::String("Closed".into()), false).unwrap();
        props.set_allowed_values("State", &["Open", "Closed"]).unwrap();
        Self {
            props,
            initialized: false,
            open: false,
        }
    }
}

impl Default for DemoShutter {
    fn default() -> Self {
        Self::new()
    }
}

impl Device for DemoShutter {
    fn name(&self) -> &str { "DShutter" }
    fn description(&self) -> &str { "Demo shutter" }

    fn initialize(&mut self) -> MmResult<()> {
        self.initialized = true;
        Ok(())
    }

    fn shutdown(&mut self) -> MmResult<()> {
        self.open = false;
        self.initialized = false;
        Ok(())
    }

    fn get_property(&self, name: &str) -> MmResult<PropertyValue> {
        match name {
            "State" => Ok(PropertyValue::String(if self.open { "Open" } else { "Closed" }.into())),
            _ => self.props.get(name).cloned(),
        }
    }

    fn set_property(&mut self, name: &str, val: PropertyValue) -> MmResult<()> {
        match name {
            "State" => {
                let s = val.as_str().to_string();
                match s.as_str() {
                    "Open" => self.open = true,
                    "Closed" => self.open = false,
                    _ => return Err(MmError::InvalidPropertyValue),
                }
                Ok(())
            }
            _ => self.props.set(name, val),
        }
    }

    fn property_names(&self) -> Vec<String> {
        self.props.property_names().to_vec()
    }

    fn has_property(&self, name: &str) -> bool {
        self.props.has_property(name)
    }

    fn is_property_read_only(&self, name: &str) -> bool {
        self.props.entry(name).map(|e| e.read_only).unwrap_or(false)
    }

    fn device_type(&self) -> DeviceType { DeviceType::Shutter }
    fn busy(&self) -> bool { false }
}

impl Shutter for DemoShutter {
    fn set_open(&mut self, open: bool) -> MmResult<()> {
        self.open = open;
        Ok(())
    }

    fn get_open(&self) -> MmResult<bool> {
        Ok(self.open)
    }

    fn fire(&mut self, _delta_t: f64) -> MmResult<()> {
        // Open then close (instant simulation)
        self.open = true;
        self.open = false;
        Ok(())
    }
}

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

    #[test]
    fn open_close() {
        let mut s = DemoShutter::new();
        s.initialize().unwrap();
        assert!(!s.get_open().unwrap());
        s.set_open(true).unwrap();
        assert!(s.get_open().unwrap());
        s.set_open(false).unwrap();
        assert!(!s.get_open().unwrap());
    }
}