CTRE Phoenix 6 C++ 26.0.0-beta-1
Loading...
Searching...
No Matches
ctre::phoenix6::signals::InvertedValue Struct Reference

Invert state of the device as seen from the front of the motor. More...

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

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

Public Member Functions

constexpr InvertedValue (int value)
 
constexpr InvertedValue ()
 
constexpr bool operator== (InvertedValue other) const
 
constexpr auto operator<=> (InvertedValue other) const
 
constexpr std::string_view ToString () const
 Gets the string representation of this enum.
 
std::string Serialize () const override
 
- Public Member Functions inherited from ctre::phoenix6::ISerializable

Public Attributes

int value
 

Static Public Attributes

static constexpr int CounterClockwise_Positive = 0
 Positive motor output results in counter-clockwise motion.
 
static constexpr int Clockwise_Positive = 1
 Positive motor output results in clockwise motion.
 

Friends

CTREXPORT friend std::ostream & operator<< (std::ostream &os, InvertedValue data)
 

Detailed Description

Invert state of the device as seen from the front of the motor.

Constructor & Destructor Documentation

◆ InvertedValue() [1/2]

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

◆ InvertedValue() [2/2]

ctre::phoenix6::signals::InvertedValue::InvertedValue ( )
inlineconstexpr

Member Function Documentation

◆ operator<=>()

auto ctre::phoenix6::signals::InvertedValue::operator<=> ( InvertedValue other) const
inlineconstexpr

◆ operator==()

bool ctre::phoenix6::signals::InvertedValue::operator== ( InvertedValue other) const
inlineconstexpr

◆ Serialize()

std::string ctre::phoenix6::signals::InvertedValue::Serialize ( ) const
inlineoverridevirtual

◆ ToString()

std::string_view ctre::phoenix6::signals::InvertedValue::ToString ( ) const
inlineconstexpr

Gets the string representation of this enum.

Returns
String representation of this enum

Friends And Related Symbol Documentation

◆ operator<<

CTREXPORT friend std::ostream & operator<< ( std::ostream & os,
InvertedValue data )
friend

Member Data Documentation

◆ Clockwise_Positive

int ctre::phoenix6::signals::InvertedValue::Clockwise_Positive = 1
staticconstexpr

Positive motor output results in clockwise motion.

◆ CounterClockwise_Positive

int ctre::phoenix6::signals::InvertedValue::CounterClockwise_Positive = 0
staticconstexpr

Positive motor output results in counter-clockwise motion.

◆ value

int ctre::phoenix6::signals::InvertedValue::value

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