Enum ichen_openprotocol::OpMode

pub enum OpMode {
    Unknown,
    Manual,
    SemiAutomatic,
    Automatic,
    Others,
    Offline,
}

Operating modes of the controller.

See this document for details.

Variants

Unknown

Unknown operation mode.

Manual

Manual mode.

SemiAutomatic

Semi-Automatic mode.

Automatic

Automatic mode.

Others

Other unspecified operation mode.

Offline

The controller is off-line.

When the controller is off-line, both its operating mode and job mode should be Offline.

Methods

impl OpMode

pub fn is_unknown(&self) -> bool

Returns true if Unknown.

Examples

assert!(OpMode::Unknown.is_unknown());
assert!(!OpMode::Manual.is_unknown());

pub fn is_offline(&self) -> bool

Returns true if Offline.

Examples

assert!(OpMode::Offline.is_offline());
assert!(!OpMode::Manual.is_offline());

pub fn is_online(&self) -> bool

Returns true for all variants other than Unknown and Offline.

Examples

assert!(!OpMode::Offline.is_online());
assert!(!OpMode::Unknown.is_online());
assert!(OpMode::Automatic.is_online());
assert!(OpMode::Manual.is_online());

pub fn is_producing(&self) -> bool

A machine is producing if it is in either Automatic or Semi-Automatic mode.

Examples

assert!(!OpMode::Offline.is_producing());
assert!(!OpMode::Unknown.is_producing());
assert!(OpMode::Automatic.is_producing());
assert!(!OpMode::Manual.is_producing());

Trait Implementations

impl Clone for OpMode

fn clone(&self) -> OpMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for OpMode

impl Debug for OpMode

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

Formats the value using the given formatter.

impl Default for OpMode

fn default() -> Self

Default value for OpMode.

impl<'de> Deserialize<'de> for OpMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for OpMode

fn fmt(&self, _derive_more_display_formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for OpMode

impl Hash for OpMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for OpMode

fn cmp(&self, other: &OpMode) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<OpMode> for OpMode

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<OpMode> for OpMode

fn partial_cmp(&self, other: &OpMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for OpMode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for OpMode

impl StructuralPartialEq for OpMode