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.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

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

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

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

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

pub const unsafe fn from_bits_unchecked(bits: u64) -> Self

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

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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: Self) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

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

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

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

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

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

Returns the intersection between the two sets of flags.

type Output = MavGeneratorStatusFlag

The resulting type after applying the & operator.

impl BitAndAssign for MavGeneratorStatusFlag

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for MavGeneratorStatusFlag

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

Returns the union of the two sets of flags.

type Output = MavGeneratorStatusFlag

The resulting type after applying the | operator.

impl BitOrAssign for MavGeneratorStatusFlag

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for MavGeneratorStatusFlag

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

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

type Output = MavGeneratorStatusFlag

The resulting type after applying the ^ operator.

impl BitXorAssign for MavGeneratorStatusFlag

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for MavGeneratorStatusFlag

fn clone(&self) -> MavGeneratorStatusFlag

Returns a duplicate of the value.

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)

Extends a collection with the contents of an iterator.

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 FromIterator<MavGeneratorStatusFlag> for MavGeneratorStatusFlag

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

Creates a value from an iterator.

impl Hash for MavGeneratorStatusFlag

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

Returns the complement of this set of flags.

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 Ord for MavGeneratorStatusFlag

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MavGeneratorStatusFlag

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

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

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 PartialOrd for MavGeneratorStatusFlag

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

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

Returns the set difference of the two sets of flags.

type Output = MavGeneratorStatusFlag

The resulting type after applying the - operator.

impl SubAssign for MavGeneratorStatusFlag

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for MavGeneratorStatusFlag

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

Formats the value using the given formatter.

impl Copy for MavGeneratorStatusFlag

impl Eq for MavGeneratorStatusFlag

impl StructuralPartialEq for MavGeneratorStatusFlag