kernel.controllers.ControlAlgorithm Interface Reference

Inheritance diagram for kernel.controllers.ControlAlgorithm:

Public Member Functions
Boolean	isRunning ()
Kernel	getKernel ()
void	setKernel (Kernel kernel)
void	run () throws UnableToRunControlAlgorithmException
Double	getProgress ()

Detailed Description

Base class for variable control sequences.

Definition at line 9 of file ControlAlgorithm.java.

Member Function Documentation

Kernel kernel.controllers.ControlAlgorithm.getKernel

(

)

Returns

The kernel to which this algorithm is currently attached

Implemented in kernel.models.VoltageSetPointAlgorithm.

Double kernel.controllers.ControlAlgorithm.getProgress

(

)

Returns

A number from 0 to 1 indicating how far along the task is.

Implemented in kernel.models.VoltageSetPointAlgorithm.

Boolean kernel.controllers.ControlAlgorithm.isRunning

(

)

Returns

Boolean#TRUE if the algorithm is running, and Boolean#FALSE if not

Implemented in kernel.models.VoltageSetPointAlgorithm.

void kernel.controllers.ControlAlgorithm.run

(

)

throws UnableToRunControlAlgorithmException

Start the task

Exceptions

UnableToRunControlAlgorithmException

if the task cannot be started

Implemented in kernel.models.VoltageSetPointAlgorithm.

void kernel.controllers.ControlAlgorithm.setKernel

(

Kernel

kernel

)

Parameters

kernel

The kernel to which this algorithm is to be attached

Implemented in kernel.models.VoltageSetPointAlgorithm.

---

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

• ControlAlgorithm.java