Skip navigation links
B C E F G I M O P R S V W X 

B

BACKWARD - Static variable in class org.jabotics.robot.en.XRobot
Constant to reduce typing effort in classes derived from XRobot (use BACKWARD instead of EDirection.BACKWARD).

C

checkForEventOverflow() - Method in interface org.jabotics.robot.en.ISensor
Checks for an overflow of the event handling and resets the overflow flag.
clear() - Method in interface org.jabotics.robot.en.IDisplay
Clears the complete display.
clearCharacters(int, int, int) - Method in interface org.jabotics.robot.en.IDisplay
Clears a row of characters on the display.
clearLine(int) - Method in interface org.jabotics.robot.en.IDisplay
Clears a single line on the display.
clearListener() - Method in interface org.jabotics.robot.en.ISensor
Clears a registered sensor listener.
close() - Method in interface org.jabotics.robot.en.IPCConsole
Disconnects from the console application on the PC.
createDisplay() - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing the LCD display of the robot brick.
createLightSensor(ESensorPort) - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing a light sensor connected to a sensor port.
createMotor(EMotorPort) - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing a motor of the robot.
createPCConsole() - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing a console window on a connected PC.
createPilot(EMotorPort, EMotorPort) - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing an auto-pilot for controlling robot motions.
createPilot(EMotorPort, EMotorPort, float, float) - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing an auto-pilot for controlling robot motions with given values for wheel diameter and wheelbase of the robot.
createSoundSensor(ESensorPort) - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing a sound sensor connected to a sensor port.
createSpeaker() - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing the speaker of the robot brick.
createTimer() - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing a timer.
createTouchSensor(EButton) - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing a button of the robot brick.
createTouchSensor(ESensorPort) - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing a touch sensor connected to a sensor port.
createUltrasonicSensor(ESensorPort) - Method in interface org.jabotics.robot.en.IObjectFactory
Creates an object instance representing an ultrasonic sensor connected to a sensor port.

E

EButton - Enum in org.jabotics.robot.en
The enumeration class EButton defines constants representing the buttons of the robot brick.
EDirection - Enum in org.jabotics.robot.en
The enumeration class EDirection defines the possible directions for motor rotations and robot motions.
EMotorPort - Enum in org.jabotics.robot.en
The enumeration class EMotorPort defines constants representing the motor ports of the robot brick.
ESensorPort - Enum in org.jabotics.robot.en
The enumeration class ESensorPort defines constants representing the sensor ports of the robot brick.
ESound - Enum in org.jabotics.robot.en
The enumeration class ESound defines constants representing the possible sound options for the method ISpeaker.playNote(ESound sound, int frequency, int period).
EWaitingMode - Enum in org.jabotics.robot.en
The enumeration class EWaitingMode defines constants representing the two possible execution modes for methods that can either be startet and executed in a parallel thread (EWaitingMode.START) while the calling thread continues its work or that can be completed before the calling thread resumes its execution (EWaitingMode.WAIT).

F

FLUTE - Static variable in class org.jabotics.robot.en.XRobot
Constant to reduce typing effort in classes derived from XRobot (use FLUTE instead of ESound.FLUTE).
FORWARD - Static variable in class org.jabotics.robot.en.XRobot
Constant to reduce typing effort in classes derived from XRobot (use FORWARD instead of EDirection.FORWARD).

G

getChangeRate() - Method in interface org.jabotics.robot.en.ISensor
Returns the change rate for the measurand.
getFilterToleranceRate() - Method in interface org.jabotics.robot.en.ISensor
Returns the currently stored tolerance limit for the sensor event filtering by change rate.
getFilterToleranceValue() - Method in interface org.jabotics.robot.en.ISensor
Returns the currently stored tolerance limit for the sensor event filtering by measurand.
getIntegrationTime() - Method in interface org.jabotics.robot.en.ISensor
Returns the integration time constant which determines the inertia of the sensor.
getMaxAcceleration() - Method in interface org.jabotics.robot.en.IMotor
Returns the maximum acceleration.
getMaxAcceleration() - Method in interface org.jabotics.robot.en.IPilot
Returns the maximum acceleration.
getMaxSpeed() - Method in interface org.jabotics.robot.en.IMotor
Returns the maximum rotational velocity.
getMaxSpeed() - Method in interface org.jabotics.robot.en.IPilot
Returns the maximum velocity.
getMeasuredValue() - Method in interface org.jabotics.robot.en.ISensor
Returns a single measurand of the sensor.
getOrientation() - Method in interface org.jabotics.robot.en.IPilot
Return the current orientation of the robot.
getPosition() - Method in interface org.jabotics.robot.en.IMotor
Returns the current angular position of the motor.
getSpeed() - Method in interface org.jabotics.robot.en.IMotor
Returns the instantaneous (that is "real") rotational velocity of the motor.
getSpeed() - Method in interface org.jabotics.robot.en.IPilot
Returns the instantaneous (that is "real") velocity of the robot's center motion.
getSystemTime() - Method in interface org.jabotics.robot.en.ITimer
Returns the system time of the robot.
getTachoCount() - Method in interface org.jabotics.robot.en.IPilot
Returns the current tachometer count of the robot.
getTargetAcceleration() - Method in interface org.jabotics.robot.en.IMotor
Returns the stored target acceleration.
getTargetAcceleration() - Method in interface org.jabotics.robot.en.IPilot
Returns the stored target acceleration.
getTargetSpeed() - Method in interface org.jabotics.robot.en.IMotor
Returns the currently stored target velocity.
getTargetSpeed() - Method in interface org.jabotics.robot.en.IPilot
Returns the currently stored target velocity.
getVolume() - Method in interface org.jabotics.robot.en.ISpeaker
Returns the currently stored value for the default volume.
getWheelbase() - Method in interface org.jabotics.robot.en.IPilot
Returns the currently stored wheelbase.
getWheelDiameter() - Method in interface org.jabotics.robot.en.IPilot
Returns the currently stored wheel diameter.

I

IDisplay - Interface in org.jabotics.robot.en
The interface IDisplay provides methods for outputs to the LCD display of the robot brick.
ILightSensor - Interface in org.jabotics.robot.en
The interface ILightSensor extends the interface ISensor by methods for controlling the LED of the light sensor.
IMotor - Interface in org.jabotics.robot.en
The interface IMotor provides methods for controlling a motor.
IObjectFactory - Interface in org.jabotics.robot.en
The interface IObjectFactory allows to create all object instances necessary to control the robot (like sensor and motor objects).
IPCConsole - Interface in org.jabotics.robot.en
The interface IPCConsole provides access to a console window on a connected PC.
IPilot - Interface in org.jabotics.robot.en
The interface IPilot provides methods for controlling robot motions.
ISensor - Interface in org.jabotics.robot.en
The interface ISensor provides methods for the configuration and readout of sensors.
ISensorListener - Interface in org.jabotics.robot.en
Objects supporting the interface ISensorListener can be registered at a sensor to receive change event notifications of the sensor.
isMoving() - Method in interface org.jabotics.robot.en.IMotor
Checks if the motor is currently in motion.
isMoving() - Method in interface org.jabotics.robot.en.IPilot
Checks if the robot is currently in motion.
ISpeaker - Interface in org.jabotics.robot.en
The interface ISpeaker provides methods for playing signals and tones on the speaker of the robot brick.
isPressed() - Method in interface org.jabotics.robot.en.ITouchSensor
Returns the state of the sensor.
isStalled() - Method in interface org.jabotics.robot.en.IMotor
Checks if the motor control has been stalled.
ITimer - Interface in org.jabotics.robot.en
The interface ITimer provides methods related to the system time.
ITouchSensor - Interface in org.jabotics.robot.en
The interface ITouchSensor extends the interface ISensor and provides simplified access methods for touch sensors.

M

manageEvent(ISensor, float, float, float, float) - Method in interface org.jabotics.robot.en.ISensorListener
This method will be invoked when there is a relevant change of the measurand or the corresponding change rate of an observed sensor.
moveArc(float, float, EWaitingMode) - Method in interface org.jabotics.robot.en.IPilot
Starts or completes a curved motion with given distance (arc length) and rotation angle.
moveCurvature(float, EDirection) - Method in interface org.jabotics.robot.en.IPilot
Starts an unlimited motion with given curvature parameter and direction.
moveRadius(float, EDirection) - Method in interface org.jabotics.robot.en.IPilot
Starts an unlimited motion with given radius and direction.
moveRadius(float, float, EWaitingMode) - Method in interface org.jabotics.robot.en.IPilot
Starts or completes a curved motion with given radius and rotation angle.
moveStraight(EDirection) - Method in interface org.jabotics.robot.en.IPilot
Starts an unlimited straight motion with given direction.
moveStraight(float, EWaitingMode) - Method in interface org.jabotics.robot.en.IPilot
Starts or completes a straight motion with given distance.

O

objectFactory - Static variable in class org.jabotics.robot.en.XRobot
The object factory to create all objects necessary to control the robot.
open() - Method in interface org.jabotics.robot.en.IPCConsole
Establishes a connection to a (running) console application on the PC.
org.jabotics.robot.en - package org.jabotics.robot.en
This class library provides universal interfaces, enumerations and implementation classes for controlling simple robots based on different robot hardware.

P

pause(int) - Method in interface org.jabotics.robot.en.ISpeaker
Plays a pause.
PIANO - Static variable in class org.jabotics.robot.en.XRobot
Constant to reduce typing effort in classes derived from XRobot (use PIANO instead of ESound.PIANO).
playBeep() - Method in interface org.jabotics.robot.en.ISpeaker
Plays a beep.
playBeepSequence() - Method in interface org.jabotics.robot.en.ISpeaker
Plays a beep sequence.
playBeepSequenceUp() - Method in interface org.jabotics.robot.en.ISpeaker
Plays an upward beep sequence.
playBuzz() - Method in interface org.jabotics.robot.en.ISpeaker
Plays a buzz.
playNote(ESound, int, int) - Method in interface org.jabotics.robot.en.ISpeaker
Plays a tone with a given sound characteristics.
playTone(int, int) - Method in interface org.jabotics.robot.en.ISpeaker
Plays a tone.
playTone(int, int, int) - Method in interface org.jabotics.robot.en.ISpeaker
Plays a tone.
playTwoBeeps() - Method in interface org.jabotics.robot.en.ISpeaker
Plays two beeps.

R

refresh() - Method in interface org.jabotics.robot.en.IDisplay
Initiates an update of the display.
releaseControl() - Method in interface org.jabotics.robot.en.IMotor
Releases the control of the motor.
resetCounters() - Method in interface org.jabotics.robot.en.IPilot
Resets the tachometer count and the current orientation angle of the robot.
resetPosition() - Method in interface org.jabotics.robot.en.IMotor
Resets the angular position of the motor.
rotate(EDirection) - Method in interface org.jabotics.robot.en.IMotor
Starts an unlimited rotation of the motor.
rotateByAngle(float, EWaitingMode) - Method in interface org.jabotics.robot.en.IMotor
Starts or completes a motor rotation by the given angle.
rotateByAngle(float, EWaitingMode) - Method in interface org.jabotics.robot.en.IPilot
Starts or completes a rotation of the robot by the given rotation angle.
rotateTime(float, EDirection, EWaitingMode) - Method in interface org.jabotics.robot.en.IMotor
Starts or completes a time limited rotation of the motor.
rotateToOrientation(float, EWaitingMode) - Method in interface org.jabotics.robot.en.IPilot
Starts or completes a rotation of the robot to the given orientation angle.
rotateToPosition(float, EWaitingMode) - Method in interface org.jabotics.robot.en.IMotor
Starts or completes a motor rotation to the given motor position.

S

setCorrectionFactor(float) - Method in interface org.jabotics.robot.en.IMotor
Sets the correction factor for the motor position to the given value.
setFilterTolerances(float, float) - Method in interface org.jabotics.robot.en.ISensor
Sets the tolerance limits for indicating changes of the measurand and its change rate.
setIntegrationTime(int) - Method in interface org.jabotics.robot.en.ISensor
Sets the integration time of the sensor.
setListener(ISensorListener) - Method in interface org.jabotics.robot.en.ISensor
Registers a sensor listener.
setTargetAcceleration(float) - Method in interface org.jabotics.robot.en.IMotor
Sets the target acceleration to the given value.
setTargetAcceleration(float) - Method in interface org.jabotics.robot.en.IPilot
Sets the target acceleration to the given value.
setTargetAccelerationToMax() - Method in interface org.jabotics.robot.en.IMotor
Sets the target acceleration to its maximum value.
setTargetAccelerationToMax() - Method in interface org.jabotics.robot.en.IPilot
Sets the target acceleration to its maximum value.
setTargetSpeed(float) - Method in interface org.jabotics.robot.en.IMotor
Sets the target velocity to the given value.
setTargetSpeed(float) - Method in interface org.jabotics.robot.en.IPilot
Sets the target velocity to the given value.
setTargetSpeedToMax() - Method in interface org.jabotics.robot.en.IMotor
Sets the target velocity to its maximum value.
setTargetSpeedToMax() - Method in interface org.jabotics.robot.en.IPilot
Sets the target velocity to its maximum value.
setVolume(int) - Method in interface org.jabotics.robot.en.ISpeaker
Sets the default volume to the given value.
setWheelbase(float) - Method in interface org.jabotics.robot.en.IPilot
Sets the wheelbase to the given value.
setWheelDiameter(float) - Method in interface org.jabotics.robot.en.IPilot
Sets the wheel diameter to the given value.
START - Static variable in class org.jabotics.robot.en.XRobot
Constant to reduce typing effort in classes derived from XRobot (use START instead of EWaitingMode.START).
stopMotion(EWaitingMode) - Method in interface org.jabotics.robot.en.IPilot
Stops the current motion obeying the current target acceleration (here: deceleration).
stopRotation(EWaitingMode) - Method in interface org.jabotics.robot.en.IMotor
Stops the current rotation obeying the current target acceleration (here: deceleration).
switchLightOff() - Method in interface org.jabotics.robot.en.ILightSensor
Switches off the LED of the light sensor.
switchLightOn() - Method in interface org.jabotics.robot.en.ILightSensor
Switches on the LED of the light sensor.

V

valueOf(String) - Static method in enum org.jabotics.robot.en.EButton
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jabotics.robot.en.EDirection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jabotics.robot.en.EMotorPort
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jabotics.robot.en.ESensorPort
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jabotics.robot.en.ESound
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jabotics.robot.en.EWaitingMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jabotics.robot.en.EButton
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jabotics.robot.en.EDirection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jabotics.robot.en.EMotorPort
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jabotics.robot.en.ESensorPort
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jabotics.robot.en.ESound
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jabotics.robot.en.EWaitingMode
Returns an array containing the constants of this enum type, in the order they are declared.

W

wait(int) - Method in interface org.jabotics.robot.en.ITimer
Waits for the given time period.
WAIT - Static variable in class org.jabotics.robot.en.XRobot
Constant to reduce typing effort in classes derived from XRobot (use WAIT instead of EWaitingMode.WAIT).
waitForPressEvent() - Method in interface org.jabotics.robot.en.ITouchSensor
Waits until the state of the touch sensor changes from released to pressed.
waitForPressEvent(int) - Method in interface org.jabotics.robot.en.ITouchSensor
Waits until the state of the touch sensor changes from released to pressed or a timeout occurs.
waitForReleaseEvent() - Method in interface org.jabotics.robot.en.ITouchSensor
Waits until the state of the touch sensor changes from pressed to released.
waitForReleaseEvent(int) - Method in interface org.jabotics.robot.en.ITouchSensor
Waits until the state of the touch sensor changes from pressed to released or a timeout occurs.
waitUntilBelowLimit(float) - Method in interface org.jabotics.robot.en.ISensor
Waits until the measurand has fallen below the given value.
waitUntilBelowLimit(float, int) - Method in interface org.jabotics.robot.en.ISensor
Waits until the measurand has fallen below the given value or the timeout period has passed.
waitUntilBeyondLimit(float) - Method in interface org.jabotics.robot.en.ISensor
Waits until the measurand exceeds the given value.
waitUntilBeyondLimit(float, int) - Method in interface org.jabotics.robot.en.ISensor
Waits until the measurand exceeds the given value or the timeout period has passed.
waitUntilMotionCompleted() - Method in interface org.jabotics.robot.en.IPilot
Waits for the end of the current robot motion.
waitUntilPressed() - Method in interface org.jabotics.robot.en.ITouchSensor
Waits until the touch sensor is in the state pressed.
waitUntilPressed(int) - Method in interface org.jabotics.robot.en.ITouchSensor
Waits until the touch sensor is in the state pressed or a timeout occurs.
waitUntilReleased() - Method in interface org.jabotics.robot.en.ITouchSensor
Waits until the touch sensor is in the state released.
waitUntilReleased(int) - Method in interface org.jabotics.robot.en.ITouchSensor
Waits until the touch sensor is in the state released or a timeout occurs.
waitUntilRotationCompleted() - Method in interface org.jabotics.robot.en.IMotor
Waits for the end of the current motor rotation.
write(char, int, int) - Method in interface org.jabotics.robot.en.IDisplay
Writes a single character on the display.
write(int, int, int) - Method in interface org.jabotics.robot.en.IDisplay
Writes an integer value on the display.
write(int, int, int, int) - Method in interface org.jabotics.robot.en.IDisplay
Writes an integer value on the display with given number of digits.
write(float, int, int) - Method in interface org.jabotics.robot.en.IDisplay
Writes a decimal value on the display.
write(String, int, int) - Method in interface org.jabotics.robot.en.IDisplay
Writes a text on the display.
write(String, int, int, boolean) - Method in interface org.jabotics.robot.en.IDisplay
Writes a text on the display.
write(String) - Method in interface org.jabotics.robot.en.IPCConsole
Text output without line break to a connected console window on a PC.
writeln(String) - Method in interface org.jabotics.robot.en.IPCConsole
Text output with line break to a connected console window on a PC.

X

XRobot - Class in org.jabotics.robot.en
The class XRobot provides some class variables including an instance of the object factory that is necessary to instantiate all further objects for controlling a robot.
XYLOPHONE - Static variable in class org.jabotics.robot.en.XRobot
Constant to reduce typing effort in classes derived from XRobot (use XYLOPHONE instead of ESound.XYLOPHONE).
B C E F G I M O P R S V W X 
Skip navigation links