ch.eitchnet.beaglebone

Enum Signal

java.lang.Object

java.lang.Enum<Signal>

ch.eitchnet.beaglebone.Signal

All Implemented Interfaces:

Serializable, Comparable<Signal>

public enum Signal
extends Enum<Signal>

Defines the Signal which a Gpio can have

A pin's signal is its current value. Depending on the Gpio's Direction, the signal is an input value, or an output value.

A signal of LOW means that the value is 0, and a value of HIGH means the value is 1

Author:

Robert von Burg <eitch@eitchnet.ch>

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIGH
LOW

Method Summary

Modifier and Type	Method and Description
Signal	getOpposite()
String	getSignal()
static Signal	getSignal(int value) Returns the Signal enum for the given value
static Signal	getSignal(String valueS) Returns the Signal enum for the given string value
int	getValue()
String	getValueS()
boolean	isHigh()
static Signal	valueOf(String name) Returns the enum constant of this type with the specified name.
static Signal[]	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

LOW

public static final Signal LOW

HIGH

public static final Signal HIGH

Method Detail

values

public static Signal[] 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 (Signal c : Signal.values())
    System.out.println(c);

Returns:

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

valueOf

public static Signal 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

getValue

public int getValue()

Returns:

the value which is either 0 or 1

getValueS

public String getValueS()

Returns:

the value as a string which is either 0 or 1

isHigh

public boolean isHigh()

Returns:

true for a high signal, i.e. value of 1. Return false for a low value, i.e. a value of 0

getSignal

public String getSignal()

Returns:

true for a low signal, i.e. value of 0. Return false for a high value, i.e. a value of 1

getOpposite

public Signal getOpposite()

Returns:

the opposite of the current Signal

getSignal

public static Signal getSignal(int value)

Returns the Signal enum for the given value

Parameters:

value - the value for which to return the Signal

Returns:

the Signal for the given value

getSignal

public static Signal getSignal(String valueS)

Returns the Signal enum for the given string value

Parameters:

valueS - the value for which to return the Signal

Returns:

the Signal for the given string value