io.github.robolib.module.sensor

Enum HMC5883L.Gain

java.lang.Object

java.lang.Enum<HMC5883L.Gain>

io.github.robolib.module.sensor.HMC5883L.Gain

All Implemented Interfaces:

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

Enclosing class:

HMC5883L

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

Gain Configuration Bits These bits configure the gain for the device. The gain configuration is common for all channels.

Author:

noriah

Enum Constant Summary

Enum Constants

Enum Constant and Description
k1090 +/- 1.30 Ga / 1090 Gain LSb/Gauss (Default)
k1370 +/- 0.88 Ga / 1370 Gain LSb/Gauss
k230 +/- 8.10 Ga / 230 Gain LSb/Gauss
k330 +/- 5.60 Ga / 330 Gain LSb/Gauss
k390 +/- 4.70 Ga / 390 Gain LSb/Gauss
k440 +/- 4.00 Ga / 440 Gain LSb/Gauss
k660 +/- 2.50 Ga / 660 Gain LSb/Gauss
k820 +/- 1.90 Ga / 820 Gain LSb/Gauss

Field Summary

Fields

Modifier and Type	Field and Description
byte	value

Method Summary

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

k1370

public static final HMC5883L.Gain k1370

+/- 0.88 Ga / 1370 Gain LSb/Gauss

k1090

public static final HMC5883L.Gain k1090

+/- 1.30 Ga / 1090 Gain LSb/Gauss (Default)

k820

public static final HMC5883L.Gain k820

+/- 1.90 Ga / 820 Gain LSb/Gauss

k660

public static final HMC5883L.Gain k660

+/- 2.50 Ga / 660 Gain LSb/Gauss

k440

public static final HMC5883L.Gain k440

+/- 4.00 Ga / 440 Gain LSb/Gauss

k390

public static final HMC5883L.Gain k390

+/- 4.70 Ga / 390 Gain LSb/Gauss

k330

public static final HMC5883L.Gain k330

+/- 5.60 Ga / 330 Gain LSb/Gauss

k230

public static final HMC5883L.Gain k230

+/- 8.10 Ga / 230 Gain LSb/Gauss

Field Detail

value

public byte value

Method Detail

values

public static HMC5883L.Gain[] 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.Gain c : HMC5883L.Gain.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.Gain 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