Package trclib.driverio

Enum Class TrcTone.Waveform

java.lang.Object

java.lang.Enum<TrcTone.Waveform>

trclib.driverio.TrcTone.Waveform

All Implemented Interfaces:

Serializable, Comparable<TrcTone.Waveform>, Constable

Enclosing class:

TrcTone

public static enum TrcTone.Waveform
extends Enum<TrcTone.Waveform>

This enum type specifies the sound waveform to be used in playing a note.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SINE_WAVE
SQUARE_WAVE
TRIANGLE_WAVE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Waveform()

Method Summary

Modifier and Type	Method	Description
static TrcTone.Waveform	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TrcTone.Waveform[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SINE_WAVE

public static final TrcTone.Waveform SINE_WAVE

SQUARE_WAVE

public static final TrcTone.Waveform SQUARE_WAVE

TRIANGLE_WAVE

public static final TrcTone.Waveform TRIANGLE_WAVE

Constructor Details

Waveform

private Waveform()

Method Details

values

public static TrcTone.Waveform[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TrcTone.Waveform valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null