io.github.robolib.module.sensor

Enum HMC5883L.Averaging

java.lang.Object

java.lang.Enum<HMC5883L.Averaging>

io.github.robolib.module.sensor.HMC5883L.Averaging

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HMC5883L.Averaging>

Enclosing class:

HMC5883L

public static enum HMC5883L.Averaging
extends java.lang.Enum<HMC5883L.Averaging>

Select number of samples averaged (1 to 8) per measurement output. 00 = 1(Default); 01 = 2; 10 = 4; 11 = 8

Author:

noriah

Enum Constant Summary

Enum Constants

Enum Constant and Description
k1SAMPLES 1 Sample (Default)
k2SAMPLES 2 Samples
k3SAMPLES 4 Samples
k4SAMPLES 8 Samples

Field Summary

Fields

Modifier and Type	Field and Description
byte	value

Method Summary

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

k1SAMPLES

public static final HMC5883L.Averaging k1SAMPLES

1 Sample (Default)

k2SAMPLES

public static final HMC5883L.Averaging k2SAMPLES

2 Samples

k3SAMPLES

public static final HMC5883L.Averaging k3SAMPLES

4 Samples

k4SAMPLES

public static final HMC5883L.Averaging k4SAMPLES

8 Samples

Field Detail

value

public byte value

Method Detail

values

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

Returns:

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

valueOf

public static HMC5883L.Averaging 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