CTRE Phoenix 6 C++ 24.3.0
Public Member Functions | Public Attributes | Static Public Attributes | Friends | List of all members
ctre::phoenix6::signals::ForwardLimitSourceValue Class Reference

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

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

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

Public Member Functions

 ForwardLimitSourceValue (int value)
 
 ForwardLimitSourceValue ()
 
std::string ToString () const
 Gets the string representation of this enum. More...
 
std::string Serialize () const
 
bool operator== (const ForwardLimitSourceValue &data) const
 
bool operator== (int data) const
 
bool operator< (const ForwardLimitSourceValue &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 ForwardLimitSourceValue &data)
 

Detailed Description

Determines where to poll the forward limit switch.

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

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

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

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

Constructor & Destructor Documentation

◆ ForwardLimitSourceValue() [1/2]

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

◆ ForwardLimitSourceValue() [2/2]

ctre::phoenix6::signals::ForwardLimitSourceValue::ForwardLimitSourceValue ( )
inline

Member Function Documentation

◆ operator<() [1/2]

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

◆ operator<() [2/2]

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

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

◆ Serialize()

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

Implements ctre::phoenix6::ISerializable.

◆ ToString()

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

Member Data Documentation

◆ Disabled

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

◆ LimitSwitchPin

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

◆ RemoteCANcoder

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

◆ RemoteCANifier

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

◆ RemoteTalonFX

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

◆ value

int ctre::phoenix6::signals::ForwardLimitSourceValue::value
The documentation for this class was generated from the following file: