ctre::phoenix6::signals::AppliedRotorPolarityValue Struct Reference

The applied rotor polarity as seen from the front of the motor. More...

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

Inheritance diagram for ctre::phoenix6::signals::AppliedRotorPolarityValue:

Public Member Functions
constexpr	AppliedRotorPolarityValue (int value)
constexpr	AppliedRotorPolarityValue ()
constexpr bool	operator== (AppliedRotorPolarityValue other) const
constexpr auto	operator<=> (AppliedRotorPolarityValue other) const
constexpr std::string_view	ToString () const
	Gets the string representation of this enum.
std::string	Serialize () const override
Public Member Functions inherited from ctre::phoenix6::ISerializable

Public Attributes
int	value

Static Public Attributes
static constexpr int	PositiveIsCounterClockwise = 0
	Positive motor output results in counter-clockwise motion.
static constexpr int	PositiveIsClockwise = 1
	Positive motor output results in clockwise motion.

Friends
CTREXPORT friend std::ostream &	operator<< (std::ostream &os, AppliedRotorPolarityValue data)

Detailed Description

The applied rotor polarity as seen from the front of the motor.

This typically is determined by the Inverted config, but can be overridden if using Follower features.

Constructor & Destructor Documentation

AppliedRotorPolarityValue() [1/2]

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

inlineconstexpr

AppliedRotorPolarityValue() [2/2]

ctre::phoenix6::signals::AppliedRotorPolarityValue::AppliedRotorPolarityValue ( )

inlineconstexpr

Member Function Documentation

operator<=>()

auto ctre::phoenix6::signals::AppliedRotorPolarityValue::operator<=> ( AppliedRotorPolarityValue other ) const

inlineconstexpr

operator==()

bool ctre::phoenix6::signals::AppliedRotorPolarityValue::operator== ( AppliedRotorPolarityValue other ) const

inlineconstexpr

Serialize()

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

inlineoverridevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

std::string_view ctre::phoenix6::signals::AppliedRotorPolarityValue::ToString ( ) const

inlineconstexpr

Gets the string representation of this enum.

Returns

String representation of this enum

Friends And Related Symbol Documentation

operator<<

CTREXPORT friend std::ostream & operator<< ( std::ostream & os, AppliedRotorPolarityValue data )

friend

Member Data Documentation

PositiveIsClockwise

int ctre::phoenix6::signals::AppliedRotorPolarityValue::PositiveIsClockwise = 1

staticconstexpr

Positive motor output results in clockwise motion.

PositiveIsCounterClockwise

int ctre::phoenix6::signals::AppliedRotorPolarityValue::PositiveIsCounterClockwise = 0

staticconstexpr

Positive motor output results in counter-clockwise motion.

value

int ctre::phoenix6::signals::AppliedRotorPolarityValue::value

---

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

• ctre/phoenix6/signals/SpnEnums.hpp