Package me.nabdev.oxconfig.sampleClasses

Class ConfigurablePhoenixMotorPIDController

java.lang.Object

me.nabdev.oxconfig.sampleClasses.ConfigurablePhoenixMotorPIDController

All Implemented Interfaces:

ConfigurableClass

public class ConfigurablePhoenixMotorPIDController
extends Object
implements ConfigurableClass

A configurable Talon SRX or Victor SPX PID controller. This class is an example of how to use the ConfigurableClass interface, but is safe for competition use.

Constructor Summary

Constructors

Constructor	Description
ConfigurablePhoenixMotorPIDController(com.ctre.phoenix.motorcontrol.can.BaseMotorController controller, String key)	Sets up a Talon SRX PID controller to be autoconfigured.
ConfigurablePhoenixMotorPIDController(com.ctre.phoenix.motorcontrol.can.BaseMotorController controller, String key, String prettyName)	Sets up a Talon SRX PID controller to be autoconfigured.

Method Summary

Modifier and Type	Method	Description
String	getKey()	Gets the key of the configurable class (e.g.
List<ConfigurableClassParam<?>>	getParameters()	Gets the parameters of the configurable class
String	getPrettyName()	Gets the pretty name of the configurable class (e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConfigurablePhoenixMotorPIDController

public ConfigurablePhoenixMotorPIDController(com.ctre.phoenix.motorcontrol.can.BaseMotorController controller,
 String key)

Sets up a Talon SRX PID controller to be autoconfigured.

Parameters:

controller - The Talon SRX motor controller to be configured

key - The json key for the controller to be stored in

ConfigurablePhoenixMotorPIDController

public ConfigurablePhoenixMotorPIDController(com.ctre.phoenix.motorcontrol.can.BaseMotorController controller,
 String key,
 String prettyName)

Sets up a Talon SRX PID controller to be autoconfigured.

Parameters:

controller - The Talon SRX motor controller to be configured

key - The json key for the controller to be stored in

prettyName - The display name of this controller

Method Details

getParameters

public List<ConfigurableClassParam<?>> getParameters()

Description copied from interface: ConfigurableClass

Gets the parameters of the configurable class

Specified by:

getParameters in interface ConfigurableClass

Returns:

The parameters of the configurable class

getKey

public String getKey()

Description copied from interface: ConfigurableClass

Gets the key of the configurable class (e.g. "Arm"), must not include commas

Specified by:

getKey in interface ConfigurableClass

Returns:

The key of the configurable class

getPrettyName

public String getPrettyName()

Description copied from interface: ConfigurableClass

Gets the pretty name of the configurable class (e.g. "Arm")

Specified by:

getPrettyName in interface ConfigurableClass

Returns:

The pretty name of the configurable class