CTRE Phoenix 6 C++ 25.2.1
Loading...
Searching...
No Matches
ctre::phoenix6::signals::S1FloatStateValue Class Reference

The floating state of the Signal 1 input (S1IN). More...

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

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

Public Member Functions

constexpr S1FloatStateValue (int value)
 
constexpr S1FloatStateValue ()
 
constexpr bool operator== (S1FloatStateValue data) const
 
constexpr bool operator== (int data) const
 
constexpr bool operator!= (S1FloatStateValue data) const
 
constexpr bool operator!= (int data) const
 
constexpr bool operator< (S1FloatStateValue 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 FloatDetect = 0
 The input will attempt to detect when it is floating.
 
static constexpr int PullHigh = 1
 The input will be pulled high when not loaded by an outside device.
 
static constexpr int PullLow = 2
 The input will be pulled low when not loaded by an outside device.
 
static constexpr int BusKeeper = 3
 The input will pull in the direction of the last measured state.
 

Friends

std::ostream & operator<< (std::ostream &os, S1FloatStateValue data)
 

Detailed Description

The floating state of the Signal 1 input (S1IN).

Constructor & Destructor Documentation

◆ S1FloatStateValue() [1/2]

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

◆ S1FloatStateValue() [2/2]

ctre::phoenix6::signals::S1FloatStateValue::S1FloatStateValue ( )
inlineconstexpr

Member Function Documentation

◆ operator!=() [1/2]

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

◆ operator!=() [2/2]

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

◆ operator<() [1/2]

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

◆ operator<() [2/2]

bool ctre::phoenix6::signals::S1FloatStateValue::operator< ( S1FloatStateValue data) const
inlineconstexpr

◆ operator==() [1/2]

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

◆ operator==() [2/2]

bool ctre::phoenix6::signals::S1FloatStateValue::operator== ( S1FloatStateValue data) const
inlineconstexpr

◆ Serialize()

std::string ctre::phoenix6::signals::S1FloatStateValue::Serialize ( ) const
inlinevirtual

◆ ToString()

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

Member Data Documentation

◆ BusKeeper

int ctre::phoenix6::signals::S1FloatStateValue::BusKeeper = 3
staticconstexpr

The input will pull in the direction of the last measured state.

This may be useful for devices that can enter into a high-Z tri-state.

◆ FloatDetect

int ctre::phoenix6::signals::S1FloatStateValue::FloatDetect = 0
staticconstexpr

The input will attempt to detect when it is floating.

This is enabled by default.

◆ PullHigh

int ctre::phoenix6::signals::S1FloatStateValue::PullHigh = 1
staticconstexpr

The input will be pulled high when not loaded by an outside device.

This is useful for NPN-style devices.

◆ PullLow

int ctre::phoenix6::signals::S1FloatStateValue::PullLow = 2
staticconstexpr

The input will be pulled low when not loaded by an outside device.

This is useful for PNP-style devices.

◆ value

int ctre::phoenix6::signals::S1FloatStateValue::value

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