ctre::phoenix6::signals::MagnetHealthValue Class Reference

Magnet health as measured by CANcoder. More...

#include <ctre/phoenix6/signals/SpnEnums.hpp>

Inheritance diagram for ctre::phoenix6::signals::MagnetHealthValue:

Public Member Functions
constexpr	MagnetHealthValue (int value)
constexpr	MagnetHealthValue ()
constexpr bool	operator== (MagnetHealthValue data) const
constexpr bool	operator== (int data) const
constexpr bool	operator!= (MagnetHealthValue data) const
constexpr bool	operator!= (int data) const
constexpr bool	operator< (MagnetHealthValue data) const
constexpr bool	operator< (int data) const
std::string	ToString () const
	Gets the string representation of this enum.
std::string	Serialize () const

Public Attributes
int	value

Static Public Attributes
static constexpr int	Magnet_Red = 1
	The magnet is too close or too far from the CANcoder.
static constexpr int	Magnet_Orange = 2
	Magnet health is adequate but with reduced accuracy.
static constexpr int	Magnet_Green = 3
	Magnet health is ideal.
static constexpr int	Magnet_Invalid = 0
	The accuracy cannot be determined.

Friends
std::ostream &	operator<< (std::ostream &os, MagnetHealthValue data)

Detailed Description

Magnet health as measured by CANcoder.

   Red indicates too close or too far, Orange is adequate but with
   reduced accuracy, green is ideal. Invalid means the accuracy cannot be
   determined.

Constructor & Destructor Documentation

MagnetHealthValue() [1/2]

constexpr ctre::phoenix6::signals::MagnetHealthValue::MagnetHealthValue ( int value )

inlineconstexpr

MagnetHealthValue() [2/2]

constexpr ctre::phoenix6::signals::MagnetHealthValue::MagnetHealthValue ( )

inlineconstexpr

Member Function Documentation

operator!=() [1/2]

constexpr bool ctre::phoenix6::signals::MagnetHealthValue::operator!= ( int data ) const

inlineconstexpr

operator!=() [2/2]

constexpr bool ctre::phoenix6::signals::MagnetHealthValue::operator!= ( MagnetHealthValue data ) const

inlineconstexpr

operator<() [1/2]

constexpr bool ctre::phoenix6::signals::MagnetHealthValue::operator< ( int data ) const

inlineconstexpr

operator<() [2/2]

constexpr bool ctre::phoenix6::signals::MagnetHealthValue::operator< ( MagnetHealthValue data ) const

inlineconstexpr

operator==() [1/2]

constexpr bool ctre::phoenix6::signals::MagnetHealthValue::operator== ( int data ) const

inlineconstexpr

operator==() [2/2]

constexpr bool ctre::phoenix6::signals::MagnetHealthValue::operator== ( MagnetHealthValue data ) const

inlineconstexpr

Serialize()

std::string ctre::phoenix6::signals::MagnetHealthValue::Serialize ( ) const

inlinevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

std::string ctre::phoenix6::signals::MagnetHealthValue::ToString ( ) const

inline

Gets the string representation of this enum.

Returns

String representation of this enum

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, MagnetHealthValue data )

friend

Member Data Documentation

Magnet_Green

constexpr int ctre::phoenix6::signals::MagnetHealthValue::Magnet_Green = 3

staticconstexpr

Magnet health is ideal.

Magnet_Invalid

constexpr int ctre::phoenix6::signals::MagnetHealthValue::Magnet_Invalid = 0

staticconstexpr

The accuracy cannot be determined.

Magnet_Orange

constexpr int ctre::phoenix6::signals::MagnetHealthValue::Magnet_Orange = 2

staticconstexpr

Magnet health is adequate but with reduced accuracy.

Magnet_Red

constexpr int ctre::phoenix6::signals::MagnetHealthValue::Magnet_Red = 1

staticconstexpr

The magnet is too close or too far from the CANcoder.

value

int ctre::phoenix6::signals::MagnetHealthValue::value

---

The documentation for this class was generated from the following file:

• ctre/phoenix6/signals/SpnEnums.hpp