BowlerKernel
Public Member Functions | Private Attributes | List of all members
com.neuronrobotics.sdk.pid.PIDConfiguration Class Reference

Public Member Functions

 PIDConfiguration ()
 
 PIDConfiguration (int channel)
 
 PIDConfiguration (int group, boolean enabled, boolean inverted, boolean async, double KP, double KI, double KD, double latch, boolean useLatch, boolean stopOnLatch, double up, double low, double hStop)
 
 PIDConfiguration (int group, boolean enabled, boolean inverted, boolean async, double KP, double KI, double KD, double latch, boolean useLatch, boolean stopOnLatch)
 
 PIDConfiguration (BowlerDatagram conf)
 
 PIDConfiguration (Object[] args)
 
String toString ()
 
void setGroup (int group)
 
int getGroup ()
 
void setEnabled (boolean enabled)
 
boolean isEnabled ()
 
void setInverted (boolean inverted)
 
boolean isInverted ()
 
void setAsync (boolean async)
 
boolean isAsync ()
 
void setKP (double kP)
 
double getKP ()
 
void setKI (double kI)
 
double getKI ()
 
void setKD (double kD)
 
double getKD ()
 
double getIndexLatch ()
 
void setIndexLatch (double latch)
 
void setUseLatch (boolean useLatch)
 
boolean isUseLatch ()
 
void setStopOnIndex (boolean stopOnIndex)
 
boolean isStopOnIndex ()
 
Object[] getArgs ()
 
double getUpperHystersys ()
 
void setUpperHystersys (double up)
 
double getLowerHystersys ()
 
void setLowerHystersys (double low)
 
double getHystersysStop ()
 
void setHystersysStop (double hStop)
 

Private Attributes

int group =0
 
boolean enabled =false
 
boolean inverted =false
 
boolean async =false
 
double KP =.1
 
double KI =0
 
double KD =0
 
int latch =0
 
boolean useLatch =false
 
boolean stopOnIndex =false
 
double up =0
 
double low =0
 
double hStop =0
 

Detailed Description

The Class PIDConfiguration.

Definition at line 10 of file PIDConfiguration.java.

Constructor & Destructor Documentation

◆ PIDConfiguration() [1/6]

com.neuronrobotics.sdk.pid.PIDConfiguration.PIDConfiguration ( )

Instantiates a new PID configuration.

Definition at line 54 of file PIDConfiguration.java.

◆ PIDConfiguration() [2/6]

com.neuronrobotics.sdk.pid.PIDConfiguration.PIDConfiguration ( int  channel)

Instantiates a new PID configuration.

Parameters
channelthe channel

Definition at line 63 of file PIDConfiguration.java.

References com.neuronrobotics.sdk.pid.PIDConfiguration.group.

◆ PIDConfiguration() [3/6]

com.neuronrobotics.sdk.pid.PIDConfiguration.PIDConfiguration ( int  group,
boolean  enabled,
boolean  inverted,
boolean  async,
double  KP,
double  KI,
double  KD,
double  latch,
boolean  useLatch,
boolean  stopOnLatch,
double  up,
double  low,
double  hStop 
)

Instantiates a new PID configuration.

Parameters
groupThis is the PID group this configuration object represents
enabledTrue if the controller is running, false otherwise
invertedThis inverts the output value. Set true if the controller diverges
asyncsets the flag to send this channels async values upstream
KPProportional constant
KIIntegral constant
KDDerivative constant
latchThe value to latch into the PID controller if the home switch is hit (encoder only, not used in analog PID)
useLatchUse the value to latch into the PID controller if the home switch is hit (encoder only, not used in analog PID)
stopOnLatchSet the setpoint of the controller to current if home switch is hit (encoder only, not used in analog PID)
upthe up
lowthe low
hStopthe h stop

Definition at line 84 of file PIDConfiguration.java.

References com.neuronrobotics.sdk.pid.PIDConfiguration.async, com.neuronrobotics.sdk.pid.PIDConfiguration.enabled, com.neuronrobotics.sdk.pid.PIDConfiguration.group, com.neuronrobotics.sdk.pid.PIDConfiguration.hStop, com.neuronrobotics.sdk.pid.PIDConfiguration.inverted, com.neuronrobotics.sdk.pid.PIDConfiguration.KD, com.neuronrobotics.sdk.pid.PIDConfiguration.KI, com.neuronrobotics.sdk.pid.PIDConfiguration.KP, com.neuronrobotics.sdk.pid.PIDConfiguration.latch, com.neuronrobotics.sdk.pid.PIDConfiguration.low, com.neuronrobotics.sdk.pid.PIDConfiguration.setAsync(), com.neuronrobotics.sdk.pid.PIDConfiguration.setEnabled(), com.neuronrobotics.sdk.pid.PIDConfiguration.setGroup(), com.neuronrobotics.sdk.pid.PIDConfiguration.setHystersysStop(), com.neuronrobotics.sdk.pid.PIDConfiguration.setIndexLatch(), com.neuronrobotics.sdk.pid.PIDConfiguration.setInverted(), com.neuronrobotics.sdk.pid.PIDConfiguration.setKD(), com.neuronrobotics.sdk.pid.PIDConfiguration.setKI(), com.neuronrobotics.sdk.pid.PIDConfiguration.setKP(), com.neuronrobotics.sdk.pid.PIDConfiguration.setLowerHystersys(), com.neuronrobotics.sdk.pid.PIDConfiguration.setStopOnIndex(), com.neuronrobotics.sdk.pid.PIDConfiguration.setUpperHystersys(), com.neuronrobotics.sdk.pid.PIDConfiguration.setUseLatch(), com.neuronrobotics.sdk.pid.PIDConfiguration.up, and com.neuronrobotics.sdk.pid.PIDConfiguration.useLatch.

Here is the call graph for this function:

◆ PIDConfiguration() [4/6]

com.neuronrobotics.sdk.pid.PIDConfiguration.PIDConfiguration ( int  group,
boolean  enabled,
boolean  inverted,
boolean  async,
double  KP,
double  KI,
double  KD,
double  latch,
boolean  useLatch,
boolean  stopOnLatch 
)

◆ PIDConfiguration() [5/6]

com.neuronrobotics.sdk.pid.PIDConfiguration.PIDConfiguration ( BowlerDatagram  conf)

◆ PIDConfiguration() [6/6]

com.neuronrobotics.sdk.pid.PIDConfiguration.PIDConfiguration ( Object[]  args)

Member Function Documentation

◆ getArgs()

Object [] com.neuronrobotics.sdk.pid.PIDConfiguration.getArgs ( )

◆ getGroup()

int com.neuronrobotics.sdk.pid.PIDConfiguration.getGroup ( )

◆ getHystersysStop()

double com.neuronrobotics.sdk.pid.PIDConfiguration.getHystersysStop ( )

Gets the hystersys stop.

Returns
the hystersys stop

Definition at line 442 of file PIDConfiguration.java.

References com.neuronrobotics.sdk.pid.PIDConfiguration.hStop.

Referenced by com.neuronrobotics.sdk.pid.PIDConfiguration.toString().

◆ getIndexLatch()

double com.neuronrobotics.sdk.pid.PIDConfiguration.getIndexLatch ( )

◆ getKD()

double com.neuronrobotics.sdk.pid.PIDConfiguration.getKD ( )

◆ getKI()

double com.neuronrobotics.sdk.pid.PIDConfiguration.getKI ( )

◆ getKP()

double com.neuronrobotics.sdk.pid.PIDConfiguration.getKP ( )

◆ getLowerHystersys()

double com.neuronrobotics.sdk.pid.PIDConfiguration.getLowerHystersys ( )

Gets the lower hystersys.

Returns
the lower hystersys

Definition at line 424 of file PIDConfiguration.java.

References com.neuronrobotics.sdk.pid.PIDConfiguration.low.

Referenced by com.neuronrobotics.sdk.pid.PIDConfiguration.toString().

◆ getUpperHystersys()

double com.neuronrobotics.sdk.pid.PIDConfiguration.getUpperHystersys ( )

Gets the upper hystersys.

Returns
the upper hystersys

Definition at line 406 of file PIDConfiguration.java.

References com.neuronrobotics.sdk.pid.PIDConfiguration.up.

Referenced by com.neuronrobotics.sdk.pid.PIDConfiguration.toString().

◆ isAsync()

boolean com.neuronrobotics.sdk.pid.PIDConfiguration.isAsync ( )

◆ isEnabled()

boolean com.neuronrobotics.sdk.pid.PIDConfiguration.isEnabled ( )

◆ isInverted()

boolean com.neuronrobotics.sdk.pid.PIDConfiguration.isInverted ( )

◆ isStopOnIndex()

boolean com.neuronrobotics.sdk.pid.PIDConfiguration.isStopOnIndex ( )

◆ isUseLatch()

boolean com.neuronrobotics.sdk.pid.PIDConfiguration.isUseLatch ( )

◆ setAsync()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setAsync ( boolean  async)

◆ setEnabled()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setEnabled ( boolean  enabled)

◆ setGroup()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setGroup ( int  group)

◆ setHystersysStop()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setHystersysStop ( double  hStop)

Sets the hystersys stop.

Parameters
hStopthe new hystersys stop

Definition at line 451 of file PIDConfiguration.java.

References com.neuronrobotics.sdk.pid.PIDConfiguration.hStop.

Referenced by com.neuronrobotics.sdk.pid.PIDConfiguration.PIDConfiguration().

◆ setIndexLatch()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setIndexLatch ( double  latch)

◆ setInverted()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setInverted ( boolean  inverted)

◆ setKD()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setKD ( double  kD)

◆ setKI()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setKI ( double  kI)

◆ setKP()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setKP ( double  kP)

◆ setLowerHystersys()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setLowerHystersys ( double  low)

Sets the lower hystersys.

Parameters
lowthe new lower hystersys

Definition at line 433 of file PIDConfiguration.java.

References com.neuronrobotics.sdk.pid.PIDConfiguration.low.

Referenced by com.neuronrobotics.sdk.pid.PIDConfiguration.PIDConfiguration().

◆ setStopOnIndex()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setStopOnIndex ( boolean  stopOnIndex)

◆ setUpperHystersys()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setUpperHystersys ( double  up)

Sets the upper hystersys.

Parameters
upthe new upper hystersys

Definition at line 415 of file PIDConfiguration.java.

References com.neuronrobotics.sdk.pid.PIDConfiguration.up.

Referenced by com.neuronrobotics.sdk.pid.PIDConfiguration.PIDConfiguration().

◆ setUseLatch()

void com.neuronrobotics.sdk.pid.PIDConfiguration.setUseLatch ( boolean  useLatch)

◆ toString()

String com.neuronrobotics.sdk.pid.PIDConfiguration.toString ( )

Member Data Documentation

◆ async

boolean com.neuronrobotics.sdk.pid.PIDConfiguration.async =false
private

◆ enabled

boolean com.neuronrobotics.sdk.pid.PIDConfiguration.enabled =false
private

◆ group

int com.neuronrobotics.sdk.pid.PIDConfiguration.group =0
private

◆ hStop

double com.neuronrobotics.sdk.pid.PIDConfiguration.hStop =0
private

◆ inverted

boolean com.neuronrobotics.sdk.pid.PIDConfiguration.inverted =false
private

◆ KD

double com.neuronrobotics.sdk.pid.PIDConfiguration.KD =0
private

◆ KI

double com.neuronrobotics.sdk.pid.PIDConfiguration.KI =0
private

◆ KP

double com.neuronrobotics.sdk.pid.PIDConfiguration.KP =.1
private

◆ latch

int com.neuronrobotics.sdk.pid.PIDConfiguration.latch =0
private

◆ low

double com.neuronrobotics.sdk.pid.PIDConfiguration.low =0
private

◆ stopOnIndex

boolean com.neuronrobotics.sdk.pid.PIDConfiguration.stopOnIndex =false
private

◆ up

double com.neuronrobotics.sdk.pid.PIDConfiguration.up =0
private

◆ useLatch

boolean com.neuronrobotics.sdk.pid.PIDConfiguration.useLatch =false
private

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