CTRE Phoenix 6 C++ 25.0.0-beta-4
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
ctre::phoenix6::configs::FovParamsConfigs Class Reference

Configs that affect the ToF Field of View. More...

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

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

Public Member Functions

constexpr FovParamsConfigs ()=default
 
constexpr FovParamsConfigs & WithFOVCenterX (units::angle::degree_t newFOVCenterX)
 Modifies this configuration's FOVCenterX parameter and returns itself for method-chaining and easier to use config API.
 
constexpr FovParamsConfigs & WithFOVCenterY (units::angle::degree_t newFOVCenterY)
 Modifies this configuration's FOVCenterY parameter and returns itself for method-chaining and easier to use config API.
 
constexpr FovParamsConfigs & WithFOVRangeX (units::angle::degree_t newFOVRangeX)
 Modifies this configuration's FOVRangeX parameter and returns itself for method-chaining and easier to use config API.
 
constexpr FovParamsConfigs & WithFOVRangeY (units::angle::degree_t newFOVRangeY)
 Modifies this configuration's FOVRangeY 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 Attributes

units::angle::degree_t FOVCenterX = 0_deg
 Specifies the target center of the Field of View in the X direction.
 
units::angle::degree_t FOVCenterY = 0_deg
 Specifies the target center of the Field of View in the Y direction.
 
units::angle::degree_t FOVRangeX = 27_deg
 Specifies the target range of the Field of View in the X direction.
 
units::angle::degree_t FOVRangeY = 27_deg
 Specifies the target range of the Field of View in the Y direction.
 

Detailed Description

Configs that affect the ToF Field of View.

Includes range and center configs

Constructor & Destructor Documentation

◆ FovParamsConfigs()

constexpr ctre::phoenix6::configs::FovParamsConfigs::FovParamsConfigs ( )
constexprdefault

Member Function Documentation

◆ Deserialize()

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

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

◆ Serialize()

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

Implements ctre::phoenix6::ISerializable.

◆ ToString()

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

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

◆ WithFOVCenterX()

constexpr FovParamsConfigs & ctre::phoenix6::configs::FovParamsConfigs::WithFOVCenterX ( units::angle::degree_t newFOVCenterX)
inlineconstexpr

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

Specifies the target center of the Field of View in the X direction.

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

  • Minimum Value: -11.8
  • Maximum Value: 11.8
  • Default Value: 0
  • Units: deg
Parameters
newFOVCenterXParameter to modify
Returns
Itself

◆ WithFOVCenterY()

constexpr FovParamsConfigs & ctre::phoenix6::configs::FovParamsConfigs::WithFOVCenterY ( units::angle::degree_t newFOVCenterY)
inlineconstexpr

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

Specifies the target center of the Field of View in the Y direction.

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

  • Minimum Value: -11.8
  • Maximum Value: 11.8
  • Default Value: 0
  • Units: deg
Parameters
newFOVCenterYParameter to modify
Returns
Itself

◆ WithFOVRangeX()

constexpr FovParamsConfigs & ctre::phoenix6::configs::FovParamsConfigs::WithFOVRangeX ( units::angle::degree_t newFOVRangeX)
inlineconstexpr

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

Specifies the target range of the Field of View in the X direction. This is the full range of the FOV.

The magnitude of this is capped to abs(27 - 2*FOVCenterX).

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

  • Minimum Value: 6.75
  • Maximum Value: 27
  • Default Value: 27
  • Units: deg
Parameters
newFOVRangeXParameter to modify
Returns
Itself

◆ WithFOVRangeY()

constexpr FovParamsConfigs & ctre::phoenix6::configs::FovParamsConfigs::WithFOVRangeY ( units::angle::degree_t newFOVRangeY)
inlineconstexpr

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

Specifies the target range of the Field of View in the Y direction. This is the full range of the FOV.

The magnitude of this is capped to abs(27 - 2*FOVCenterY).

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

  • Minimum Value: 6.75
  • Maximum Value: 27
  • Default Value: 27
  • Units: deg
Parameters
newFOVRangeYParameter to modify
Returns
Itself

Member Data Documentation

◆ FOVCenterX

units::angle::degree_t ctre::phoenix6::configs::FovParamsConfigs::FOVCenterX = 0_deg

Specifies the target center of the Field of View in the X direction.

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

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

◆ FOVCenterY

units::angle::degree_t ctre::phoenix6::configs::FovParamsConfigs::FOVCenterY = 0_deg

Specifies the target center of the Field of View in the Y direction.

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

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

◆ FOVRangeX

units::angle::degree_t ctre::phoenix6::configs::FovParamsConfigs::FOVRangeX = 27_deg

Specifies the target range of the Field of View in the X direction.

This is the full range of the FOV.

The magnitude of this is capped to abs(27 - 2*FOVCenterX).

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

  • Minimum Value: 6.75
  • Maximum Value: 27
  • Default Value: 27
  • Units: deg

◆ FOVRangeY

units::angle::degree_t ctre::phoenix6::configs::FovParamsConfigs::FOVRangeY = 27_deg

Specifies the target range of the Field of View in the Y direction.

This is the full range of the FOV.

The magnitude of this is capped to abs(27 - 2*FOVCenterY).

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

  • Minimum Value: 6.75
  • Maximum Value: 27
  • Default Value: 27
  • Units: deg
The documentation for this class was generated from the following file: