com.mbientlab.metawear.module

Enum Bmm150Magnetometer.ThresholdDetectionType

java.lang.Object

java.lang.Enum<Bmm150Magnetometer.ThresholdDetectionType>

com.mbientlab.metawear.module.Bmm150Magnetometer.ThresholdDetectionType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Bmm150Magnetometer.ThresholdDetectionType>

Enclosing interface:

Bmm150Magnetometer

public static enum Bmm150Magnetometer.ThresholdDetectionType
extends java.lang.Enum<Bmm150Magnetometer.ThresholdDetectionType>

Threshold detection types supported on the BMM150 magnetometer

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIGH_X Detect when the x-axis B field exceeds the threshold
HIGH_Y Detect when the y-axis B field exceeds the threshold
HIGH_Z Detect when the z-axis B field exceeds the threshold
LOW_X Detect when the x-axis B field drops below the threshold
LOW_Y Detect when the y-axis B field drops below the threshold
LOW_Z Detect when the z-axis B field drops below the threshold

Method Summary

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

LOW_X

public static final Bmm150Magnetometer.ThresholdDetectionType LOW_X

Detect when the x-axis B field drops below the threshold

LOW_Y

public static final Bmm150Magnetometer.ThresholdDetectionType LOW_Y

Detect when the y-axis B field drops below the threshold

LOW_Z

public static final Bmm150Magnetometer.ThresholdDetectionType LOW_Z

Detect when the z-axis B field drops below the threshold

HIGH_X

public static final Bmm150Magnetometer.ThresholdDetectionType HIGH_X

Detect when the x-axis B field exceeds the threshold

HIGH_Y

public static final Bmm150Magnetometer.ThresholdDetectionType HIGH_Y

Detect when the y-axis B field exceeds the threshold

HIGH_Z

public static final Bmm150Magnetometer.ThresholdDetectionType HIGH_Z

Detect when the z-axis B field exceeds the threshold

Method Detail

values

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

Returns:

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

valueOf

public static Bmm150Magnetometer.ThresholdDetectionType 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