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

Direction of the animation. More...

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

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

Public Member Functions

constexpr AnimationDirectionValue (int value)
 
constexpr AnimationDirectionValue ()
 
constexpr bool operator== (AnimationDirectionValue other) const
 
constexpr auto operator<=> (AnimationDirectionValue 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 Forward = 0
 The animation starts at the specified LED start index and moves towards the LED end index.
 
static constexpr int Backward = 1
 The animation starts at the specified LED end index and moves towards the LED start index.
 

Friends

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

Detailed Description

Direction of the animation.

Constructor & Destructor Documentation

◆ AnimationDirectionValue() [1/2]

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

◆ AnimationDirectionValue() [2/2]

ctre::phoenix6::signals::AnimationDirectionValue::AnimationDirectionValue ( )
inlineconstexpr

Member Function Documentation

◆ operator<=>()

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

◆ operator==()

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

◆ Serialize()

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

◆ ToString()

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

Member Data Documentation

◆ Backward

int ctre::phoenix6::signals::AnimationDirectionValue::Backward = 1
staticconstexpr

The animation starts at the specified LED end index and moves towards the LED start index.

◆ Forward

int ctre::phoenix6::signals::AnimationDirectionValue::Forward = 0
staticconstexpr

The animation starts at the specified LED start index and moves towards the LED end index.

◆ value

int ctre::phoenix6::signals::AnimationDirectionValue::value

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