com.qualcomm.hardware.lynx

Enum LynxModule.BulkCachingMode

java.lang.Object

java.lang.Enum<LynxModule.BulkCachingMode>

com.qualcomm.hardware.lynx.LynxModule.BulkCachingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LynxModule.BulkCachingMode>

Enclosing class:

LynxModule

public static enum LynxModule.BulkCachingMode
extends java.lang.Enum<LynxModule.BulkCachingMode>

Bulk caching mode that controls the behavior of certain read commands.

See Also:

LynxModule.BulkData

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Same as MANUAL except the cache is also cleared automatically when the same command is issued twice.
MANUAL Replace eligible commands with the results of a cached bulk read.
OFF Never replace commands with cached bulk read results.

Method Summary

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

OFF

public static final LynxModule.BulkCachingMode OFF

Never replace commands with cached bulk read results.

MANUAL

public static final LynxModule.BulkCachingMode MANUAL

Replace eligible commands with the results of a cached bulk read. The cache must be manually cleared with LynxModule.clearBulkCache() before another bulk read is issued. This should only be used by advanced users. A common pattern is placing a single LynxModule.clearBulkCache() call at the start of every hardware loop.

AUTO

public static final LynxModule.BulkCachingMode AUTO

Same as MANUAL except the cache is also cleared automatically when the same command is issued twice. This mode is intended for beginning users that want to benefit from bulk reads without explicit cache-handling code.

Method Detail

values

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

Returns:

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

valueOf

public static LynxModule.BulkCachingMode 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