Struct MavGeneratorStatusFlag

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

Available on crate feature cubepilot only.

Flags to report status/failure cases for a power generator (used in GENERATOR_STATUS). Note that FAULTS are conditions that cause the generator to fail. Warnings are conditions that require attention before the next use (they indicate the system is not operating properly).

Implementations

impl MavGeneratorStatusFlag

pub const MAV_GENERATOR_STATUS_FLAG_OFF: Self

Generator is off.

pub const MAV_GENERATOR_STATUS_FLAG_READY: Self

Generator is ready to start generating power.

pub const MAV_GENERATOR_STATUS_FLAG_GENERATING: Self

Generator is generating power.

pub const MAV_GENERATOR_STATUS_FLAG_CHARGING: Self

Generator is charging the batteries (generating enough power to charge and provide the load).

pub const MAV_GENERATOR_STATUS_FLAG_REDUCED_POWER: Self

Generator is operating at a reduced maximum power.

pub const MAV_GENERATOR_STATUS_FLAG_MAXPOWER: Self

Generator is providing the maximum output.

pub const MAV_GENERATOR_STATUS_FLAG_OVERTEMP_WARNING: Self

Generator is near the maximum operating temperature, cooling is insufficient.

pub const MAV_GENERATOR_STATUS_FLAG_OVERTEMP_FAULT: Self

Generator hit the maximum operating temperature and shutdown.

pub const MAV_GENERATOR_STATUS_FLAG_ELECTRONICS_OVERTEMP_WARNING: Self

Power electronics are near the maximum operating temperature, cooling is insufficient.

pub const MAV_GENERATOR_STATUS_FLAG_ELECTRONICS_OVERTEMP_FAULT: Self

Power electronics hit the maximum operating temperature and shutdown.

pub const MAV_GENERATOR_STATUS_FLAG_ELECTRONICS_FAULT: Self

Power electronics experienced a fault and shutdown.

pub const MAV_GENERATOR_STATUS_FLAG_POWERSOURCE_FAULT: Self

The power source supplying the generator failed e.g. mechanical generator stopped, tether is no longer providing power, solar cell is in shade, hydrogen reaction no longer happening.

pub const MAV_GENERATOR_STATUS_FLAG_COMMUNICATION_WARNING: Self

Generator controller having communication problems.

pub const MAV_GENERATOR_STATUS_FLAG_COOLING_WARNING: Self

Power electronic or generator cooling system error.

pub const MAV_GENERATOR_STATUS_FLAG_POWER_RAIL_FAULT: Self

Generator controller power rail experienced a fault.

pub const MAV_GENERATOR_STATUS_FLAG_OVERCURRENT_FAULT: Self

Generator controller exceeded the overcurrent threshold and shutdown to prevent damage.

pub const MAV_GENERATOR_STATUS_FLAG_BATTERY_OVERCHARGE_CURRENT_FAULT: Self

Generator controller detected a high current going into the batteries and shutdown to prevent battery damage.

pub const MAV_GENERATOR_STATUS_FLAG_OVERVOLTAGE_FAULT: Self

Generator controller exceeded it’s overvoltage threshold and shutdown to prevent it exceeding the voltage rating.

pub const MAV_GENERATOR_STATUS_FLAG_BATTERY_UNDERVOLT_FAULT: Self

Batteries are under voltage (generator will not start).

pub const MAV_GENERATOR_STATUS_FLAG_START_INHIBITED: Self

Generator start is inhibited by e.g. a safety switch.

pub const MAV_GENERATOR_STATUS_FLAG_MAINTENANCE_REQUIRED: Self

Generator requires maintenance.

pub const MAV_GENERATOR_STATUS_FLAG_WARMING_UP: Self

Generator is not ready to generate yet.

pub const MAV_GENERATOR_STATUS_FLAG_IDLE: Self

Generator is idle.

impl MavGeneratorStatusFlag

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u64) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u64) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl MavGeneratorStatusFlag

pub const fn iter(&self) -> Iter<MavGeneratorStatusFlag>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<MavGeneratorStatusFlag>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl MavGeneratorStatusFlag

pub const DEFAULT: Self = Self::MAV_GENERATOR_STATUS_FLAG_OFF

Trait Implementations

impl Binary for MavGeneratorStatusFlag

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

Formats the value using the given formatter.

impl BitAnd for MavGeneratorStatusFlag

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

The bitwise and (&) of the bits in two flags values.

type Output = MavGeneratorStatusFlag

The resulting type after applying the & operator.

impl BitAndAssign for MavGeneratorStatusFlag

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for MavGeneratorStatusFlag

fn bitor(self, other: MavGeneratorStatusFlag) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = MavGeneratorStatusFlag

The resulting type after applying the | operator.

impl BitOrAssign for MavGeneratorStatusFlag

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for MavGeneratorStatusFlag

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = MavGeneratorStatusFlag

The resulting type after applying the ^ operator.

impl BitXorAssign for MavGeneratorStatusFlag

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for MavGeneratorStatusFlag

fn clone(&self) -> MavGeneratorStatusFlag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MavGeneratorStatusFlag

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

Formats the value using the given formatter.

impl Default for MavGeneratorStatusFlag

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MavGeneratorStatusFlag

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<MavGeneratorStatusFlag> for MavGeneratorStatusFlag

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

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Flags for MavGeneratorStatusFlag

const FLAGS: &'static [Flag<MavGeneratorStatusFlag>]

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> MavGeneratorStatusFlag

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<MavGeneratorStatusFlag> for MavGeneratorStatusFlag

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

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for MavGeneratorStatusFlag

type Item = MavGeneratorStatusFlag

The type of the elements being iterated over.

type IntoIter = Iter<MavGeneratorStatusFlag>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for MavGeneratorStatusFlag

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

Formats the value using the given formatter.

impl Not for MavGeneratorStatusFlag

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = MavGeneratorStatusFlag

The resulting type after applying the ! operator.

impl Octal for MavGeneratorStatusFlag

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

Formats the value using the given formatter.

impl PartialEq for MavGeneratorStatusFlag

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

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

const 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 PublicFlags for MavGeneratorStatusFlag

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Serialize for MavGeneratorStatusFlag

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for MavGeneratorStatusFlag

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = MavGeneratorStatusFlag

The resulting type after applying the - operator.

impl SubAssign for MavGeneratorStatusFlag

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for MavGeneratorStatusFlag

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

Formats the value using the given formatter.

impl Copy for MavGeneratorStatusFlag

impl StructuralPartialEq for MavGeneratorStatusFlag