ESP OpenBCI - An EEG Signal Processing Library for OpenBCI Hardware

com.github.mrstampy.esp.openbci
Enum OpenBCIChannelCommand

java.lang.Object
  extended by java.lang.Enum<OpenBCIChannelCommand>
      extended by com.github.mrstampy.esp.openbci.OpenBCIChannelCommand
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<OpenBCIChannelCommand>

public enum OpenBCIChannelCommand
extends java.lang.Enum<OpenBCIChannelCommand>

The Enum OpenBCIChannelCommand.


Enum Constant Summary
CHANNEL_EIGHT
          The channel eight.
CHANNEL_FIVE
          The channel five.
CHANNEL_FOUR
          The channel four.
CHANNEL_ONE
          The channel one.
CHANNEL_SEVEN
          The channel seven.
CHANNEL_SIX
          The channel six.
CHANNEL_THREE
          The channel three.
CHANNEL_TWO
          The channel two.
 
Method Summary
 java.lang.String getActivate()
          Gets the activate.
 java.lang.String getActivateLeadoffN()
          Gets the activate leadoff n.
 java.lang.String getActivateLeadoffP()
          Gets the activate leadoff p.
 int getChannelNumber()
          Gets the channel number.
 java.lang.String getDeactivate()
          Gets the deactivate.
 java.lang.String getDeactivateLeadoffN()
          Gets the deactivate leadoff n.
 java.lang.String getDeactivateLeadoffP()
          Gets the deactivate leadoff p.
static OpenBCIChannelCommand getFromChannelNumber(int channelNumber)
          Gets the from channel number.
static OpenBCIChannelCommand valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static OpenBCIChannelCommand[] 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

CHANNEL_ONE

public static final OpenBCIChannelCommand CHANNEL_ONE
The channel one.


CHANNEL_TWO

public static final OpenBCIChannelCommand CHANNEL_TWO
The channel two.


CHANNEL_THREE

public static final OpenBCIChannelCommand CHANNEL_THREE
The channel three.


CHANNEL_FOUR

public static final OpenBCIChannelCommand CHANNEL_FOUR
The channel four.


CHANNEL_FIVE

public static final OpenBCIChannelCommand CHANNEL_FIVE
The channel five.


CHANNEL_SIX

public static final OpenBCIChannelCommand CHANNEL_SIX
The channel six.


CHANNEL_SEVEN

public static final OpenBCIChannelCommand CHANNEL_SEVEN
The channel seven.


CHANNEL_EIGHT

public static final OpenBCIChannelCommand CHANNEL_EIGHT
The channel eight.

Method Detail

values

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

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

valueOf

public static OpenBCIChannelCommand valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getChannelNumber

public int getChannelNumber()
Gets the channel number.

Returns:
the channel number

getActivate

public java.lang.String getActivate()
Gets the activate.

Returns:
the activate

getDeactivate

public java.lang.String getDeactivate()
Gets the deactivate.

Returns:
the deactivate

getActivateLeadoffP

public java.lang.String getActivateLeadoffP()
Gets the activate leadoff p.

Returns:
the activate leadoff p

getDeactivateLeadoffP

public java.lang.String getDeactivateLeadoffP()
Gets the deactivate leadoff p.

Returns:
the deactivate leadoff p

getActivateLeadoffN

public java.lang.String getActivateLeadoffN()
Gets the activate leadoff n.

Returns:
the activate leadoff n

getDeactivateLeadoffN

public java.lang.String getDeactivateLeadoffN()
Gets the deactivate leadoff n.

Returns:
the deactivate leadoff n

getFromChannelNumber

public static OpenBCIChannelCommand getFromChannelNumber(int channelNumber)
Gets the from channel number.

Parameters:
channelNumber - the channel number
Returns:
the from channel number

brought to you by Mr. Stampy