CTRE Phoenix 6 C++ 25.3.1
Loading...
Searching...
No Matches
ctre::phoenix6::signals::BrushedMotorWiringValue Class Reference

If a brushed motor is selected with Motor Arrangement, this config determines which of three leads to use. More...

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

Inheritance diagram for ctre::phoenix6::signals::BrushedMotorWiringValue:
ctre::phoenix6::ISerializable

Public Member Functions

constexpr BrushedMotorWiringValue (int value)
 
constexpr BrushedMotorWiringValue ()
 
constexpr bool operator== (BrushedMotorWiringValue data) const
 
constexpr bool operator== (int data) const
 
constexpr bool operator!= (BrushedMotorWiringValue data) const
 
constexpr bool operator!= (int data) const
 
constexpr bool operator< (BrushedMotorWiringValue 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 Leads_A_and_B = 0
 Third party brushed DC motor with two leads.
 
static constexpr int Leads_A_and_C = 1
 Third party brushed DC motor with two leads.
 
static constexpr int Leads_B_and_C = 2
 Third party brushed DC motor with two leads.
 

Friends

std::ostream & operator<< (std::ostream &os, BrushedMotorWiringValue data)
 

Detailed Description

If a brushed motor is selected with Motor Arrangement, this config determines which of three leads to use.

Constructor & Destructor Documentation

◆ BrushedMotorWiringValue() [1/2]

ctre::phoenix6::signals::BrushedMotorWiringValue::BrushedMotorWiringValue ( int value)
inlineconstexpr

◆ BrushedMotorWiringValue() [2/2]

ctre::phoenix6::signals::BrushedMotorWiringValue::BrushedMotorWiringValue ( )
inlineconstexpr

Member Function Documentation

◆ operator!=() [1/2]

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

◆ operator!=() [2/2]

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

◆ operator<() [1/2]

bool ctre::phoenix6::signals::BrushedMotorWiringValue::operator< ( BrushedMotorWiringValue data) const
inlineconstexpr

◆ operator<() [2/2]

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

◆ operator==() [1/2]

bool ctre::phoenix6::signals::BrushedMotorWiringValue::operator== ( BrushedMotorWiringValue data) const
inlineconstexpr

◆ operator==() [2/2]

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

◆ Serialize()

std::string ctre::phoenix6::signals::BrushedMotorWiringValue::Serialize ( ) const
inlinevirtual

◆ ToString()

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

Member Data Documentation

◆ Leads_A_and_B

int ctre::phoenix6::signals::BrushedMotorWiringValue::Leads_A_and_B = 0
staticconstexpr

Third party brushed DC motor with two leads.

Motor leads: Use terminal A for the motor red lead and terminal B for the motor black lead (motor leads may be flipped to correct for clockwise vs counterclockwise). Note that the invert configuration can still be used to invert rotor orientation. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

◆ Leads_A_and_C

int ctre::phoenix6::signals::BrushedMotorWiringValue::Leads_A_and_C = 1
staticconstexpr

Third party brushed DC motor with two leads.

Motor leads: Use terminal A for the motor red lead and terminal C for the motor black lead (motor leads may be flipped to correct for clockwise vs counterclockwise). Note that the invert configuration can still be used to reverse rotor orientation. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

◆ Leads_B_and_C

int ctre::phoenix6::signals::BrushedMotorWiringValue::Leads_B_and_C = 2
staticconstexpr

Third party brushed DC motor with two leads.

Motor leads: Use terminal B for the motor red lead and terminal C for the motor black lead (motor leads may be flipped to correct for clockwise vs counterclockwise). Note that the invert configuration can still be used to reverse rotor orientation. Gadgeteer Connector: quadrature [A, B] are on pins [7, 5], limit [forward, reverse] are on pins [4, 8], and pulse width position is on pin [9].

◆ value

int ctre::phoenix6::signals::BrushedMotorWiringValue::value

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