ctre::phoenix6::signals::AppliedRotorPolarityValue Class 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 data) const
constexpr bool	operator== (int data) const
constexpr bool	operator!= (AppliedRotorPolarityValue data) const
constexpr bool	operator!= (int data) const
constexpr bool	operator< (AppliedRotorPolarityValue 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	PositiveIsCounterClockwise = 0
	Positive motor output results in counter-clockwise motion.
static constexpr int	PositiveIsClockwise = 1
	Positive motor output results in clockwise motion.

Friends
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!=() [1/2]

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

inlineconstexpr

operator!=() [2/2]

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

inlineconstexpr

operator<() [1/2]

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

inlineconstexpr

operator<() [2/2]

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

inlineconstexpr

operator==() [1/2]

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

inlineconstexpr

operator==() [2/2]

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

inlineconstexpr

Serialize()

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

inlinevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

std::string ctre::phoenix6::signals::AppliedRotorPolarityValue::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, 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 class was generated from the following file:

• ctre/phoenix6/signals/SpnEnums.hpp