CTRE Phoenix Pro C++ 23.0.12
ctre::phoenixpro::configs::SoftwareLimitSwitchConfigs Class Reference

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

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

Inheritance diagram for ctre::phoenixpro::configs::SoftwareLimitSwitchConfigs:
ctre::phoenixpro::configs::ParentConfiguration ctre::phoenixpro::ISerializable

Public Member Functions

std::string ToString () const
 
std::string Serialize () const
 
ctre::phoenix::StatusCode Deserialize (const std::string &string)
 
virtual std::string ToString () const =0
 
virtual ctre::phoenix::StatusCode Deserialize (const std::string &string)=0
 
virtual std::string Serialize () const =0
 

Public Attributes

bool ForwardSoftLimitEnable = false
 If enabled, the motor output is set to neutral if position exceeds ForwardSoftLimitThreshold and forward output is requested. More...
 
bool ReverseSoftLimitEnable = false
 If enabled, the motor output is set to neutral if position exceeds ReverseSoftLimitThreshold and reverse output is requested. More...
 
double ForwardSoftLimitThreshold = 0
 Position threshold for forward soft limit features. More...
 
double ReverseSoftLimitThreshold = 0
 Position threshold for reverse soft limit features. More...
 

Detailed Description

Configs that directly affect motor-output.

Includes Motor Invert and various limit features.

Member Function Documentation

◆ Deserialize()

ctre::phoenix::StatusCode ctre::phoenixpro::configs::SoftwareLimitSwitchConfigs::Deserialize ( const std::string &  string)
inlinevirtual

◆ Serialize()

std::string ctre::phoenixpro::configs::SoftwareLimitSwitchConfigs::Serialize ( ) const
inlinevirtual

◆ ToString()

std::string ctre::phoenixpro::configs::SoftwareLimitSwitchConfigs::ToString ( ) const
inlinevirtual

Member Data Documentation

◆ ForwardSoftLimitEnable

bool ctre::phoenixpro::configs::SoftwareLimitSwitchConfigs::ForwardSoftLimitEnable = false

If enabled, the motor output is set to neutral if position exceeds ForwardSoftLimitThreshold and forward output is requested.

Default Value: False

◆ ForwardSoftLimitThreshold

double ctre::phoenixpro::configs::SoftwareLimitSwitchConfigs::ForwardSoftLimitThreshold = 0

Position threshold for forward soft limit features.

ForwardSoftLimitEnable must be enabled for this to take effect.

Minimum Value: -3.4e+38 Maximum Value: 3.4e+38 Default Value: 0 Units: rotations

◆ ReverseSoftLimitEnable

bool ctre::phoenixpro::configs::SoftwareLimitSwitchConfigs::ReverseSoftLimitEnable = false

If enabled, the motor output is set to neutral if position exceeds ReverseSoftLimitThreshold and reverse output is requested.

Default Value: False

◆ ReverseSoftLimitThreshold

double ctre::phoenixpro::configs::SoftwareLimitSwitchConfigs::ReverseSoftLimitThreshold = 0

Position threshold for reverse soft limit features.

ReverseSoftLimitEnable must be enabled for this to take effect.

Minimum Value: -3.4e+38 Maximum Value: 3.4e+38 Default Value: 0 Units: rotations


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