org.rocstreaming.roctoolkit

Enum ClockSource

java.lang.Object

java.lang.Enum<ClockSource>

org.rocstreaming.roctoolkit.ClockSource

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ClockSource>

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

Clock source for sender or receiver.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXTERNAL Sender or receiver is clocked by external user-defined clock.
INTERNAL Sender or receiver is clocked by an internal clock.

Method Summary

Modifier and Type	Method and Description
static ClockSource	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ClockSource[]	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

EXTERNAL

public static final ClockSource EXTERNAL

Sender or receiver is clocked by external user-defined clock. Write and read operations are non-blocking. The user is responsible to call them in time, according to the external clock.

INTERNAL

public static final ClockSource INTERNAL

Sender or receiver is clocked by an internal clock. Write and read operations are blocking. They automatically wait until it's time to process the next bunch of samples according to the configured sample rate.

Method Detail

values

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

Returns:

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

valueOf

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