CTRE Phoenix 6 C++ 26.3.0
Loading...
Searching...
No Matches
ctre::phoenix6::signals::GainSchedKpBehaviorValue Struct Reference

The behavior of kP output as the error crosses the GainSchedErrorThreshold during gain scheduling. More...

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

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

Public Member Functions

constexpr GainSchedKpBehaviorValue (int value)
 
constexpr GainSchedKpBehaviorValue ()
 
constexpr bool operator== (GainSchedKpBehaviorValue other) const
 
constexpr auto operator<=> (GainSchedKpBehaviorValue 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 Continuous = 0
 The gain scheduler will maintain continuity in the kP output as the error crosses the gain threshold.
 
static constexpr int Discontinuous = 1
 The gain scheduler will allow for a discontinuity in the kP output.
 

Friends

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

Detailed Description

The behavior of kP output as the error crosses the GainSchedErrorThreshold during gain scheduling.

The output of kP can be adjusted to maintain continuity in output, or it can be left discontinuous.

Constructor & Destructor Documentation

◆ GainSchedKpBehaviorValue() [1/2]

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

◆ GainSchedKpBehaviorValue() [2/2]

ctre::phoenix6::signals::GainSchedKpBehaviorValue::GainSchedKpBehaviorValue ( )
inlineconstexpr

Member Function Documentation

◆ operator<=>()

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

◆ operator==()

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

◆ Serialize()

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

◆ ToString()

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

Member Data Documentation

◆ Continuous

int ctre::phoenix6::signals::GainSchedKpBehaviorValue::Continuous = 0
staticconstexpr

The gain scheduler will maintain continuity in the kP output as the error crosses the gain threshold.

This results in the best system stability, but it may result in output that does not match pOut = kP * error.

◆ Discontinuous

int ctre::phoenix6::signals::GainSchedKpBehaviorValue::Discontinuous = 1
staticconstexpr

The gain scheduler will allow for a discontinuity in the kP output.

This ensures that pOut = kP * error, but it may result in instability as the system's error crosses the gain threshold.

◆ value

int ctre::phoenix6::signals::GainSchedKpBehaviorValue::value

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