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

Configs that affect the closed-loop control of this motor controller. More...

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

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

Public Member Functions

ClosedLoopRampsConfigs & WithDutyCycleClosedLoopRampPeriod (double newDutyCycleClosedLoopRampPeriod)
 Modifies this configuration's DutyCycleClosedLoopRampPeriod parameter and returns itself for method-chaining and easier to use config API. More...
 
ClosedLoopRampsConfigs & WithVoltageClosedLoopRampPeriod (double newVoltageClosedLoopRampPeriod)
 Modifies this configuration's VoltageClosedLoopRampPeriod parameter and returns itself for method-chaining and easier to use config API. More...
 
ClosedLoopRampsConfigs & WithTorqueClosedLoopRampPeriod (double newTorqueClosedLoopRampPeriod)
 Modifies this configuration's TorqueClosedLoopRampPeriod 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 DutyCycleClosedLoopRampPeriod = 0
 If non-zero, this determines how much time to ramp from 0% output to 100% during closed-loop modes. More...
 
double VoltageClosedLoopRampPeriod = 0
 If non-zero, this determines how much time to ramp from 0V output to 12V during closed-loop modes. More...
 
double TorqueClosedLoopRampPeriod = 0
 If non-zero, this determines how much time to ramp from 0A output to 300A during closed-loop modes. More...
 

Detailed Description

Configs that affect the closed-loop control of this motor controller.

Closed-loop ramp rates for the various control types.

Member Function Documentation

◆ Deserialize()

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

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

◆ Serialize()

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

Implements ctre::phoenix6::ISerializable.

◆ ToString()

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

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

◆ WithDutyCycleClosedLoopRampPeriod()

ClosedLoopRampsConfigs & ctre::phoenix6::configs::ClosedLoopRampsConfigs::WithDutyCycleClosedLoopRampPeriod ( double  newDutyCycleClosedLoopRampPeriod)
inline

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

If non-zero, this determines how much time to ramp from 0% output to 100% during closed-loop modes.

  • Minimum Value: 0
  • Maximum Value: 1
  • Default Value: 0
  • Units: sec
Parameters
newDutyCycleClosedLoopRampPeriodParameter to modify
Returns
Itself

◆ WithTorqueClosedLoopRampPeriod()

ClosedLoopRampsConfigs & ctre::phoenix6::configs::ClosedLoopRampsConfigs::WithTorqueClosedLoopRampPeriod ( double  newTorqueClosedLoopRampPeriod)
inline

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

If non-zero, this determines how much time to ramp from 0A output to 300A during closed-loop modes.

  • Minimum Value: 0
  • Maximum Value: 10
  • Default Value: 0
  • Units: sec
Parameters
newTorqueClosedLoopRampPeriodParameter to modify
Returns
Itself

◆ WithVoltageClosedLoopRampPeriod()

ClosedLoopRampsConfigs & ctre::phoenix6::configs::ClosedLoopRampsConfigs::WithVoltageClosedLoopRampPeriod ( double  newVoltageClosedLoopRampPeriod)
inline

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

If non-zero, this determines how much time to ramp from 0V output to 12V during closed-loop modes.

  • Minimum Value: 0
  • Maximum Value: 1
  • Default Value: 0
  • Units: sec
Parameters
newVoltageClosedLoopRampPeriodParameter to modify
Returns
Itself

Member Data Documentation

◆ DutyCycleClosedLoopRampPeriod

double ctre::phoenix6::configs::ClosedLoopRampsConfigs::DutyCycleClosedLoopRampPeriod = 0

If non-zero, this determines how much time to ramp from 0% output to 100% during closed-loop modes.

  • Minimum Value: 0
  • Maximum Value: 1
  • Default Value: 0
  • Units: sec

◆ TorqueClosedLoopRampPeriod

double ctre::phoenix6::configs::ClosedLoopRampsConfigs::TorqueClosedLoopRampPeriod = 0

If non-zero, this determines how much time to ramp from 0A output to 300A during closed-loop modes.

  • Minimum Value: 0
  • Maximum Value: 10
  • Default Value: 0
  • Units: sec

◆ VoltageClosedLoopRampPeriod

double ctre::phoenix6::configs::ClosedLoopRampsConfigs::VoltageClosedLoopRampPeriod = 0

If non-zero, this determines how much time to ramp from 0V output to 12V during closed-loop modes.

  • Minimum Value: 0
  • Maximum Value: 1
  • Default Value: 0
  • Units: sec
The documentation for this class was generated from the following file: