ctre::phoenix6::signals::S2CloseStateValue Class Reference

What value the Signal 2 input (S2IN) needs to be for the CANdi to detect as Closed. More...

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

Inheritance diagram for ctre::phoenix6::signals::S2CloseStateValue:

Public Member Functions
constexpr	S2CloseStateValue (int value)
constexpr	S2CloseStateValue ()
constexpr bool	operator== (S2CloseStateValue data) const
constexpr bool	operator== (int data) const
constexpr bool	operator!= (S2CloseStateValue data) const
constexpr bool	operator!= (int data) const
constexpr bool	operator< (S2CloseStateValue 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	CloseWhenNotFloating = 0
	The S2 input will be treated as closed when it is not floating.
static constexpr int	CloseWhenFloating = 1
	The S2 input will be treated as closed when it is floating.
static constexpr int	CloseWhenNotHigh = 2
	The S2 input will be treated as closed when it is not High.
static constexpr int	CloseWhenHigh = 3
	The S2 input will be treated as closed when it is High.
static constexpr int	CloseWhenNotLow = 4
	The S2 input will be treated as closed when it is not Low.
static constexpr int	CloseWhenLow = 5
	The S2 input will be treated as closed when it is Low.

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

Detailed Description

What value the Signal 2 input (S2IN) needs to be for the CANdi to detect as Closed.

Devices using the S2 input as a remote limit switch will treat the switch as closed when the S2 input is this state.

Constructor & Destructor Documentation

S2CloseStateValue() [1/2]

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

inlineconstexpr

S2CloseStateValue() [2/2]

ctre::phoenix6::signals::S2CloseStateValue::S2CloseStateValue ( )

inlineconstexpr

Member Function Documentation

operator!=() [1/2]

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

inlineconstexpr

operator!=() [2/2]

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

inlineconstexpr

operator<() [1/2]

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

inlineconstexpr

operator<() [2/2]

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

inlineconstexpr

operator==() [1/2]

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

inlineconstexpr

operator==() [2/2]

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

inlineconstexpr

Serialize()

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

inlinevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

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

friend

Member Data Documentation

CloseWhenFloating

int ctre::phoenix6::signals::S2CloseStateValue::CloseWhenFloating = 1

staticconstexpr

The S2 input will be treated as closed when it is floating.

CloseWhenHigh

int ctre::phoenix6::signals::S2CloseStateValue::CloseWhenHigh = 3

staticconstexpr

The S2 input will be treated as closed when it is High.

CloseWhenLow

int ctre::phoenix6::signals::S2CloseStateValue::CloseWhenLow = 5

staticconstexpr

The S2 input will be treated as closed when it is Low.

CloseWhenNotFloating

int ctre::phoenix6::signals::S2CloseStateValue::CloseWhenNotFloating = 0

staticconstexpr

The S2 input will be treated as closed when it is not floating.

CloseWhenNotHigh

int ctre::phoenix6::signals::S2CloseStateValue::CloseWhenNotHigh = 2

staticconstexpr

The S2 input will be treated as closed when it is not High.

CloseWhenNotLow

int ctre::phoenix6::signals::S2CloseStateValue::CloseWhenNotLow = 4

staticconstexpr

The S2 input will be treated as closed when it is not Low.

value

int ctre::phoenix6::signals::S2CloseStateValue::value

---

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

• ctre/phoenix6/signals/SpnEnums.hpp