ctre::phoenix6::signals::MotorOutputStatusValue Class Reference

Assess the status of the motor output with respect to load and supply. More...

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

Inheritance diagram for ctre::phoenix6::signals::MotorOutputStatusValue:

Public Member Functions
constexpr	MotorOutputStatusValue (int value)
constexpr	MotorOutputStatusValue ()
constexpr bool	operator== (MotorOutputStatusValue data) const
constexpr bool	operator== (int data) const
constexpr bool	operator!= (MotorOutputStatusValue data) const
constexpr bool	operator!= (int data) const
constexpr bool	operator< (MotorOutputStatusValue data) const
constexpr bool	operator< (int data) const
std::string	ToString () const
	Gets the string representation of this enum.
std::string	Serialize () const
Public Member Functions inherited from ctre::phoenix6::ISerializable

Public Attributes
int	value

Static Public Attributes
static constexpr int	Unknown = 0
	The status of motor output could not be determined.
static constexpr int	Off = 1
	Motor output is disabled.
static constexpr int	StaticBraking = 2
	The motor is in neutral-brake.
static constexpr int	Motoring = 3
	The motor is loaded in a typical fashion, drawing current from the supply, and successfully turning the rotor in the direction of applied voltage.
static constexpr int	DiscordantMotoring = 4
	The same as Motoring, except the rotor is being backdriven as the motor output is not enough to defeat load forces.
static constexpr int	RegenBraking = 5
	The motor is braking in such a way where motor current is traveling back to the supply (typically a battery).

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

Detailed Description

Assess the status of the motor output with respect to load and supply.

This routine can be used to determine the general status of motor commutation.

Constructor & Destructor Documentation

MotorOutputStatusValue() [1/2]

ctre::phoenix6::signals::MotorOutputStatusValue::MotorOutputStatusValue ( int value )

inlineconstexpr

MotorOutputStatusValue() [2/2]

ctre::phoenix6::signals::MotorOutputStatusValue::MotorOutputStatusValue ( )

inlineconstexpr

Member Function Documentation

operator!=() [1/2]

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

inlineconstexpr

operator!=() [2/2]

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

inlineconstexpr

operator<() [1/2]

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

inlineconstexpr

operator<() [2/2]

bool ctre::phoenix6::signals::MotorOutputStatusValue::operator< ( MotorOutputStatusValue data ) const

inlineconstexpr

operator==() [1/2]

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

inlineconstexpr

operator==() [2/2]

bool ctre::phoenix6::signals::MotorOutputStatusValue::operator== ( MotorOutputStatusValue data ) const

inlineconstexpr

Serialize()

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

inlinevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

std::string ctre::phoenix6::signals::MotorOutputStatusValue::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, MotorOutputStatusValue data )

friend

Member Data Documentation

DiscordantMotoring

int ctre::phoenix6::signals::MotorOutputStatusValue::DiscordantMotoring = 4

staticconstexpr

The same as Motoring, except the rotor is being backdriven as the motor output is not enough to defeat load forces.

Motoring

int ctre::phoenix6::signals::MotorOutputStatusValue::Motoring = 3

staticconstexpr

The motor is loaded in a typical fashion, drawing current from the supply, and successfully turning the rotor in the direction of applied voltage.

Off

int ctre::phoenix6::signals::MotorOutputStatusValue::Off = 1

staticconstexpr

Motor output is disabled.

RegenBraking

int ctre::phoenix6::signals::MotorOutputStatusValue::RegenBraking = 5

staticconstexpr

The motor is braking in such a way where motor current is traveling back to the supply (typically a battery).

StaticBraking

int ctre::phoenix6::signals::MotorOutputStatusValue::StaticBraking = 2

staticconstexpr

The motor is in neutral-brake.

Unknown

int ctre::phoenix6::signals::MotorOutputStatusValue::Unknown = 0

staticconstexpr

The status of motor output could not be determined.

value

int ctre::phoenix6::signals::MotorOutputStatusValue::value

---

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

• ctre/phoenix6/signals/SpnEnums.hpp