ctre::phoenix6::signals::MotorAlignmentValue Struct Reference

The relationship between two motors in a mechanism. More...

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

Inheritance diagram for ctre::phoenix6::signals::MotorAlignmentValue:

Public Member Functions
constexpr	MotorAlignmentValue (int value)
constexpr	MotorAlignmentValue ()
constexpr bool	operator== (MotorAlignmentValue other) const
constexpr auto	operator<=> (MotorAlignmentValue 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	Aligned = 0
	The two motor directions are aligned.
static constexpr int	Opposed = 1
	The two motor directions are opposed.

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

Detailed Description

The relationship between two motors in a mechanism.

Depending on hardware setup, one motor may be inverted relative to the other motor.

Constructor & Destructor Documentation

MotorAlignmentValue() [1/2]

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

inlineconstexpr

MotorAlignmentValue() [2/2]

ctre::phoenix6::signals::MotorAlignmentValue::MotorAlignmentValue ( )

inlineconstexpr

Member Function Documentation

operator<=>()

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

inlineconstexpr

operator==()

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

inlineconstexpr

Serialize()

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

inlineoverridevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

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

friend

Member Data Documentation

Aligned

int ctre::phoenix6::signals::MotorAlignmentValue::Aligned = 0

staticconstexpr

The two motor directions are aligned.

Positive output on both motors moves the mechanism forward/backward.

Opposed

int ctre::phoenix6::signals::MotorAlignmentValue::Opposed = 1

staticconstexpr

The two motor directions are opposed.

To move forward/backward, one motor needs positive output, and the other needs negative output.

value

int ctre::phoenix6::signals::MotorAlignmentValue::value

---

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

• ctre/phoenix6/signals/SpnEnums.hpp