SupplyCurrentLimitConfiguration (CTRE Phoenix Java 5.33.0)

java.lang.Object

com.ctre.phoenix.motorcontrol.SupplyCurrentLimitConfiguration

public class SupplyCurrentLimitConfiguration
extends Object

Supply-side current limiting. This is typically used to prevent breakers from tripping.

Field Summary

Fields
Modifier and Type	Field	Description
`double`	`currentLimit`	The "holding" current (amperes) to limit to when feature is activated.
`boolean`	`enable`	True/False to enable/disable limit feature.
`double`	`triggerThresholdCurrent`	Current must exceed this threshold (amperes) before limiting occurs.
`double`	`triggerThresholdTime`	How long current must exceed threshold (seconds) before limiting occurs.

Constructor Summary

Constructors
Constructor	Description
`SupplyCurrentLimitConfiguration()`
`SupplyCurrentLimitConfiguration(boolean enable, double currentLimit, double triggerThresholdCurrent, double triggerThresholdTime)`
`SupplyCurrentLimitConfiguration(double[] doubleArray)`

Method Summary

Modifier and Type Method Description

void deserialize(double[] doubles)

boolean equals(SupplyCurrentLimitConfiguration rhs)

double[] toArray()

String toString()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- enable
  
  public boolean enable
  
  True/False to enable/disable limit feature.
- currentLimit
  
  public double currentLimit
  
  The "holding" current (amperes) to limit to when feature is activated.
- triggerThresholdCurrent
  
  public double triggerThresholdCurrent
  
  Current must exceed this threshold (amperes) before limiting occurs. If this value is less than currentLimit, then currentLimit is used as the threshold.
- triggerThresholdTime
  
  public double triggerThresholdTime
  
  How long current must exceed threshold (seconds) before limiting occurs.
Constructor Details
- SupplyCurrentLimitConfiguration
  
  public SupplyCurrentLimitConfiguration()
- SupplyCurrentLimitConfiguration
  
  public SupplyCurrentLimitConfiguration(boolean enable, double currentLimit, double triggerThresholdCurrent, double triggerThresholdTime)
- SupplyCurrentLimitConfiguration
  
  public SupplyCurrentLimitConfiguration(double[] doubleArray)
Method Details
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  string representation of current faults tripped
- toArray
  
  public double[] toArray()
- deserialize
  
  public void deserialize(double[] doubles)
- equals
  
  public boolean equals(SupplyCurrentLimitConfiguration rhs)