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

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

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

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

Public Member Functions

OpenLoopRampsConfigs & WithDutyCycleOpenLoopRampPeriod (double newDutyCycleOpenLoopRampPeriod)
 Modifies this configuration's DutyCycleOpenLoopRampPeriod parameter and returns itself for method-chaining and easier to use config API. More...
 
OpenLoopRampsConfigs & WithVoltageOpenLoopRampPeriod (double newVoltageOpenLoopRampPeriod)
 Modifies this configuration's VoltageOpenLoopRampPeriod parameter and returns itself for method-chaining and easier to use config API. More...
 
OpenLoopRampsConfigs & WithTorqueOpenLoopRampPeriod (double newTorqueOpenLoopRampPeriod)
 Modifies this configuration's TorqueOpenLoopRampPeriod 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 DutyCycleOpenLoopRampPeriod = 0
 If non-zero, this determines how much time to ramp from 0% output to 100% during open-loop modes. More...
 
double VoltageOpenLoopRampPeriod = 0
 If non-zero, this determines how much time to ramp from 0V output to 12V during open-loop modes. More...
 
double TorqueOpenLoopRampPeriod = 0
 If non-zero, this determines how much time to ramp from 0A output to 300A during open-loop modes. More...
 

Detailed Description

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

Open-loop ramp rates for the various control types.

Member Function Documentation

◆ Deserialize()

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

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

◆ Serialize()

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

Implements ctre::phoenix6::ISerializable.

◆ ToString()

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

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

◆ WithDutyCycleOpenLoopRampPeriod()

OpenLoopRampsConfigs & ctre::phoenix6::configs::OpenLoopRampsConfigs::WithDutyCycleOpenLoopRampPeriod ( double  newDutyCycleOpenLoopRampPeriod)
inline

Modifies this configuration's DutyCycleOpenLoopRampPeriod 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 open-loop modes.

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

◆ WithTorqueOpenLoopRampPeriod()

OpenLoopRampsConfigs & ctre::phoenix6::configs::OpenLoopRampsConfigs::WithTorqueOpenLoopRampPeriod ( double  newTorqueOpenLoopRampPeriod)
inline

Modifies this configuration's TorqueOpenLoopRampPeriod 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 open-loop modes.

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

◆ WithVoltageOpenLoopRampPeriod()

OpenLoopRampsConfigs & ctre::phoenix6::configs::OpenLoopRampsConfigs::WithVoltageOpenLoopRampPeriod ( double  newVoltageOpenLoopRampPeriod)
inline

Modifies this configuration's VoltageOpenLoopRampPeriod 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 open-loop modes.

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

Member Data Documentation

◆ DutyCycleOpenLoopRampPeriod

double ctre::phoenix6::configs::OpenLoopRampsConfigs::DutyCycleOpenLoopRampPeriod = 0

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

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

◆ TorqueOpenLoopRampPeriod

double ctre::phoenix6::configs::OpenLoopRampsConfigs::TorqueOpenLoopRampPeriod = 0

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

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

◆ VoltageOpenLoopRampPeriod

double ctre::phoenix6::configs::OpenLoopRampsConfigs::VoltageOpenLoopRampPeriod = 0

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

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