Skip to main content

PlatoEngine

Struct PlatoEngine 

Source
pub struct PlatoEngine {
    pub sensors: Vec<SensorSpec>,
    pub actuators: Vec<ActuatorSpec>,
    pub alarms: Vec<AlarmRule>,
    pub history: HistoryBuffer,
    pub tick_hz: f64,
    pub tick_index: u64,
    pub start_time: f64,
    pub streaming: bool,
    pub alarm_fires: Vec<String>,
}
Expand description

The core engine: sensors, actuators, history, alarms.

Fields§

§sensors: Vec<SensorSpec>§actuators: Vec<ActuatorSpec>§alarms: Vec<AlarmRule>§history: HistoryBuffer§tick_hz: f64§tick_index: u64§start_time: f64§streaming: bool§alarm_fires: Vec<String>

Alarm names that fired on the last tick (consumed by protocol handler).

Implementations§

Source§

impl PlatoEngine

Source

pub fn builder() -> PlatoEngineBuilder

Create a new builder.

Source

pub fn tick(&mut self) -> &Tick

Take one tick: read sensors, push to history, evaluate alarms.

Source

pub fn latest(&self) -> Option<&Tick>

Get the latest tick.

Source

pub fn history(&self, n: usize) -> Vec<&Tick>

Get the last n ticks from history.

Source

pub fn set_actuator(&mut self, name: &str, value: f64) -> Result<bool, String>

Set an actuator by name.

Source

pub fn subscribe(&mut self)

Subscribe to live updates.

Source

pub fn unsubscribe(&mut self)

Unsubscribe from live updates.

Source

pub fn handle_command(&mut self, command: &str) -> String

Handle a text command.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.