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:

Public Member Functions
constexpr	MountPoseConfigs ()=default
constexpr MountPoseConfigs &	WithMountPoseYaw (units::angle::degree_t newMountPoseYaw)
	Modifies this configuration's MountPoseYaw parameter and returns itself for method-chaining and easier to use config API.
constexpr MountPoseConfigs &	WithMountPosePitch (units::angle::degree_t newMountPosePitch)
	Modifies this configuration's MountPosePitch parameter and returns itself for method-chaining and easier to use config API.
constexpr MountPoseConfigs &	WithMountPoseRoll (units::angle::degree_t newMountPoseRoll)
	Modifies this configuration's MountPoseRoll parameter and returns itself for method-chaining and easier to use config API.
std::string	ToString () const override
std::string	Serialize () const override
ctre::phoenix::StatusCode	Deserialize (const std::string &to_deserialize) override
Public Member Functions inherited from ctre::phoenix6::configs::ParentConfiguration
Public Member Functions inherited from ctre::phoenix6::ISerializable

Public Attributes
units::angle::degree_t	MountPoseYaw = 0_deg
	The mounting calibration yaw-component.
units::angle::degree_t	MountPosePitch = 0_deg
	The mounting calibration pitch-component.
units::angle::degree_t	MountPoseRoll = 0_deg
	The mounting calibration roll-component.

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.

Constructor & Destructor Documentation

MountPoseConfigs()

ctre::phoenix6::configs::MountPoseConfigs::MountPoseConfigs ( )

constexprdefault

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 ( units::angle::degree_t newMountPosePitch )

inlineconstexpr

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

newMountPosePitch

Parameter to modify

Returns

Itself

WithMountPoseRoll()

MountPoseConfigs & ctre::phoenix6::configs::MountPoseConfigs::WithMountPoseRoll ( units::angle::degree_t newMountPoseRoll )

inlineconstexpr

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

newMountPoseRoll

Parameter to modify

Returns

Itself

WithMountPoseYaw()

MountPoseConfigs & ctre::phoenix6::configs::MountPoseConfigs::WithMountPoseYaw ( units::angle::degree_t newMountPoseYaw )

inlineconstexpr

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

newMountPoseYaw

Parameter to modify

Returns

Itself

Member Data Documentation

MountPosePitch

units::angle::degree_t ctre::phoenix6::configs::MountPoseConfigs::MountPosePitch = 0_deg

The mounting calibration pitch-component.

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

MountPoseRoll

units::angle::degree_t ctre::phoenix6::configs::MountPoseConfigs::MountPoseRoll = 0_deg

The mounting calibration roll-component.

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

MountPoseYaw

units::angle::degree_t ctre::phoenix6::configs::MountPoseConfigs::MountPoseYaw = 0_deg

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:

• ctre/phoenix6/configs/Configs.hpp