kernel.models.VoltageSetPointAlgorithm Class Reference

Inheritance diagram for kernel.models.VoltageSetPointAlgorithm:

Collaboration diagram for kernel.models.VoltageSetPointAlgorithm:

Classes
class	VoltageSetPointTask

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

Detailed Description

Created by mkononen on 23/02/17.

Definition at line 18 of file models/VoltageSetPointAlgorithm.java.

Member Function Documentation

Double kernel.models.VoltageSetPointAlgorithm.getDesiredVoltage

(

)

Returns

The desired voltage

Implements kernel.controllers.VoltageSetPointAlgorithm.

Definition at line 67 of file models/VoltageSetPointAlgorithm.java.

                                     {
        return desiredVoltage;
    }

Kernel kernel.models.VoltageSetPointAlgorithm.getKernel

(

)

Returns

The kernel to which this algorithm is currently attached

Implements kernel.controllers.ControlAlgorithm.

Definition at line 52 of file models/VoltageSetPointAlgorithm.java.

                             {
        return kernel;
    }

Integer kernel.models.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.

Implements kernel.controllers.VoltageSetPointAlgorithm.

Definition at line 87 of file models/VoltageSetPointAlgorithm.java.

                                         {
        return maximumIterations;
    }

Float kernel.models.VoltageSetPointAlgorithm.getPressureUpperBound

(

)

Returns

The maximum pressure allowed

Implements kernel.controllers.VoltageSetPointAlgorithm.

Definition at line 77 of file models/VoltageSetPointAlgorithm.java.

                                        {
        return pressureUpperBound;
    }

Double kernel.models.VoltageSetPointAlgorithm.getProgress

(

)

Returns

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

Implements kernel.controllers.ControlAlgorithm.

Definition at line 131 of file models/VoltageSetPointAlgorithm.java.

                               {
        Double voltage;
        try {
            voltage = kernel.getDeviceRegistryView().getPowerSupply()
                    .getMeasuredVoltage();
        } catch (IOException error){
            voltage = 0.0;
        }

        return voltage/desiredVoltage;
    }

Boolean kernel.models.VoltageSetPointAlgorithm.isRunning

(

)

Returns

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

Implements kernel.controllers.ControlAlgorithm.

Definition at line 62 of file models/VoltageSetPointAlgorithm.java.

                              {
        return isRunning;
    }

void kernel.models.VoltageSetPointAlgorithm.run

(

)

throws UnableToRunControlAlgorithmException

Start the task

Exceptions

UnableToRunControlAlgorithmException

if the task cannot be started

Implements kernel.controllers.ControlAlgorithm.

Definition at line 31 of file models/VoltageSetPointAlgorithm.java.

                                                                  {
        assertCanRun();
        isRunning = Boolean.TRUE;

        VoltageSetPointTask task;

        try {
            task = new VoltageSetPointTask(
                kernel, maximumIterations, pressureUpperBound, desiredVoltage
            );
        } catch (IOException error){
            log.error("Unable to create voltage setpoint task", error);
            throw new UnableToRunControlAlgorithmException(
                    "Task creation threw IOException"
            );
        }

        kernel.getTaskRunner().execute(task);
    }

void kernel.models.VoltageSetPointAlgorithm.setDesiredVoltage

(

Double

desiredVoltage

)

Parameters

desiredVoltage

The voltage at which this algorithm is to terminate

Implements kernel.controllers.VoltageSetPointAlgorithm.

Definition at line 72 of file models/VoltageSetPointAlgorithm.java.

                                                        {
        this.desiredVoltage = desiredVoltage;
    }

void kernel.models.VoltageSetPointAlgorithm.setKernel

(

Kernel

kernel

)

Parameters

kernel

The kernel to which this algorithm is to be attached

Implements kernel.controllers.ControlAlgorithm.

Definition at line 57 of file models/VoltageSetPointAlgorithm.java.

                                        {
        this.kernel = kernel;
    }

void kernel.models.VoltageSetPointAlgorithm.setMaximumIterations

(

Integer

maximumIterations

)

Parameters

maximumIterations

The desired maximum number of iterations

Implements kernel.controllers.VoltageSetPointAlgorithm.

Definition at line 92 of file models/VoltageSetPointAlgorithm.java.

                                                               {
        this.maximumIterations = maximumIterations;
    }

void kernel.models.VoltageSetPointAlgorithm.setPressureUpperBound

(

Float

pressureUpperBound

)

Parameters

pressureUpperBound

The maximum allowed pressure

Implements kernel.controllers.VoltageSetPointAlgorithm.

Definition at line 82 of file models/VoltageSetPointAlgorithm.java.

                                                               {
        this.pressureUpperBound = pressureUpperBound;
    }

---

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

• models/VoltageSetPointAlgorithm.java