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
	MotorOutputStatusValue (int value)
	MotorOutputStatusValue ()
std::string	ToString () const
	Gets the string representation of this enum. More...
std::string	Serialize () const
bool	operator== (const MotorOutputStatusValue &data) const
bool	operator== (int data) const
bool	operator< (const MotorOutputStatusValue &data) const
bool	operator< (int data) const
virtual std::string	Serialize () const =0

Public Attributes
int	value

Static Public Attributes
static constexpr int	Unknown = 0
static constexpr int	Off = 1
static constexpr int	StaticBraking = 2
static constexpr int	Motoring = 3
static constexpr int	DiscordantMotoring = 4
static constexpr int	RegenBraking = 5

Friends
std::ostream &	operator<< (std::ostream &os, const 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. Off means that motor output is disabled. StaticBraking typically means the motor is in neutral-brake. Motoring means motor is loaded in a typical fashion, drawing current from the supply, and successfully turning the rotor in the direction of applied voltage. Discordant Motoring is the same as Motoring, expect the rotor is being backdriven as the motor output is not enough to defeat load forces. RegenBraking means the motor is braking in such a way where motor current is traveling back to the supply (typically a battery).

Constructor & Destructor Documentation

MotorOutputStatusValue() [1/2]

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

inline

MotorOutputStatusValue() [2/2]

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

inline

Member Function Documentation

operator<() [1/2]

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

inline

operator<() [2/2]

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

inline

operator==() [1/2]

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

inline

operator==() [2/2]

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

inline

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 Function Documentation

operator<<

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

friend

Member Data Documentation

DiscordantMotoring

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

staticconstexpr

Motoring

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

staticconstexpr

Off

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

staticconstexpr

RegenBraking

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

staticconstexpr

StaticBraking

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

staticconstexpr

Unknown

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

staticconstexpr

value

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

---

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

• ctre/phoenix6/signals/SpnEnums.hpp