CTRE Phoenix 6 C++ 24.3.0
ctre::phoenix6::signals::ReverseLimitSourceValue Class Reference

Determines where to poll the reverse limit switch. More...

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

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

Public Member Functions

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

Public Attributes

int value
 

Static Public Attributes

static constexpr int LimitSwitchPin = 0
 
static constexpr int RemoteTalonFX = 1
 
static constexpr int RemoteCANifier = 2
 
static constexpr int RemoteCANcoder = 4
 
static constexpr int Disabled = 3
 

Friends

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

Detailed Description

Determines where to poll the reverse limit switch.

This defaults to the reverse limit switch pin on the limit switch connector.

Choose RemoteTalonFX to use the reverse limit switch attached to another Talon FX on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

Choose RemoteCANifier to use the reverse limit switch attached to another CANifier on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID).

Choose RemoteCANcoder to use another CANcoder on the same CAN bus (this also requires setting ReverseLimitRemoteSensorID). The reverse limit will assert when the CANcoder magnet strength changes from BAD (red) to ADEQUATE (orange) or GOOD (green).

Constructor & Destructor Documentation

◆ ReverseLimitSourceValue() [1/2]

ctre::phoenix6::signals::ReverseLimitSourceValue::ReverseLimitSourceValue ( int  value)
inline

◆ ReverseLimitSourceValue() [2/2]

ctre::phoenix6::signals::ReverseLimitSourceValue::ReverseLimitSourceValue ( )
inline

Member Function Documentation

◆ operator<() [1/2]

bool ctre::phoenix6::signals::ReverseLimitSourceValue::operator< ( const ReverseLimitSourceValue data) const
inline

◆ operator<() [2/2]

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

◆ operator==() [1/2]

bool ctre::phoenix6::signals::ReverseLimitSourceValue::operator== ( const ReverseLimitSourceValue data) const
inline

◆ operator==() [2/2]

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

◆ Serialize()

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

◆ ToString()

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

Member Data Documentation

◆ Disabled

constexpr int ctre::phoenix6::signals::ReverseLimitSourceValue::Disabled = 3
staticconstexpr

◆ LimitSwitchPin

constexpr int ctre::phoenix6::signals::ReverseLimitSourceValue::LimitSwitchPin = 0
staticconstexpr

◆ RemoteCANcoder

constexpr int ctre::phoenix6::signals::ReverseLimitSourceValue::RemoteCANcoder = 4
staticconstexpr

◆ RemoteCANifier

constexpr int ctre::phoenix6::signals::ReverseLimitSourceValue::RemoteCANifier = 2
staticconstexpr

◆ RemoteTalonFX

constexpr int ctre::phoenix6::signals::ReverseLimitSourceValue::RemoteTalonFX = 1
staticconstexpr

◆ value

int ctre::phoenix6::signals::ReverseLimitSourceValue::value

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