Package ftclib.subsystem

Class FtcIntake.Params

java.lang.Object

ftclib.subsystem.FtcIntake.Params

Enclosing class:

FtcIntake

public static class FtcIntake.Params
extends Object

This class contains all the parameters of the Intake.

Field Summary

Fields

Modifier and Type	Field	Description
private TrcAnalogSensor.AnalogDataSource	entryAnalogSensorData
private boolean	entrySensorInverted
private String	entrySensorName
private double	entrySensorThreshold
private FtcSensorTrigger.SensorType	entrySensorType
private TrcEvent.Callback	entryTriggerCallback
private TrcAnalogSensor.AnalogDataSource	exitAnalogSensorData
private boolean	exitSensorInverted
private String	exitSensorName
private double	exitSensorThreshold
private FtcSensorTrigger.SensorType	exitSensorType
private TrcEvent.Callback	exitTriggerCallback
private FtcMotorActuator.Params	motorParams

Constructor Summary

Constructors

Constructor	Description
Params()

Method Summary

Modifier and Type	Method	Description
FtcIntake.Params	setEntryAnalogInput(String name, boolean inverted, double threshold, TrcEvent.Callback triggerCallback)	This method specifies the entry analog input sensor parameters.
FtcIntake.Params	setEntryAnalogSensor(TrcAnalogSensor.AnalogDataSource analogSensorData, boolean inverted, double threshold, TrcEvent.Callback triggerCallback)	This method specifies the entry analog sensor parameters.
FtcIntake.Params	setEntryDigitalInput(String name, boolean inverted, TrcEvent.Callback triggerCallback)	This method specifies the entry digital input sensor parameters.
FtcIntake.Params	setExitAnalogInput(String name, boolean inverted, double threshold, TrcEvent.Callback triggerCallback)	This method specifies the exit analog input sensor parameters.
FtcIntake.Params	setExitAnalogSensor(TrcAnalogSensor.AnalogDataSource analogSensorData, boolean inverted, double threshold, TrcEvent.Callback triggerCallback)	This method specifies the exit analog sensor parameters.
FtcIntake.Params	setExitDigitalInput(String name, boolean inverted, TrcEvent.Callback triggerCallback)	This method specifies the exit digital input sensor parameters.
FtcIntake.Params	setFollowerMotor(String name, FtcMotorActuator.MotorType motorType, boolean inverted)	This method sets the parameters of the follower motor.
FtcIntake.Params	setPrimaryMotor(String name, FtcMotorActuator.MotorType motorType, boolean inverted)	This method sets the parameters of the primary motor.
String	toString()	This method returns the string format of the Params info.

Methods inherited from class java.lang.Object

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

Field Details

motorParams

private FtcMotorActuator.Params motorParams

entrySensorType

private FtcSensorTrigger.SensorType entrySensorType

entrySensorName

private String entrySensorName

entryAnalogSensorData

private TrcAnalogSensor.AnalogDataSource entryAnalogSensorData

entrySensorInverted

private boolean entrySensorInverted

entrySensorThreshold

private double entrySensorThreshold

entryTriggerCallback

private TrcEvent.Callback entryTriggerCallback

exitSensorType

private FtcSensorTrigger.SensorType exitSensorType

exitSensorName

private String exitSensorName

exitAnalogSensorData

private TrcAnalogSensor.AnalogDataSource exitAnalogSensorData

exitSensorInverted

private boolean exitSensorInverted

exitSensorThreshold

private double exitSensorThreshold

exitTriggerCallback

private TrcEvent.Callback exitTriggerCallback

Constructor Details

Params

public Params()

Method Details

toString

@NonNull
public String toString()

This method returns the string format of the Params info.

Overrides:

toString in class Object

Returns:

string format of the params info.

setPrimaryMotor

public FtcIntake.Params setPrimaryMotor(String name,
 FtcMotorActuator.MotorType motorType,
 boolean inverted)

This method sets the parameters of the primary motor.

Parameters:

name - specifies the name of the motor.

motorType - specifies the motor type.

inverted - specifies true to invert the motor direction, false otherwise.

Returns:

this object for chaining.

setFollowerMotor

public FtcIntake.Params setFollowerMotor(String name,
 FtcMotorActuator.MotorType motorType,
 boolean inverted)

This method sets the parameters of the follower motor.

Parameters:

name - specifies the name of the motor.

motorType - specifies the motor type.

inverted - specifies true to invert the motor direction, false otherwise.

Returns:

this object for chaining.

setEntryDigitalInput

public FtcIntake.Params setEntryDigitalInput(String name,
 boolean inverted,
 TrcEvent.Callback triggerCallback)

This method specifies the entry digital input sensor parameters.

Parameters:

name - specifies the name of the sensor.

inverted - specifies true if the sensor polarity is inverted, false otherwise.

triggerCallback - specifies the callback method when trigger event occurred, null if not provided.

Returns:

this object for chaining.

setEntryAnalogInput

public FtcIntake.Params setEntryAnalogInput(String name,
 boolean inverted,
 double threshold,
 TrcEvent.Callback triggerCallback)

This method specifies the entry analog input sensor parameters.

Parameters:

name - specifies the name of the sensor.

inverted - specifies true if the sensor polarity is inverted, false otherwise.

threshold - specifies the sensor threshold value.

triggerCallback - specifies the callback method when trigger event occurred, null if not provided.

Returns:

this object for chaining.

setEntryAnalogSensor

public FtcIntake.Params setEntryAnalogSensor(TrcAnalogSensor.AnalogDataSource analogSensorData,
 boolean inverted,
 double threshold,
 TrcEvent.Callback triggerCallback)

This method specifies the entry analog sensor parameters.

Parameters:

analogSensorData - specifies the method to call to get the analog sensor data.

inverted - specifies true if the sensor polarity is inverted, false otherwise.

threshold - specifies the sensor threshold value.

triggerCallback - specifies the callback method when trigger event occurred, null if not provided.

Returns:

this object for chaining.

setExitDigitalInput

public FtcIntake.Params setExitDigitalInput(String name,
 boolean inverted,
 TrcEvent.Callback triggerCallback)

This method specifies the exit digital input sensor parameters.

Parameters:

name - specifies the name of the sensor.

inverted - specifies true if the sensor polarity is inverted, false otherwise.

triggerCallback - specifies the callback method when trigger event occurred, null if not provided.

Returns:

this object for chaining.

setExitAnalogInput

public FtcIntake.Params setExitAnalogInput(String name,
 boolean inverted,
 double threshold,
 TrcEvent.Callback triggerCallback)

This method specifies the exit analog input sensor parameters.

Parameters:

name - specifies the name of the sensor.

inverted - specifies true if the sensor polarity is inverted, false otherwise.

threshold - specifies the sensor threshold value.

triggerCallback - specifies the callback method when trigger event occurred, null if not provided.

Returns:

this object for chaining.

setExitAnalogSensor

public FtcIntake.Params setExitAnalogSensor(TrcAnalogSensor.AnalogDataSource analogSensorData,
 boolean inverted,
 double threshold,
 TrcEvent.Callback triggerCallback)

This method specifies the exit analog sensor parameters.

Parameters:

analogSensorData - specifies the method to call to get the analog sensor data.

inverted - specifies true if the sensor polarity is inverted, false otherwise.

threshold - specifies the sensor threshold value.

triggerCallback - specifies the callback method when trigger event occurred, null if not provided.

Returns:

this object for chaining.