ev3dev.sensors

Class GenericMode

java.lang.Object

ev3dev.sensors.GenericMode

public class GenericMode
extends java.lang.Object

Generic ev3dev sensor handler.

Note: data returned by fetchSample(float[], int) are valid only when the sensor itself is in the correct mode. Otherwise, wrong data will be returned.

Field Summary

Fields

Modifier and Type	Field and Description
private float	correctFactor
private float	correctMax
private float	correctMin
private java.lang.String	modeName
private java.io.File	pathDevice
private int	sampleSize

Constructor Summary

Constructors

Constructor and Description
GenericMode(java.io.File pathDevice, int sampleSize, java.lang.String modeName) Create new generic sensor handler.
GenericMode(java.io.File pathDevice, int sampleSize, java.lang.String modeName, float correctMin, float correctMax, float correctFactor) Create new generic sensor handler.

Method Summary

Modifier and Type	Method and Description
void	fetchSample(float[] sample, int offset) Fetches a sample from the sensor.
java.lang.String	getName()
int	sampleSize()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pathDevice

private final java.io.File pathDevice

sampleSize

private final int sampleSize

modeName

private final java.lang.String modeName

correctMin

private final float correctMin

correctMax

private final float correctMax

correctFactor

private final float correctFactor

Constructor Detail

GenericMode

public GenericMode(java.io.File pathDevice,
                   int sampleSize,
                   java.lang.String modeName)

Create new generic sensor handler.

Parameters:

pathDevice - Reference to the object responsible for mode setting and value reading.

sampleSize - Number of returned samples.

modeName - Human-readable sensor mode name.

GenericMode

public GenericMode(java.io.File pathDevice,
                   int sampleSize,
                   java.lang.String modeName,
                   float correctMin,
                   float correctMax,
                   float correctFactor)

Create new generic sensor handler.

Parameters:

pathDevice - Reference to the object responsible for mode setting and value reading.

sampleSize - Number of returned samples.

modeName - Human-readable sensor mode name.

correctMin - Minimum value measured by the sensor. If the reading is lower, zero is returned.

correctMax - Maximum value measured by the sensor. If the reading is higher, positive infinity is returned.

correctFactor - Scaling factor applied to the sensor reading.

Method Detail

getName

public java.lang.String getName()

sampleSize

public int sampleSize()

fetchSample

public void fetchSample(float[] sample,
                        int offset)

Fetches a sample from the sensor.

Note: this function works properly only when the sensor is already in the appropriate mode. Otherwise, returned data will be invalid.

Parameters:

sample - The array to store the sample in.

offset - The elements of the sample are stored in the array starting at the offset position.