Class Throttle

java.lang.Object

Throttle

public class Throttle
extends java.lang.Object

The Throttle class provides a multiple position flow rate throttle that also for controlled flow rates between 0 and a maximum rate set.

Author:

Michael Main

Constructor Summary

Constructors

Constructor and Description
Throttle(int size) Construct a Throttle with a specified number of on positions.

Method Summary

Modifier and Type	Method and Description
double	getFlow() Get the current flow of this Throttle.
boolean	isOn() Check whether this Throttle is on.
void	shift(int amount) Move this Throttle's position up or down
void	shutOff() Turn off this Throttle.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Throttle

public Throttle(int size)

Construct a Throttle with a specified number of on positions.

Parameters:

size - The number of on positions for this new Throttle.

Precondition:

size > 0

Postcondition:

This Throttle has been initialized with the specified number of on positions above the shut off point, and its is currently shut off.

Throws:

java.lang.IllegalArgumentException - if size less than or equal to 0

Method Detail

getFlow

public double getFlow()

Get the current flow of this Throttle.

Returns:

The current flow rate (always in the range [0.0 ... 1.0]) as a proportion of the maximum flow

isOn

public boolean isOn()

Check whether this Throttle is on.

Returns:

If this Throttle's flow is above zero, then the return value is true; otherwise, the return value is false.

shift

public void shift(int amount)

Move this Throttle's position up or down

Parameters:

amount - The amount to move the position up or down (a positive amount moves the position up; a negative amount moves it down).

Postcondition:

This Throttle's position has been moved by the specified amount. If the result is more than the topmost position, then the position stays the topmost position. If the result is less than the zero position, then the position stays at the zero position.

shutOff

public void shutOff()

Turn off this Throttle.

Postcondition:

This Throttle has been shut off.