Package lejos.hardware.sensor

Interface SensorModes

All Superinterfaces:

SampleProvider, SensorMode

public interface SensorModes
extends SensorMode

Provide access to the modes supported by a sensor

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	getAvailableModes() Return a list of string descriptions for the sensors available modes.
int	getCurrentMode() Gets the index number of the current mode.
SensorMode	getMode(int mode) Return the sample provider interface for the requested mode
SensorMode	getMode(java.lang.String modeName) Return the sample provider for the request mode
int	getModeCount() Gets the number of supported modes
void	setCurrentMode(int mode) Sets the current mode for fetching samples
void	setCurrentMode(java.lang.String modeName) Sets the current mode for fetching samples

Methods inherited from interface lejos.hardware.sensor.SensorMode

getName

Methods inherited from interface lejos.robotics.SampleProvider

fetchSample, sampleSize

Method Detail

getAvailableModes

java.util.ArrayList<java.lang.String> getAvailableModes()

Return a list of string descriptions for the sensors available modes.

Returns:

list of string descriptions

getMode

SensorMode getMode(int mode)

Return the sample provider interface for the requested mode

Parameters:

mode - the mode number

Returns:

the sample provider for this mode

getMode

SensorMode getMode(java.lang.String modeName)

Return the sample provider for the request mode

Parameters:

modeName - the name/description of the mode

Returns:

the sample provider for the requested mode.

setCurrentMode

void setCurrentMode(int mode)

Sets the current mode for fetching samples

Parameters:

mode - the index number of the mode. Index number corresponds with the item order of the list from getAvailableModes().

setCurrentMode

void setCurrentMode(java.lang.String modeName)

Sets the current mode for fetching samples

Parameters:

modeName - the name of the mode. name corresponds with the item value of the list from getAvailableModes().

getCurrentMode

int getCurrentMode()

Gets the index number of the current mode.

Returns:

the index number of the mode. Index number corresponds with the item order of the list from getAvailableModes().

getModeCount

int getModeCount()

Gets the number of supported modes

Returns:

the number of supported modes