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

Whether the 5V rail is enabled. More...

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

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

Public Member Functions

constexpr Enable5VRailValue (int value)
 
constexpr Enable5VRailValue ()
 
constexpr bool operator== (Enable5VRailValue other) const
 
constexpr auto operator<=> (Enable5VRailValue 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 Enabled = 0
 The 5V rail is enabled, allowing for LED control.
 
static constexpr int Disabled = 1
 The 5V rail is disabled.
 

Friends

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

Detailed Description

Whether the 5V rail is enabled.

Disabling the 5V rail will also turn off the onboard LEDs.

Constructor & Destructor Documentation

◆ Enable5VRailValue() [1/2]

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

◆ Enable5VRailValue() [2/2]

ctre::phoenix6::signals::Enable5VRailValue::Enable5VRailValue ( )
inlineconstexpr

Member Function Documentation

◆ operator<=>()

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

◆ operator==()

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

◆ Serialize()

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

◆ ToString()

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

Member Data Documentation

◆ Disabled

int ctre::phoenix6::signals::Enable5VRailValue::Disabled = 1
staticconstexpr

The 5V rail is disabled.

This will also turn off the onboard LEDs.

◆ Enabled

int ctre::phoenix6::signals::Enable5VRailValue::Enabled = 0
staticconstexpr

The 5V rail is enabled, allowing for LED control.

◆ value

int ctre::phoenix6::signals::Enable5VRailValue::value

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