CTRE Phoenix 6 C++ 24.2.0
ctre::phoenix6::signals::AppliedRotorPolarityValue Class Reference

The applied rotor polarity. More...

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

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

Public Member Functions

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

Public Attributes

int value
 

Static Public Attributes

static constexpr int PositiveIsCounterClockwise = 0
 
static constexpr int PositiveIsClockwise = 1
 

Friends

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

Detailed Description

The applied rotor polarity.

This typically is determined by the Inverted config, but can be overridden if using Follower features.

Constructor & Destructor Documentation

◆ AppliedRotorPolarityValue() [1/2]

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

◆ AppliedRotorPolarityValue() [2/2]

ctre::phoenix6::signals::AppliedRotorPolarityValue::AppliedRotorPolarityValue ( )
inline

Member Function Documentation

◆ operator<() [1/2]

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

◆ operator<() [2/2]

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

◆ operator==() [1/2]

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

◆ operator==() [2/2]

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

◆ Serialize()

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

◆ ToString()

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

Member Data Documentation

◆ PositiveIsClockwise

constexpr int ctre::phoenix6::signals::AppliedRotorPolarityValue::PositiveIsClockwise = 1
staticconstexpr

◆ PositiveIsCounterClockwise

constexpr int ctre::phoenix6::signals::AppliedRotorPolarityValue::PositiveIsCounterClockwise = 0
staticconstexpr

◆ value

int ctre::phoenix6::signals::AppliedRotorPolarityValue::value

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