ctre::phoenix6::signals::LarsonBounceValue Class Reference

The behavior of the larson animation pocket of light when it reaches the end of the strip. More...

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

Inheritance diagram for ctre::phoenix6::signals::LarsonBounceValue:

Public Member Functions
constexpr	LarsonBounceValue (int value)
constexpr	LarsonBounceValue ()
constexpr bool	operator== (LarsonBounceValue data) const
constexpr bool	operator== (int data) const
constexpr bool	operator!= (LarsonBounceValue data) const
constexpr bool	operator!= (int data) const
constexpr bool	operator< (LarsonBounceValue data) const
constexpr bool	operator< (int data) const
std::string	ToString () const
	Gets the string representation of this enum.
std::string	Serialize () const
Public Member Functions inherited from ctre::phoenix6::ISerializable

Public Attributes
int	value

Static Public Attributes
static constexpr int	Front = 0
	The animation bounces as soon as the first LED reaches the end of the strip.
static constexpr int	Center = 1
	The animation bounces once it is midway through the end of the strip.
static constexpr int	Back = 2
	The animation bounces once all LEDs are off the strip.

Friends
std::ostream &	operator<< (std::ostream &os, LarsonBounceValue data)

Detailed Description

The behavior of the larson animation pocket of light when it reaches the end of the strip.

Constructor & Destructor Documentation

LarsonBounceValue() [1/2]

ctre::phoenix6::signals::LarsonBounceValue::LarsonBounceValue ( int value )

inlineconstexpr

LarsonBounceValue() [2/2]

ctre::phoenix6::signals::LarsonBounceValue::LarsonBounceValue ( )

inlineconstexpr

Member Function Documentation

operator!=() [1/2]

bool ctre::phoenix6::signals::LarsonBounceValue::operator!= ( int data ) const

inlineconstexpr

operator!=() [2/2]

bool ctre::phoenix6::signals::LarsonBounceValue::operator!= ( LarsonBounceValue data ) const

inlineconstexpr

operator<() [1/2]

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

inlineconstexpr

operator<() [2/2]

bool ctre::phoenix6::signals::LarsonBounceValue::operator< ( LarsonBounceValue data ) const

inlineconstexpr

operator==() [1/2]

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

inlineconstexpr

operator==() [2/2]

bool ctre::phoenix6::signals::LarsonBounceValue::operator== ( LarsonBounceValue data ) const

inlineconstexpr

Serialize()

std::string ctre::phoenix6::signals::LarsonBounceValue::Serialize ( ) const

inlinevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

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

friend

Member Data Documentation

Back

int ctre::phoenix6::signals::LarsonBounceValue::Back = 2

staticconstexpr

The animation bounces once all LEDs are off the strip.

Center

int ctre::phoenix6::signals::LarsonBounceValue::Center = 1

staticconstexpr

The animation bounces once it is midway through the end of the strip.

Front

int ctre::phoenix6::signals::LarsonBounceValue::Front = 0

staticconstexpr

The animation bounces as soon as the first LED reaches the end of the strip.

value

int ctre::phoenix6::signals::LarsonBounceValue::value

---

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

• ctre/phoenix6/signals/SpnEnums.hpp