ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration Struct Reference

Describes the desired stator current limiting behavior. More...

#include <ctre/phoenix/motorcontrol/SupplyCurrentLimitConfiguration.h>

Public Member Functions
	SupplyCurrentLimitConfiguration ()
	Default c'tor.
	SupplyCurrentLimitConfiguration (bool enable, double currentLimit, double triggerThresholdCurrent, double triggerThresholdTime)
	SupplyCurrentLimitConfiguration (const double *doubleArray, int doubleArraySz)
std::string	ToString () const
std::vector< double >	ToArray () const
void	Deserialize (const double *doubles, int doubleCnt)
bool	Equals (const SupplyCurrentLimitConfiguration &rhs) const

Public Attributes
bool	enable = false
	True/False to enable/disable limit feature.
double	currentLimit = 0
	The "holding" current (amperes) to limit to when feature is activated.
double	triggerThresholdCurrent = 0
	Current must exceed this threshold (amperes) before limiting occurs.
double	triggerThresholdTime = 0
	How long current must exceed threshold (seconds) before limiting occurs.

Detailed Description

Describes the desired stator current limiting behavior.

Constructor & Destructor Documentation

SupplyCurrentLimitConfiguration() [1/3]

ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::SupplyCurrentLimitConfiguration ( )

inline

Default c'tor.

Because currentLimit is zero, limiting is disabled.

SupplyCurrentLimitConfiguration() [2/3]

ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::SupplyCurrentLimitConfiguration ( bool enable, double currentLimit, double triggerThresholdCurrent, double triggerThresholdTime )

inline

SupplyCurrentLimitConfiguration() [3/3]

ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::SupplyCurrentLimitConfiguration ( const double * doubleArray, int doubleArraySz )

inline

Member Function Documentation

Deserialize()

void ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::Deserialize ( const double * doubles, int doubleCnt )

inline

Equals()

bool ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::Equals ( const SupplyCurrentLimitConfiguration & rhs ) const

inline

ToArray()

std::vector< double > ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::ToArray ( ) const

inline

ToString()

std::string ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::ToString ( ) const

inline

Returns

string representation of current faults tripped

Member Data Documentation

currentLimit

double ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::currentLimit = 0

The "holding" current (amperes) to limit to when feature is activated.

enable

bool ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::enable = false

True/False to enable/disable limit feature.

triggerThresholdCurrent

double ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::triggerThresholdCurrent = 0

Current must exceed this threshold (amperes) before limiting occurs.

If this value is less than currentLimit, then currentLimit is used as the threshold.

triggerThresholdTime

double ctre::phoenix::motorcontrol::SupplyCurrentLimitConfiguration::triggerThresholdTime = 0

How long current must exceed threshold (seconds) before limiting occurs.

---

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

• ctre/phoenix/motorcontrol/SupplyCurrentLimitConfiguration.h