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

Configs for Pigeon 2's Mount Pose configuration. More...

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

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

Public Member Functions

MountPoseConfigs & WithMountPoseYaw (double newMountPoseYaw)
 Modifies this configuration's MountPoseYaw parameter and returns itself for method-chaining and easier to use config API. More...
 
MountPoseConfigs & WithMountPosePitch (double newMountPosePitch)
 Modifies this configuration's MountPosePitch parameter and returns itself for method-chaining and easier to use config API. More...
 
MountPoseConfigs & WithMountPoseRoll (double newMountPoseRoll)
 Modifies this configuration's MountPoseRoll 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 MountPoseYaw = 0
 The mounting calibration yaw-component. More...
 
double MountPosePitch = 0
 The mounting calibration pitch-component. More...
 
double MountPoseRoll = 0
 The mounting calibration roll-component. More...
 

Detailed Description

Configs for Pigeon 2's Mount Pose configuration.

These configs allow the Pigeon2 to be mounted in whatever orientation that's desired and ensure the reported Yaw/Pitch/Roll is from the robot's reference.

Member Function Documentation

◆ Deserialize()

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

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

◆ Serialize()

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

Implements ctre::phoenix6::ISerializable.

◆ ToString()

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

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

◆ WithMountPosePitch()

MountPoseConfigs & ctre::phoenix6::configs::MountPoseConfigs::WithMountPosePitch ( double  newMountPosePitch)
inline

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

The mounting calibration pitch-component

  • Minimum Value: -360
  • Maximum Value: 360
  • Default Value: 0
  • Units: deg
Parameters
newMountPosePitchParameter to modify
Returns
Itself

◆ WithMountPoseRoll()

MountPoseConfigs & ctre::phoenix6::configs::MountPoseConfigs::WithMountPoseRoll ( double  newMountPoseRoll)
inline

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

The mounting calibration roll-component

  • Minimum Value: -360
  • Maximum Value: 360
  • Default Value: 0
  • Units: deg
Parameters
newMountPoseRollParameter to modify
Returns
Itself

◆ WithMountPoseYaw()

MountPoseConfigs & ctre::phoenix6::configs::MountPoseConfigs::WithMountPoseYaw ( double  newMountPoseYaw)
inline

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

The mounting calibration yaw-component

  • Minimum Value: -360
  • Maximum Value: 360
  • Default Value: 0
  • Units: deg
Parameters
newMountPoseYawParameter to modify
Returns
Itself

Member Data Documentation

◆ MountPosePitch

double ctre::phoenix6::configs::MountPoseConfigs::MountPosePitch = 0

The mounting calibration pitch-component.

  • Minimum Value: -360
  • Maximum Value: 360
  • Default Value: 0
  • Units: deg

◆ MountPoseRoll

double ctre::phoenix6::configs::MountPoseConfigs::MountPoseRoll = 0

The mounting calibration roll-component.

  • Minimum Value: -360
  • Maximum Value: 360
  • Default Value: 0
  • Units: deg

◆ MountPoseYaw

double ctre::phoenix6::configs::MountPoseConfigs::MountPoseYaw = 0

The mounting calibration yaw-component.

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