org.chabala.brick.controllab

Class Output

java.lang.Object

org.chabala.brick.controllab.Output

public class Output
extends Object

Handle for an output port (or group of ports) on a specific control lab instance. Obtain via ControlLab.getOutput(OutputId) or ControlLab.getOutput(Set).

Method Summary

Modifier and Type	Method and Description
Set<OutputId>	getOutputIdSet() Returns set of OutputIds this Output relates to.
Output	reverseDirection() Reverses the Direction of this output.
Output	setDirection(Direction direction) Sets the Direction of this output.
Output	setPowerLevel(PowerLevel powerLevel) Sets the PowerLevel of this output.
String	toString()
Output	turnOff() Stops sending power to this output.
Output	turnOn() Starts sending power to this output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getOutputIdSet

public Set<OutputId> getOutputIdSet()

Returns set of OutputIds this Output relates to. In normal usage, this is unlikely to be called as one would obtain the Output from ControlLab.getOutput(OutputId) and immediately chain one of the fluent method calls. But it can useful to inspect the OutputIds if the Output reference is retained and seperated from the creation site.

Returns:

set of OutputIds this Output relates to

turnOff

public Output turnOff()
               throws IOException

Stops sending power to this output.

Returns:

self reference to the output for chaining

Throws:

IOException - if any number of possible communication issues occurs

turnOn

public Output turnOn()
              throws IOException

Starts sending power to this output.

Returns:

self reference to the output for chaining

Throws:

IOException - if any number of possible communication issues occurs

setDirection

public Output setDirection(Direction direction)
                    throws IOException

Sets the Direction of this output. Direction may be changed while the output is powered or unpowered.

Parameters:

direction - desired direction

Returns:

self reference to the output for chaining

Throws:

IOException - if any number of possible communication issues occurs

reverseDirection

public Output reverseDirection()
                        throws IOException

Reverses the Direction of this output. This is a convenience method that is the same as setDirection(Direction.REVERSE).

Returns:

self reference to the output for chaining

Throws:

IOException - if any number of possible communication issues occurs

setPowerLevel

public Output setPowerLevel(PowerLevel powerLevel)
                     throws IOException

Sets the PowerLevel of this output. Power level may be changed while the output is powered or unpowered.

Parameters:

powerLevel - desired power level

Returns:

self reference to the output for chaining

Throws:

IOException - if any number of possible communication issues occurs

toString

public String toString()

Overrides:

toString in class Object