CTRE Phoenix 6 C++ 24.3.0
Public Member Functions | Public Attributes | List of all members
ctre::phoenix6::configs::GyroTrimConfigs Class Reference

Configs to trim the Pigeon2's gyroscope. More...

#include <ctre/phoenix6/configs/Configs.hpp>

Inheritance diagram for ctre::phoenix6::configs::GyroTrimConfigs:
ctre::phoenix6::configs::ParentConfiguration ctre::phoenix6::ISerializable

Public Member Functions

GyroTrimConfigs & WithGyroScalarX (double newGyroScalarX)
 Modifies this configuration's GyroScalarX parameter and returns itself for method-chaining and easier to use config API. More...
 
GyroTrimConfigs & WithGyroScalarY (double newGyroScalarY)
 Modifies this configuration's GyroScalarY parameter and returns itself for method-chaining and easier to use config API. More...
 
GyroTrimConfigs & WithGyroScalarZ (double newGyroScalarZ)
 Modifies this configuration's GyroScalarZ parameter and returns itself for method-chaining and easier to use config API. More...
 
std::string ToString () const override
 
std::string Serialize () const override
 
ctre::phoenix::StatusCode Deserialize (const std::string &to_deserialize) override
 
virtual std::string ToString () const =0
 
virtual ctre::phoenix::StatusCode Deserialize (const std::string &string)=0
 
virtual std::string Serialize () const =0
 

Public Attributes

double GyroScalarX = 0
 The gyro scalar component for the X axis. More...
 
double GyroScalarY = 0
 The gyro scalar component for the Y axis. More...
 
double GyroScalarZ = 0
 The gyro scalar component for the Z axis. More...
 

Detailed Description

Configs to trim the Pigeon2's gyroscope.

Pigeon2 allows the user to trim the gyroscope's sensitivity. While this isn't necessary for the Pigeon2, as it comes calibrated out-of-the-box, users can make use of this to make the Pigeon2 even more accurate for their application.

Member Function Documentation

◆ Deserialize()

ctre::phoenix::StatusCode ctre::phoenix6::configs::GyroTrimConfigs::Deserialize ( const std::string &  to_deserialize)
inlineoverridevirtual

Implements ctre::phoenix6::configs::ParentConfiguration.

◆ Serialize()

std::string ctre::phoenix6::configs::GyroTrimConfigs::Serialize ( ) const
inlineoverridevirtual

Implements ctre::phoenix6::ISerializable.

◆ ToString()

std::string ctre::phoenix6::configs::GyroTrimConfigs::ToString ( ) const
inlineoverridevirtual

Implements ctre::phoenix6::configs::ParentConfiguration.

◆ WithGyroScalarX()

GyroTrimConfigs & ctre::phoenix6::configs::GyroTrimConfigs::WithGyroScalarX ( double  newGyroScalarX)
inline

Modifies this configuration's GyroScalarX parameter and returns itself for method-chaining and easier to use config API.

The gyro scalar component for the X axis

  • Minimum Value: -180
  • Maximum Value: 180
  • Default Value: 0
  • Units: deg per rotation
Parameters
newGyroScalarXParameter to modify
Returns
Itself

◆ WithGyroScalarY()

GyroTrimConfigs & ctre::phoenix6::configs::GyroTrimConfigs::WithGyroScalarY ( double  newGyroScalarY)
inline

Modifies this configuration's GyroScalarY parameter and returns itself for method-chaining and easier to use config API.

The gyro scalar component for the Y axis

  • Minimum Value: -180
  • Maximum Value: 180
  • Default Value: 0
  • Units: deg per rotation
Parameters
newGyroScalarYParameter to modify
Returns
Itself

◆ WithGyroScalarZ()

GyroTrimConfigs & ctre::phoenix6::configs::GyroTrimConfigs::WithGyroScalarZ ( double  newGyroScalarZ)
inline

Modifies this configuration's GyroScalarZ parameter and returns itself for method-chaining and easier to use config API.

The gyro scalar component for the Z axis

  • Minimum Value: -180
  • Maximum Value: 180
  • Default Value: 0
  • Units: deg per rotation
Parameters
newGyroScalarZParameter to modify
Returns
Itself

Member Data Documentation

◆ GyroScalarX

double ctre::phoenix6::configs::GyroTrimConfigs::GyroScalarX = 0

The gyro scalar component for the X axis.

  • Minimum Value: -180
  • Maximum Value: 180
  • Default Value: 0
  • Units: deg per rotation

◆ GyroScalarY

double ctre::phoenix6::configs::GyroTrimConfigs::GyroScalarY = 0

The gyro scalar component for the Y axis.

  • Minimum Value: -180
  • Maximum Value: 180
  • Default Value: 0
  • Units: deg per rotation

◆ GyroScalarZ

double ctre::phoenix6::configs::GyroTrimConfigs::GyroScalarZ = 0

The gyro scalar component for the Z axis.

  • Minimum Value: -180
  • Maximum Value: 180
  • Default Value: 0
  • Units: deg per rotation
The documentation for this class was generated from the following file: