org.chabala.brick.controllab

Enum OutputId

java.lang.Object

java.lang.Enum<OutputId>

org.chabala.brick.controllab.OutputId

All Implemented Interfaces:

Serializable, Comparable<OutputId>

public enum OutputId
extends Enum<OutputId>

Identifiers for the output ports on the control lab.

Enum Constant Summary

Enum Constants

Enum Constant and Description
A Output A.
B Output B.
C Output C.
D Output D.
E Output E.
F Output F.
G Output G.
H Output H.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<OutputId>	ALL Convenience constant for specifying all output ports.

Method Summary

Modifier and Type	Method and Description
static Set<OutputId>	decodeByteToSet(byte b) Decodes a byte into a Set of OutputIds.
static <T extends Enum<T>> byte	encodeSetToByte(Set<T> set) Encodes values from a Set of Enums to a byte.
static OutputId	valueOf(String name) Returns the enum constant of this type with the specified name.
static OutputId[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

A

public static final OutputId A

Output A.

B

public static final OutputId B

Output B.

C

public static final OutputId C

Output C.

D

public static final OutputId D

Output D.

E

public static final OutputId E

Output E.

F

public static final OutputId F

Output F.

G

public static final OutputId G

Output G.

H

public static final OutputId H

Output H.

Field Detail

ALL

public static final Set<OutputId> ALL

Convenience constant for specifying all output ports.

Method Detail

values

public static OutputId[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OutputId c : OutputId.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OutputId valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

encodeSetToByte

public static <T extends Enum<T>> byte encodeSetToByte(Set<T> set)

Encodes values from a Set of Enums to a byte. Uses the ordinal of the Enum as the position of the bit in the byte to set high.

Type Parameters:

T - type of Enum, only used with OutputId internally

Parameters:

set - set of values to be encoded

Returns:

a byte with high bits relating to the values in the set

decodeByteToSet

public static Set<OutputId> decodeByteToSet(byte b)

Decodes a byte into a Set of OutputIds.

Parameters:

b - byte where each bit corresponds to the ordinal of an Output

Returns:

a Set containing the desired Outputs