ctre::phoenix6::configs::MotorOutputConfigs Class Reference

Configs that directly affect motor-output. More...

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

Inheritance diagram for ctre::phoenix6::configs::MotorOutputConfigs:

Public Member Functions
MotorOutputConfigs &	WithInverted (signals::InvertedValue newInverted)
	Modifies this configuration's Inverted parameter and returns itself for method-chaining and easier to use config API. More...
MotorOutputConfigs &	WithNeutralMode (signals::NeutralModeValue newNeutralMode)
	Modifies this configuration's NeutralMode parameter and returns itself for method-chaining and easier to use config API. More...
MotorOutputConfigs &	WithDutyCycleNeutralDeadband (double newDutyCycleNeutralDeadband)
	Modifies this configuration's DutyCycleNeutralDeadband parameter and returns itself for method-chaining and easier to use config API. More...
MotorOutputConfigs &	WithPeakForwardDutyCycle (double newPeakForwardDutyCycle)
	Modifies this configuration's PeakForwardDutyCycle parameter and returns itself for method-chaining and easier to use config API. More...
MotorOutputConfigs &	WithPeakReverseDutyCycle (double newPeakReverseDutyCycle)
	Modifies this configuration's PeakReverseDutyCycle 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
signals::InvertedValue	Inverted = signals::InvertedValue::CounterClockwise_Positive
	Invert state of the device. More...
signals::NeutralModeValue	NeutralMode = signals::NeutralModeValue::Coast
	The state of the motor controller bridge when output is neutral or disabled. More...
double	DutyCycleNeutralDeadband = 0
	Configures the output deadband percentage. More...
double	PeakForwardDutyCycle = 1
	Maximum (forward) output during duty cycle based control modes. More...
double	PeakReverseDutyCycle = -1
	Minimum (reverse) output during duty cycle based control modes. More...

Detailed Description

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

Member Function Documentation

Deserialize()

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

inlineoverridevirtual

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

Serialize()

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

inlineoverridevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

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

inlineoverridevirtual

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

WithDutyCycleNeutralDeadband()

MotorOutputConfigs & ctre::phoenix6::configs::MotorOutputConfigs::WithDutyCycleNeutralDeadband ( double  newDutyCycleNeutralDeadband )

inline

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

Parameters

newDutyCycleNeutralDeadband

Parameter to modify

Returns

Itself

WithInverted()

MotorOutputConfigs & ctre::phoenix6::configs::MotorOutputConfigs::WithInverted ( signals::InvertedValue  newInverted )

inline

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

Parameters

newInverted

Parameter to modify

Returns

Itself

WithNeutralMode()

MotorOutputConfigs & ctre::phoenix6::configs::MotorOutputConfigs::WithNeutralMode ( signals::NeutralModeValue  newNeutralMode )

inline

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

Parameters

newNeutralMode

Parameter to modify

Returns

Itself

WithPeakForwardDutyCycle()

MotorOutputConfigs & ctre::phoenix6::configs::MotorOutputConfigs::WithPeakForwardDutyCycle ( double  newPeakForwardDutyCycle )

inline

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

Parameters

newPeakForwardDutyCycle

Parameter to modify

Returns

Itself

WithPeakReverseDutyCycle()

MotorOutputConfigs & ctre::phoenix6::configs::MotorOutputConfigs::WithPeakReverseDutyCycle ( double  newPeakReverseDutyCycle )

inline

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

Parameters

newPeakReverseDutyCycle

Parameter to modify

Returns

Itself

Member Data Documentation

DutyCycleNeutralDeadband

double ctre::phoenix6::configs::MotorOutputConfigs::DutyCycleNeutralDeadband = 0

Configures the output deadband percentage.

Minimum Value: 0.0 Maximum Value: 0.25 Default Value: 0 Units: fractional

Inverted

signals::InvertedValue ctre::phoenix6::configs::MotorOutputConfigs::Inverted = signals::InvertedValue::CounterClockwise_Positive

Invert state of the device.

NeutralMode

signals::NeutralModeValue ctre::phoenix6::configs::MotorOutputConfigs::NeutralMode = signals::NeutralModeValue::Coast

The state of the motor controller bridge when output is neutral or disabled.

PeakForwardDutyCycle

double ctre::phoenix6::configs::MotorOutputConfigs::PeakForwardDutyCycle = 1

Maximum (forward) output during duty cycle based control modes.

Minimum Value: -1.0 Maximum Value: 1.0 Default Value: 1 Units: fractional

PeakReverseDutyCycle

double ctre::phoenix6::configs::MotorOutputConfigs::PeakReverseDutyCycle = -1

Minimum (reverse) output during duty cycle based control modes.

Minimum Value: -1.0 Maximum Value: 1.0 Default Value: -1 Units: fractional

---

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

• ctre/phoenix6/configs/Configs.hpp