CTRE Phoenix 6 C++ 25.0.0-beta-4
Loading...
Searching...
No Matches
ctre::phoenix6::signals::SensorDirectionValue Class Reference

Direction of the sensor to determine positive rotation, as seen facing the LED side of the CANcoder. More...

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

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

Public Member Functions

constexpr SensorDirectionValue (int value)
 
constexpr SensorDirectionValue ()
 
constexpr bool operator== (SensorDirectionValue data) const
 
constexpr bool operator== (int data) const
 
constexpr bool operator!= (SensorDirectionValue data) const
 
constexpr bool operator!= (int data) const
 
constexpr bool operator< (SensorDirectionValue data) const
 
constexpr bool operator< (int data) const
 
std::string ToString () const
 Gets the string representation of this enum.
 
std::string Serialize () const
 

Public Attributes

int value
 

Static Public Attributes

static constexpr int CounterClockwise_Positive = 0
 Counter-clockwise motion reports positive rotation.
 
static constexpr int Clockwise_Positive = 1
 Clockwise motion reports positive rotation.
 

Friends

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

Detailed Description

Direction of the sensor to determine positive rotation, as seen facing the LED side of the CANcoder.

Constructor & Destructor Documentation

◆ SensorDirectionValue() [1/2]

constexpr ctre::phoenix6::signals::SensorDirectionValue::SensorDirectionValue ( int value)
inlineconstexpr

◆ SensorDirectionValue() [2/2]

constexpr ctre::phoenix6::signals::SensorDirectionValue::SensorDirectionValue ( )
inlineconstexpr

Member Function Documentation

◆ operator!=() [1/2]

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

◆ operator!=() [2/2]

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

◆ operator<() [1/2]

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

◆ operator<() [2/2]

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

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

◆ Serialize()

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

◆ ToString()

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

Member Data Documentation

◆ Clockwise_Positive

constexpr int ctre::phoenix6::signals::SensorDirectionValue::Clockwise_Positive = 1
staticconstexpr

Clockwise motion reports positive rotation.

◆ CounterClockwise_Positive

constexpr int ctre::phoenix6::signals::SensorDirectionValue::CounterClockwise_Positive = 0
staticconstexpr

Counter-clockwise motion reports positive rotation.

◆ value

int ctre::phoenix6::signals::SensorDirectionValue::value

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