ioio.lib.api
Enum PulseInput.PulseMode

java.lang.Object
  java.lang.Enum<PulseInput.PulseMode>
      ioio.lib.api.PulseInput.PulseMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PulseInput.PulseMode>

Enclosing interface:

PulseInput

public static enum PulseInput.PulseMode
extends java.lang.Enum<PulseInput.PulseMode>

An enumeration for describing the module's operating mode.

Enum Constant Summary

FREQ
Frequency measurement (rising-edge-to-rising-edge).

FREQ_SCALE_16
Frequency measurement (rising-edge-to-rising-edge) with 16x scaling.

FREQ_SCALE_4
Frequency measurement (rising-edge-to-rising-edge) with 4x scaling.

NEGATIVE
Negative pulse measurement (falling-edge-to-rising-edge).

POSITIVE
Positive pulse measurement (rising-edge-to-falling-edge).

Field Summary

int	scaling The scaling factor as an integer.

Method Summary

static PulseInput.PulseMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PulseInput.PulseMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POSITIVE

public static final PulseInput.PulseMode POSITIVE

Positive pulse measurement (rising-edge-to-falling-edge).

NEGATIVE

public static final PulseInput.PulseMode NEGATIVE

Negative pulse measurement (falling-edge-to-rising-edge).

FREQ

public static final PulseInput.PulseMode FREQ

Frequency measurement (rising-edge-to-rising-edge).

FREQ_SCALE_4

public static final PulseInput.PulseMode FREQ_SCALE_4

Frequency measurement (rising-edge-to-rising-edge) with 4x scaling.

FREQ_SCALE_16

public static final PulseInput.PulseMode FREQ_SCALE_16

Frequency measurement (rising-edge-to-rising-edge) with 16x scaling.

Field Detail

scaling

public final int scaling

The scaling factor as an integer.

Method Detail

values

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

Returns:

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

valueOf

public static PulseInput.PulseMode 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