BakeoutController-Basic  0.1
A Controller for the Omicron vacuum chamber
Public Member Functions | List of all members
kernel.controllers.VoltageSetPointAlgorithm Interface Reference
Inheritance diagram for kernel.controllers.VoltageSetPointAlgorithm:
Inheritance graph
[legend]
Collaboration diagram for kernel.controllers.VoltageSetPointAlgorithm:
Collaboration graph
[legend]

Public Member Functions

Double getDesiredVoltage ()
 
void setDesiredVoltage (Double desiredVoltage)
 
Float getPressureUpperBound ()
 
void setPressureUpperBound (Float pressureUpperBound)
 
Integer getMaximumIterations ()
 
void setMaximumIterations (Integer maximumIterations)
 
- Public Member Functions inherited from kernel.controllers.ControlAlgorithm
Boolean isRunning ()
 
Kernel getKernel ()
 
void setKernel (Kernel kernel)
 
void run () throws UnableToRunControlAlgorithmException
 
Double getProgress ()
 

Detailed Description

Describes an algorithm to bring the power supply voltage up to a particular value, while keeping the pressure below a particular value

Definition at line 7 of file controllers/VoltageSetPointAlgorithm.java.

Member Function Documentation

Double kernel.controllers.VoltageSetPointAlgorithm.getDesiredVoltage ( )
Returns
The desired voltage

Implemented in kernel.models.VoltageSetPointAlgorithm.

Integer kernel.controllers.VoltageSetPointAlgorithm.getMaximumIterations ( )
Returns
The maximum number of iterations that a particular step of the algorithm will iterate over before throwing an error. This is meant to provide an escape condition on the algorithm, ensuring that it will terminate.

Implemented in kernel.models.VoltageSetPointAlgorithm.

Float kernel.controllers.VoltageSetPointAlgorithm.getPressureUpperBound ( )
Returns
The maximum pressure allowed

Implemented in kernel.models.VoltageSetPointAlgorithm.

void kernel.controllers.VoltageSetPointAlgorithm.setDesiredVoltage ( Double  desiredVoltage)
Parameters
desiredVoltageThe voltage at which this algorithm is to terminate

Implemented in kernel.models.VoltageSetPointAlgorithm.

void kernel.controllers.VoltageSetPointAlgorithm.setMaximumIterations ( Integer  maximumIterations)
Parameters
maximumIterationsThe desired maximum number of iterations

Implemented in kernel.models.VoltageSetPointAlgorithm.

void kernel.controllers.VoltageSetPointAlgorithm.setPressureUpperBound ( Float  pressureUpperBound)
Parameters
pressureUpperBoundThe maximum allowed pressure

Implemented in kernel.models.VoltageSetPointAlgorithm.

The documentation for this interface was generated from the following file:
Git Repo