ctre::phoenix6::signals::DifferentialSensorSourceValue Class Reference

Choose what sensor source is used for differential control of a mechanism. More...

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

Inheritance diagram for ctre::phoenix6::signals::DifferentialSensorSourceValue:

Public Member Functions
	DifferentialSensorSourceValue (int value)
	DifferentialSensorSourceValue ()
std::string	ToString () const
	Gets the string representation of this enum. More...
std::string	Serialize () const
bool	operator== (const DifferentialSensorSourceValue &data) const
bool	operator== (int data) const
bool	operator< (const DifferentialSensorSourceValue &data) const
bool	operator< (int data) const
virtual std::string	Serialize () const =0

Public Attributes
int	value

Static Public Attributes
static constexpr int	Disabled = 0
static constexpr int	RemoteTalonFX_Diff = 1
static constexpr int	RemotePigeon2_Yaw = 2
static constexpr int	RemotePigeon2_Pitch = 3
static constexpr int	RemotePigeon2_Roll = 4
static constexpr int	RemoteCANcoder = 5

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

Detailed Description

Choose what sensor source is used for differential control of a mechanism.

The default is Disabled. All other options require setting the DifferentialTalonFXSensorID, as the average of this Talon FX's sensor and the remote TalonFX's sensor is used for the differential controller's primary targets.

Choose RemoteTalonFX_Diff to use another TalonFX on the same CAN bus. Talon FX will update its differential position and velocity whenever the remote TalonFX publishes its information on CAN bus. The differential controller will use the difference between this TalonFX's sensor and the remote Talon FX's sensor for the differential component of the output.

Choose RemotePigeon2_Yaw, RemotePigeon2_Pitch, and RemotePigeon2_Roll to use another Pigeon2 on the same CAN bus (this also requires setting DifferentialRemoteSensorID). Talon FX will update its differential position to match the selected value whenever Pigeon2 publishes its information on CAN bus. Note that the Talon FX differential position will be in rotations and not degrees.

Choose RemoteCANcoder to use another CANcoder on the same CAN bus (this also requires setting DifferentialRemoteSensorID). Talon FX will update its differential position and velocity to match the CANcoder whenever CANcoder publishes its information on CAN bus.

Constructor & Destructor Documentation

DifferentialSensorSourceValue() [1/2]

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

inline

DifferentialSensorSourceValue() [2/2]

ctre::phoenix6::signals::DifferentialSensorSourceValue::DifferentialSensorSourceValue ( )

inline

Member Function Documentation

operator<() [1/2]

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

inline

operator<() [2/2]

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

inline

operator==() [1/2]

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

inline

operator==() [2/2]

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

inline

Serialize()

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

inlinevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

std::string ctre::phoenix6::signals::DifferentialSensorSourceValue::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 DifferentialSensorSourceValue &  data  )

friend

Member Data Documentation

Disabled

constexpr int ctre::phoenix6::signals::DifferentialSensorSourceValue::Disabled = 0

staticconstexpr

RemoteCANcoder

constexpr int ctre::phoenix6::signals::DifferentialSensorSourceValue::RemoteCANcoder = 5

staticconstexpr

RemotePigeon2_Pitch

constexpr int ctre::phoenix6::signals::DifferentialSensorSourceValue::RemotePigeon2_Pitch = 3

staticconstexpr

RemotePigeon2_Roll

constexpr int ctre::phoenix6::signals::DifferentialSensorSourceValue::RemotePigeon2_Roll = 4

staticconstexpr

RemotePigeon2_Yaw

constexpr int ctre::phoenix6::signals::DifferentialSensorSourceValue::RemotePigeon2_Yaw = 2

staticconstexpr

RemoteTalonFX_Diff

constexpr int ctre::phoenix6::signals::DifferentialSensorSourceValue::RemoteTalonFX_Diff = 1

staticconstexpr

value

int ctre::phoenix6::signals::DifferentialSensorSourceValue::value

---

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

• ctre/phoenix6/signals/SpnEnums.hpp