Struct mai400_api::ThermopileFlags

pub struct ThermopileFlags { /* fields omitted */ }

Thermopile error flags

Methods

impl ThermopileFlags

pub const DIP_ANGLE_LIMIT: ThermopileFlags

Dip angle exceeded senser system limit

pub const SUN_IN_EPHEMERIS: ThermopileFlags

Sun in FOV using sun ephemeris

pub const THERMOPILE_SAT: ThermopileFlags

Thermopile is saturated

pub const NO_COMM: ThermopileFlags

No communications

pub const BAD_EARTH_REF: ThermopileFlags

Earth reference is bad

pub const AUX_WIDE_FOV: ThermopileFlags

Using auxiliary wide FOV sensor

pub const fn empty() -> ThermopileFlags

Returns an empty set of flags

pub const fn all() -> ThermopileFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<ThermopileFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> ThermopileFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u8) -> ThermopileFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: ThermopileFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: ThermopileFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: ThermopileFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ThermopileFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ThermopileFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: ThermopileFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl ThermopileFlags

pub fn to_vec(self) -> Vec<String>

Convert the flags byte into a vector containing the string representations of all flags present.

Examples

use mai400_api::*;

let flags = ThermopileFlags::NO_COMM | ThermopileFlags::BAD_EARTH_REF;

let conv = flags.to_vec();

assert_eq!(conv, vec!["NO_COMM", "BAD_EARTH_REF"]);

Trait Implementations

impl Copy for ThermopileFlags

impl Default for ThermopileFlags

fn default() -> ThermopileFlags

Returns the "default value" for a type.

impl Eq for ThermopileFlags

impl Clone for ThermopileFlags

fn clone(&self) -> ThermopileFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<ThermopileFlags> for ThermopileFlags

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

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

fn lt(&self, other: &ThermopileFlags) -> bool

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

fn le(&self, other: &ThermopileFlags) -> bool

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

fn gt(&self, other: &ThermopileFlags) -> bool

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

fn ge(&self, other: &ThermopileFlags) -> bool

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

impl Extend<ThermopileFlags> for ThermopileFlags

fn extend<T: IntoIterator<Item = ThermopileFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl PartialEq<ThermopileFlags> for ThermopileFlags

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

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

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

This method tests for !=.

impl Ord for ThermopileFlags

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Hash for ThermopileFlags

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 Debug for ThermopileFlags

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

Formats the value using the given formatter.

impl Sub<ThermopileFlags> for ThermopileFlags

type Output = ThermopileFlags

The resulting type after applying the - operator.

fn sub(self, other: ThermopileFlags) -> ThermopileFlags

Returns the set difference of the two sets of flags.

impl SubAssign<ThermopileFlags> for ThermopileFlags

fn sub_assign(&mut self, other: ThermopileFlags)

Disables all flags enabled in the set.

impl Not for ThermopileFlags

type Output = ThermopileFlags

The resulting type after applying the ! operator.

fn not(self) -> ThermopileFlags

Returns the complement of this set of flags.

impl BitAnd<ThermopileFlags> for ThermopileFlags

type Output = ThermopileFlags

The resulting type after applying the & operator.

fn bitand(self, other: ThermopileFlags) -> ThermopileFlags

Returns the intersection between the two sets of flags.

impl BitOr<ThermopileFlags> for ThermopileFlags

type Output = ThermopileFlags

The resulting type after applying the | operator.

fn bitor(self, other: ThermopileFlags) -> ThermopileFlags

Returns the union of the two sets of flags.

impl BitXor<ThermopileFlags> for ThermopileFlags

type Output = ThermopileFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: ThermopileFlags) -> ThermopileFlags

Returns the left flags, but with all the right flags toggled.

impl BitAndAssign<ThermopileFlags> for ThermopileFlags

fn bitand_assign(&mut self, other: ThermopileFlags)

Disables all flags disabled in the set.

impl BitOrAssign<ThermopileFlags> for ThermopileFlags

fn bitor_assign(&mut self, other: ThermopileFlags)

Adds the set of flags.

impl BitXorAssign<ThermopileFlags> for ThermopileFlags

fn bitxor_assign(&mut self, other: ThermopileFlags)

Toggles the set of flags.

impl FromIterator<ThermopileFlags> for ThermopileFlags

fn from_iter<T: IntoIterator<Item = ThermopileFlags>>(
    iterator: T
) -> ThermopileFlags

Creates a value from an iterator.

impl Octal for ThermopileFlags

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

Formats the value using the given formatter.

impl Binary for ThermopileFlags

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

Formats the value using the given formatter.

impl LowerHex for ThermopileFlags

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

Formats the value using the given formatter.

impl UpperHex for ThermopileFlags

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

Formats the value using the given formatter.