Struct novatel_oem6_api::ReceiverStatusFlags

[+] Show declaration

pub struct ReceiverStatusFlags { /* fields omitted */ }

[−] Expand description

Receiver status flags

Methods

impl ReceiverStatusFlags[−]

pub const ERROR_PRESENT: ReceiverStatusFlags[−][−]

System has encountered an error

pub const TEMPERATURE_WARNING: ReceiverStatusFlags[−][−]

Temperature warning

pub const VOLTAGE_SUPPLY_WARNING: ReceiverStatusFlags[−][−]

Voltage supply warning

pub const ANTENNA_NOT_POWERED: ReceiverStatusFlags[−][−]

Antenna not powered

pub const LNA_FAILURE: ReceiverStatusFlags[−][−]

LNA failure encountered

pub const ANTENNA_OPEN: ReceiverStatusFlags[−][−]

Antenna open

pub const ANTENNA_SHORTENED: ReceiverStatusFlags[−][−]

Antenna shortened

pub const CPU_OVERLOAD: ReceiverStatusFlags[−][−]

CPU overloaded

pub const COM1_BUFFER_OVERRUN: ReceiverStatusFlags[−][−]

The COM1 buffer has been overrun

pub const COM2_BUFFER_OVERRUN: ReceiverStatusFlags[−][−]

The COM2 buffer has been overrun

pub const COM3_BUFFER_OVERRUN: ReceiverStatusFlags[−][−]

The COM3 buffer has been overrun

pub const LINK_OVERRUN: ReceiverStatusFlags[−][−]

Link overrun

pub const AUX_TRANSMIT_OVERRUN: ReceiverStatusFlags[−][−]

Auxilliary transmit overrun

pub const AGC_OUT_OF_RANGE: ReceiverStatusFlags[−][−]

AGC out of range

pub const INS_RESET: ReceiverStatusFlags[−][−]

INS has been reset

pub const GPS_ALMANAC_INVALID: ReceiverStatusFlags[−][−]

GPS almanac invalid and/or UTC unknown

pub const POSITION_SOLUTION_INVALID: ReceiverStatusFlags[−][−]

Position solution is invalid

pub const POSITION_FIXED: ReceiverStatusFlags[−][−]

A fixed position is in place

pub const CLOCK_STEERING_DISABLED: ReceiverStatusFlags[−][−]

Clock steering is disabled

pub const CLOCK_MODEL_INVALID: ReceiverStatusFlags[−][−]

The clock model is invalid

pub const EXTERNAL_OSCILLATOR_LOCKED: ReceiverStatusFlags[−][−]

The external oscillator is locked

pub const SOFTWARE_RESOURCE_WARNING: ReceiverStatusFlags[−][−]

Software resource warning

pub const AUX3_STATUS_EVENT: ReceiverStatusFlags[−][−]

An auxilliary 3 status event has occurred

pub const AUX2_STATUS_EVENT: ReceiverStatusFlags[−][−]

An auxilliary 2 status event has occurred

pub const AUX1_STATUS_EVENT: ReceiverStatusFlags[−][−]

An auxilliary 1 status event has occurred

pub const fn empty() -> ReceiverStatusFlags[−]

Returns an empty set of flags

pub const fn all() -> ReceiverStatusFlags[−]

Returns the set containing all flags.

pub const fn bits(&self) -> u32[−]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<ReceiverStatusFlags>[−]

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

pub const fn from_bits_truncate(bits: u32) -> ReceiverStatusFlags[−]

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> ReceiverStatusFlags[−]

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: ReceiverStatusFlags) -> bool[−]

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

pub const fn contains(&self, other: ReceiverStatusFlags) -> bool[−]

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

pub fn insert(&mut self, other: ReceiverStatusFlags)[−]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ReceiverStatusFlags)[−]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ReceiverStatusFlags)[−]

Toggles the specified flags in-place.

pub fn set(&mut self, other: ReceiverStatusFlags, value: bool)[−]

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

impl ReceiverStatusFlags[−]

pub fn to_vec(self) -> Vec<String>[−]

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

Examples

use novatel_oem6_api::*;

let flags = ReceiverStatusFlags::CLOCK_MODEL_INVALID |
    ReceiverStatusFlags::POSITION_SOLUTION_INVALID;

let conv = flags.to_vec();

assert_eq!(conv, vec!["CLOCK_MODEL_INVALID", "POSITION_SOLUTION_INVALID"]);

Trait Implementations

impl Eq for ReceiverStatusFlags

impl Default for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

fn default() -> ReceiverStatusFlags[−]

Returns the "default value" for a type.

impl Clone for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

fn clone(&self) -> ReceiverStatusFlags[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl PartialOrd<ReceiverStatusFlags> for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &ReceiverStatusFlags) -> Option<Ordering>[−]

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

fn lt(&self, other: &ReceiverStatusFlags) -> bool[−]

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

fn le(&self, other: &ReceiverStatusFlags) -> bool[−]

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

fn gt(&self, other: &ReceiverStatusFlags) -> bool[−]

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

fn ge(&self, other: &ReceiverStatusFlags) -> bool[−]

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

impl Extend<ReceiverStatusFlags> for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

fn extend<T: IntoIterator<Item = ReceiverStatusFlags>>(&mut self, iterator: T)[−]

Extends a collection with the contents of an iterator.

impl PartialEq<ReceiverStatusFlags> for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

fn eq(&self, other: &ReceiverStatusFlags) -> bool[−]

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

fn ne(&self, other: &ReceiverStatusFlags) -> bool[−]

This method tests for !=.

impl Ord for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &ReceiverStatusFlags) -> 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 Copy for ReceiverStatusFlags

impl Hash for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

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 Sub<ReceiverStatusFlags> for ReceiverStatusFlags[+]

type Output = ReceiverStatusFlags

The resulting type after applying the - operator.

fn sub(self, other: ReceiverStatusFlags) -> ReceiverStatusFlags[−]

Returns the set difference of the two sets of flags.

impl SubAssign<ReceiverStatusFlags> for ReceiverStatusFlags[+]

fn sub_assign(&mut self, other: ReceiverStatusFlags)[−]

Disables all flags enabled in the set.

impl Not for ReceiverStatusFlags[+]

type Output = ReceiverStatusFlags

The resulting type after applying the ! operator.

fn not(self) -> ReceiverStatusFlags[−]

Returns the complement of this set of flags.

impl BitAnd<ReceiverStatusFlags> for ReceiverStatusFlags[+]

type Output = ReceiverStatusFlags

The resulting type after applying the & operator.

fn bitand(self, other: ReceiverStatusFlags) -> ReceiverStatusFlags[−]

Returns the intersection between the two sets of flags.

impl BitOr<ReceiverStatusFlags> for ReceiverStatusFlags[+]

type Output = ReceiverStatusFlags

The resulting type after applying the | operator.

fn bitor(self, other: ReceiverStatusFlags) -> ReceiverStatusFlags[−]

Returns the union of the two sets of flags.

impl BitXor<ReceiverStatusFlags> for ReceiverStatusFlags[+]

type Output = ReceiverStatusFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: ReceiverStatusFlags) -> ReceiverStatusFlags[−]

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

impl BitAndAssign<ReceiverStatusFlags> for ReceiverStatusFlags[+]

fn bitand_assign(&mut self, other: ReceiverStatusFlags)[−]

Disables all flags disabled in the set.

impl BitOrAssign<ReceiverStatusFlags> for ReceiverStatusFlags[+]

fn bitor_assign(&mut self, other: ReceiverStatusFlags)[−]

Adds the set of flags.

impl BitXorAssign<ReceiverStatusFlags> for ReceiverStatusFlags[+]

fn bitxor_assign(&mut self, other: ReceiverStatusFlags)[−]

Toggles the set of flags.

impl Debug for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl FromIterator<ReceiverStatusFlags> for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

fn from_iter<T: IntoIterator<Item = ReceiverStatusFlags>>(
    iterator: T
) -> ReceiverStatusFlags[−]

Creates a value from an iterator.

impl Octal for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Binary for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl LowerHex for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl UpperHex for ReceiverStatusFlags[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.