ctre::phoenix6::configs::DifferentialConstantsConfigs Class Reference

Configs related to constants used for differential control of a mechanism. More...

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

Inheritance diagram for ctre::phoenix6::configs::DifferentialConstantsConfigs:

Public Member Functions
DifferentialConstantsConfigs &	WithPeakDifferentialDutyCycle (double newPeakDifferentialDutyCycle)
	Modifies this configuration's PeakDifferentialDutyCycle parameter and returns itself for method-chaining and easier to use config API. More...
DifferentialConstantsConfigs &	WithPeakDifferentialVoltage (double newPeakDifferentialVoltage)
	Modifies this configuration's PeakDifferentialVoltage parameter and returns itself for method-chaining and easier to use config API. More...
DifferentialConstantsConfigs &	WithPeakDifferentialTorqueCurrent (double newPeakDifferentialTorqueCurrent)
	Modifies this configuration's PeakDifferentialTorqueCurrent 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	PeakDifferentialDutyCycle = 2
	Maximum differential output during duty cycle based differential control modes. More...
double	PeakDifferentialVoltage = 32
	Maximum differential output during voltage based differential control modes. More...
double	PeakDifferentialTorqueCurrent = 1600
	Maximum differential output during torque current based differential control modes. More...

Detailed Description

Configs related to constants used for differential control of a mechanism.

Includes the differential peak outputs.

Member Function Documentation

Deserialize()

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

inlineoverridevirtual

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

Serialize()

std::string ctre::phoenix6::configs::DifferentialConstantsConfigs::Serialize ( ) const

inlineoverridevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

std::string ctre::phoenix6::configs::DifferentialConstantsConfigs::ToString ( ) const

inlineoverridevirtual

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

WithPeakDifferentialDutyCycle()

DifferentialConstantsConfigs & ctre::phoenix6::configs::DifferentialConstantsConfigs::WithPeakDifferentialDutyCycle ( double  newPeakDifferentialDutyCycle )

inline

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

Parameters

newPeakDifferentialDutyCycle

Parameter to modify

Returns

Itself

WithPeakDifferentialTorqueCurrent()

DifferentialConstantsConfigs & ctre::phoenix6::configs::DifferentialConstantsConfigs::WithPeakDifferentialTorqueCurrent ( double  newPeakDifferentialTorqueCurrent )

inline

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

Parameters

newPeakDifferentialTorqueCurrent

Parameter to modify

Returns

Itself

WithPeakDifferentialVoltage()

DifferentialConstantsConfigs & ctre::phoenix6::configs::DifferentialConstantsConfigs::WithPeakDifferentialVoltage ( double  newPeakDifferentialVoltage )

inline

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

Parameters

newPeakDifferentialVoltage

Parameter to modify

Returns

Itself

Member Data Documentation

PeakDifferentialDutyCycle

double ctre::phoenix6::configs::DifferentialConstantsConfigs::PeakDifferentialDutyCycle = 2

Maximum differential output during duty cycle based differential control modes.

Minimum Value: 0.0 Maximum Value: 2.0 Default Value: 2 Units: fractional

PeakDifferentialTorqueCurrent

double ctre::phoenix6::configs::DifferentialConstantsConfigs::PeakDifferentialTorqueCurrent = 1600

Maximum differential output during torque current based differential control modes.

Minimum Value: 0.0 Maximum Value: 1600 Default Value: 1600 Units: A

PeakDifferentialVoltage

double ctre::phoenix6::configs::DifferentialConstantsConfigs::PeakDifferentialVoltage = 32

Maximum differential output during voltage based differential control modes.

Minimum Value: 0.0 Maximum Value: 32 Default Value: 32 Units: V

---

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

• ctre/phoenix6/configs/Configs.hpp