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

State of the Signal 2 input (S2IN). More...

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

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

Public Member Functions

constexpr S2StateValue (int value)
 
constexpr S2StateValue ()
 
constexpr bool operator== (S2StateValue other) const
 
constexpr auto operator<=> (S2StateValue 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 Floating = 0
 Input is not driven high or low, it is disconnected from load.
 
static constexpr int Low = 1
 Input is driven low (below 0.5V).
 
static constexpr int High = 2
 Input is driven high (above 3V).
 

Friends

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

Detailed Description

State of the Signal 2 input (S2IN).

Constructor & Destructor Documentation

◆ S2StateValue() [1/2]

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

◆ S2StateValue() [2/2]

ctre::phoenix6::signals::S2StateValue::S2StateValue ( )
inlineconstexpr

Member Function Documentation

◆ operator<=>()

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

◆ operator==()

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

◆ Serialize()

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

◆ ToString()

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

Member Data Documentation

◆ Floating

int ctre::phoenix6::signals::S2StateValue::Floating = 0
staticconstexpr

Input is not driven high or low, it is disconnected from load.

◆ High

int ctre::phoenix6::signals::S2StateValue::High = 2
staticconstexpr

Input is driven high (above 3V).

◆ Low

int ctre::phoenix6::signals::S2StateValue::Low = 1
staticconstexpr

Input is driven low (below 0.5V).

◆ value

int ctre::phoenix6::signals::S2StateValue::value

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