Struct SignalStatus

pub struct SignalStatus(/* private fields */);

A struct that represents the status of a signal instance. When this struct is created by Signal::get_status(), the flags was_set_remote and was_set_local will be reset.

Implementations

impl SignalStatus

pub fn was_set_remote(&self) -> bool

Returns true if the signal was set remotely since the last time the status was queried.

Examples found in repository

examples/vector_signal.rs (line 27)

fn main() {
    let dev = Device::create("rustmapper");
    loop {
        dev.poll_and_block(Duration::from_millis(10));
        if dev.is_ready() {
            break;
        }
    }

    println!("Device became ready!");
    let mut sig = dev.create_vector_signal::<f64>("test_sin", mpr_dir::MPR_DIR_OUT, 2);
    let debug_sig = dev.create_vector_signal::<f64>("debug_msg", mpr_dir::MPR_DIR_IN, 2);
    loop {
        dev.poll_and_block(Duration::from_millis(100));
        let time = (SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .unwrap()
            .as_millis() as u64) as f64
            / 1000f64;

        let values = [time.sin(), time.cos()];
        sig.set_value(&values).unwrap();
        if debug_sig.get_status().was_set_remote() {
            println!(
                "Received debug message: {:?}",
                debug_sig.get_value::<f64>().unwrap().0
            );
        }
    }
}

examples/signal.rs (line 31)

fn main() {
    let dev = Device::create("rustmapper");
    loop {
        dev.poll_and_block(Duration::from_millis(10));
        if dev.is_ready() {
            break;
        }
    }

    println!("Device became ready!");
    let mut sig = dev.create_signal::<f64>("test_sin", mpr_dir::MPR_DIR_OUT);
    sig.set_property(mpr_prop::MPR_PROP_MIN, -1.0);
    sig.set_property(mpr_prop::MPR_PROP_MAX, 1.0);
    
    let debug_sig = dev.create_signal::<f64>("debug_msg", mpr_dir::MPR_DIR_IN);

    assert!(debug_sig.get_property::<f64>(mpr_prop::MPR_PROP_MIN).is_err());
    loop {
        dev.poll_and_block(Duration::from_millis(100));
        let time = ((SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .unwrap()
            .as_millis() as u64) as f64
            / 1000f64)
            .sin();
        sig.set_value_single(&time).unwrap();
        if debug_sig.get_status().was_set_remote() {
            println!(
                "Received debug message: {:?}",
                debug_sig.get_value_single::<f64>().unwrap()
            );
        }
    }
}

pub fn was_set_local(&self) -> bool

Returns true if the signal was set locally since the last time the status was queried.

pub fn has_value(&self) -> bool

Returns true if the signal has a value (i.e. Signal::get_value* will return Some).

pub fn is_active(&self) -> bool

If the signal is active

pub fn value_updated(&self) -> bool

If the actual numerical value of the signal has changed since the last time the status was queried.

Trait Implementations

impl Clone for SignalStatus

fn clone(&self) -> SignalStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignalStatus

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

Formats the value using the given formatter.

impl PartialEq for SignalStatus

fn eq(&self, other: &SignalStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SignalStatus

impl Eq for SignalStatus

impl StructuralPartialEq for SignalStatus