ctre::phoenix6::signals::UpdateModeValue Struct Reference

Update mode of the CANrange. More...

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

Inheritance diagram for ctre::phoenix6::signals::UpdateModeValue:

Public Member Functions
constexpr	UpdateModeValue (int value)
constexpr	UpdateModeValue ()
constexpr bool	operator== (UpdateModeValue other) const
constexpr auto	operator<=> (UpdateModeValue 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	ShortRange100Hz = 0
	Updates distance/proximity at 100hz using short-range detection mode.
static constexpr int	ShortRangeUserFreq = 1
	Uses short-range detection mode for improved detection under high ambient infrared light conditions.
static constexpr int	LongRangeUserFreq = 2
	Uses long-range detection mode and user-specified update frequency.

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

Detailed Description

Update mode of the CANrange.

The CANrange supports short-range and long-range detection at various update frequencies.

Constructor & Destructor Documentation

UpdateModeValue() [1/2]

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

inlineconstexpr

UpdateModeValue() [2/2]

ctre::phoenix6::signals::UpdateModeValue::UpdateModeValue ( )

inlineconstexpr

Member Function Documentation

operator<=>()

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

inlineconstexpr

operator==()

bool ctre::phoenix6::signals::UpdateModeValue::operator== ( UpdateModeValue other ) const

inlineconstexpr

Serialize()

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

inlineoverridevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

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

friend

Member Data Documentation

LongRangeUserFreq

int ctre::phoenix6::signals::UpdateModeValue::LongRangeUserFreq = 2

staticconstexpr

Uses long-range detection mode and user-specified update frequency.

ShortRange100Hz

int ctre::phoenix6::signals::UpdateModeValue::ShortRange100Hz = 0

staticconstexpr

Updates distance/proximity at 100hz using short-range detection mode.

ShortRangeUserFreq

int ctre::phoenix6::signals::UpdateModeValue::ShortRangeUserFreq = 1

staticconstexpr

Uses short-range detection mode for improved detection under high ambient infrared light conditions.

Uses user-specified update frequency.

value

int ctre::phoenix6::signals::UpdateModeValue::value

---

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

• ctre/phoenix6/signals/SpnEnums.hpp