A B C D E F G H I J L M N O P R S T U V W X Y

A

AbstractBehavior2 - class com.ridgesoft.robotics.behaviors.AbstractBehavior2.

Implements an abstract class providing the functionality of the Behavior2 inteface.

AbstractBehavior2(boolean) - Constructor for class com.ridgesoft.robotics.behaviors.AbstractBehavior2

Initializes this class when a subclass is constructed.

AnalogInput - interface com.ridgesoft.robotics.AnalogInput.

Generic interface for an object that provides analog input sampling.

AnalogShaftEncoder - class com.ridgesoft.robotics.AnalogShaftEncoder.

Implements an incremental shaft encoder using a photoreflive or break-beam sensor to track the position of a wheel.

AnalogShaftEncoder(AnalogInput, int, int, int, int) - Constructor for class com.ridgesoft.robotics.AnalogShaftEncoder

Constructs an AnalogShaftEncoder object.

ArithmeticException - exception java.lang.ArithmeticException.

Exception thrown when an arithmetic error occurs.

ArithmeticException() - Constructor for class java.lang.ArithmeticException

ArithmeticException(String) - Constructor for class java.lang.ArithmeticException

ArrayIndexOutOfBoundsException - exception java.lang.ArrayIndexOutOfBoundsException.

Exception thrown when an array index is out of bounds.

ArrayIndexOutOfBoundsException() - Constructor for class java.lang.ArrayIndexOutOfBoundsException

ArrayIndexOutOfBoundsException(String) - Constructor for class java.lang.ArrayIndexOutOfBoundsException

ArrayStoreException - exception java.lang.ArrayStoreException.

Exception thrown when an attempt is made to store a reference in an array when the type of the referenced object is not compatible with the type of the array.

ArrayStoreException() - Constructor for class java.lang.ArrayStoreException

ArrayStoreException(String) - Constructor for class java.lang.ArrayStoreException

AvoidBehavior - class com.ridgesoft.robotics.behaviors.AvoidBehavior.

Implements a behavior that will enable a robot with left and right range sensors to avoid obstacles when the behavior is enabled.

AvoidBehavior(Localizer, Navigator, AnalogInput, AnalogInput, int, float, int, boolean) - Constructor for class com.ridgesoft.robotics.behaviors.AvoidBehavior

Constructs an AvoidBehavior object.

abs(double) - Static method in class java.lang.Math

Returns absolute value of the argument.

abs(float) - Static method in class java.lang.Math

Returns absolute value of the argument.

abs(int) - Static method in class java.lang.Math

Returns absolute value of the argument.

acos(double) - Static method in class java.lang.Math

Returns the arc cosine of the argument.

activeCount() - Static method in class java.lang.Thread

Returns the count of active threads.

add(Vector2D) - Method in class com.ridgesoft.robotics.Vector2D

Adds a vector to this vector and returns a new Vector2D object containing the result.

addCameraListener(CMUcamDataListener) - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Adds a listener for CMUcamData updates.

analog(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Samples the analog input for portNumber specified.

append(String) - Method in class java.lang.StringBuffer

Appends the characters from the specified String to this StringBuffer.

append(char[], int, int) - Method in class java.lang.StringBuffer

Appends the characters from the specified array to this StringBuffer.

append(char[]) - Method in class java.lang.StringBuffer

Appends the characters from the specified array to this StringBuffer.

append(char) - Method in class java.lang.StringBuffer

Appends the specified character to this StringBuffer.

append(int) - Method in class java.lang.StringBuffer

Appends a string represetation of the specified value to this StringBuffer.

append(long) - Method in class java.lang.StringBuffer

Appends a string represetation of the specified value to this StringBuffer.

append(float) - Method in class java.lang.StringBuffer

Appends a string represetation of the specified value to this StringBuffer.

append(double) - Method in class java.lang.StringBuffer

Appends a string represetation of the specified value to this StringBuffer.

append(boolean) - Method in class java.lang.StringBuffer

Appends "true" or "false" to this StringBuffer based on the boolean value specified.

append(Object) - Method in class java.lang.StringBuffer

Appends the String represetation of the specified object to this StringBuffer.

asin(double) - Static method in class java.lang.Math

Returns the arc sine of the argument.

atan(double) - Static method in class java.lang.Math

Returns the arc tangent of the argument.

atan2(double, double) - Static method in class java.lang.Math

Returns the angle in radians given the cartesian coordinates x and y.

available() - Method in class java.io.InputStream

Returns the number of bytes available for input.

B

BEHAVIOR_COMPLETED - Static variable in class com.ridgesoft.robotics.BehaviorEvent

Event type that indicates the behavior has been completed.

BasicLED - class com.ridgesoft.robotics.BasicLED.

Implements the LED inteface to a DigitalOutput class which controls an LED.

BasicLED(DigitalOutput, boolean) - Constructor for class com.ridgesoft.robotics.BasicLED

Constructs a BasicLED object.

BasicMenuItemList - class com.ridgesoft.ui.BasicMenuItemList.

Basic implementation of the MenuItemList interface.

BasicMenuItemList(String, MenuItem[]) - Constructor for class com.ridgesoft.ui.BasicMenuItemList

Constructs a BasicMenuItemList.

BasicPushButton - class com.ridgesoft.robotics.BasicPushButton.

Implements the PushButton interface using a DigitalInput to read the button’s status.

BasicPushButton(DigitalInput) - Constructor for class com.ridgesoft.robotics.BasicPushButton

Construct a BasicPushButton for a button which pulls the input low when pressed.

Behavior - interface com.ridgesoft.robotics.Behavior.

Interface implemented by behaviors intended to be used in conjunction with a BehaviorArbiter.

Behavior2 - interface com.ridgesoft.robotics.Behavior2.

Extends the Behavior interface.

BehaviorArbiter - class com.ridgesoft.robotics.BehaviorArbiter.

Implements a behavior arbitrator for behavior-based control of a robot.

BehaviorArbiter(Behavior[], int, DigitalOutput) - Constructor for class com.ridgesoft.robotics.BehaviorArbiter

Constructs a BehaviorArbiter object and thread, but does not start the thread.

BehaviorArbiter(Behavior[], LED, int) - Constructor for class com.ridgesoft.robotics.BehaviorArbiter

Constructs a BehaviorArbiter object and thread, but does not start the thread.

BehaviorArbiter(Behavior[], int) - Constructor for class com.ridgesoft.robotics.BehaviorArbiter

Constructs a BehaviorArbiter object and thread, but does not start the thread.

BehaviorEvent - class com.ridgesoft.robotics.BehaviorEvent.

Used to communicate information about behavior events to BehaviorListeners.

BehaviorEvent(Behavior, int) - Constructor for class com.ridgesoft.robotics.BehaviorEvent

BehaviorListener - interface com.ridgesoft.robotics.BehaviorListener.

Interface for any class that wants to listen for behavior events.

Boolean - class java.lang.Boolean.

Class to represent a boolean as an immutable object.

Boolean(boolean) - Constructor for class java.lang.Boolean

Constructs a Boolean object.

beep() - Static method in class com.ridgesoft.handyboard.HandyBoard

Beeps the buzzer.

beep() - Method in class com.ridgesoft.io.Speaker

Beeps the speaker.

behavior - Variable in class com.ridgesoft.robotics.BehaviorEvent

Behavior that generated this event.

behaviorEvent(BehaviorEvent) - Method in interface com.ridgesoft.robotics.BehaviorListener

Method called whenever a behavior event occurs.

blueDeviation - Variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamStatisticData

The deviation of the blue values in the current window.

blueMean - Variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamStatisticData

The mean blue value in the current window.

brake() - Method in class com.ridgesoft.robotics.ContinuousRotationServo

Active braking is not supported.

brake() - Method in interface com.ridgesoft.robotics.Motor

Applies active braking if supported by the motor controller.

brake() - Method in class com.ridgesoft.robotics.effectors.DevantechMD03

Active braking is not supported.

breakpoint() - Static method in class com.ridgesoft.vm.VM

Executes a breakpoint to stop execution of the application.

buttonPressed() - Method in interface com.ridgesoft.ui.MenuController

Provides feedback to the user that a button has been pressed.

buttonPressed() - Method in class com.ridgesoft.ui.TwoLineDisplayMenuController

Provides feedback to the user that a button has been pressed.

C

CMUcam - class com.ridgesoft.robotics.sensors.CMUcam.CMUcam.

Class to interface with the CMUcam.

CMUcam(SerialPort, int) - Constructor for class com.ridgesoft.robotics.sensors.CMUcam.CMUcam

Constructs a CMUcam object.

CMUcam2 - class com.ridgesoft.robotics.sensors.CMUcam.CMUcam2.

Class to interface with the CMUcam2.

CMUcam2(SerialPort, int) - Constructor for class com.ridgesoft.robotics.sensors.CMUcam.CMUcam2

Constructs a CMUcam object.

CMUcamBase - class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase.

Base class for classes that interface with the CMUcam and CMUcam2.

CMUcamBase(SerialPort, int) - Constructor for class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Initializes the camera base class.

CMUcamData - class com.ridgesoft.robotics.sensors.CMUcam.CMUcamData.

Base class for CMUcam data classes.

CMUcamDataListener - interface com.ridgesoft.robotics.sensors.CMUcam.CMUcamDataListener.

Listener interface for CMUcam data.

CMUcamHistogramData - class com.ridgesoft.robotics.sensors.CMUcam.CMUcamHistogramData.

Class to hold histogram data reported by the CMUcam2.

CMUcamStatisticData - class com.ridgesoft.robotics.sensors.CMUcam.CMUcamStatisticData.

Class to hold statistic data reported by the CMUcam or CMUcam2.

CMUcamTrackingData - class com.ridgesoft.robotics.sensors.CMUcam.CMUcamTrackingData.

Class to hold tracking data reported by the CMUcam or CMUcam2.

Character - class java.lang.Character.

Class to represent a char as an immutable object.

Character(char) - Constructor for class java.lang.Character

Constructs a Character object.

Class - class java.lang.Class.

Class information about an object.

ClassCastException - exception java.lang.ClassCastException.

Exception thrown when a casting operation fails.

ClassCastException() - Constructor for class java.lang.ClassCastException

ClassCastException(String) - Constructor for class java.lang.ClassCastException

CloneNotSupportedException - exception java.lang.CloneNotSupportedException.

Exception thrown when the clone method is called for an object that doesn't support cloning.

CloneNotSupportedException() - Constructor for class java.lang.CloneNotSupportedException

CloneNotSupportedException(String) - Constructor for class java.lang.CloneNotSupportedException

Cloneable - interface java.lang.Cloneable.

Interface to indicate the clone method is supported by a class.

CommPort - class javax.comm.CommPort.

Base class for all communications ports

CommPort() - Constructor for class javax.comm.CommPort

Constructs a CommPort.

Compass - class com.ridgesoft.robotics.Compass.

Abstract base class for a compass sensor.

Compass() - Constructor for class com.ridgesoft.robotics.Compass

Constructs a Compass.

ContinuousRotationServo - class com.ridgesoft.robotics.ContinuousRotationServo.

This class implements the Motor interface to a servo that has been manufactured or modified to support continuous rotation.

ContinuousRotationServo(Servo, boolean) - Constructor for class com.ridgesoft.robotics.ContinuousRotationServo

Constructs a ContinuousRotationServo object.

ContinuousRotationServo(Servo, boolean, int) - Constructor for class com.ridgesoft.robotics.ContinuousRotationServo

Constructs a ContinuousRotationServo object.

ContinuousRotationServo(Servo, boolean, int, DirectionListener) - Constructor for class com.ridgesoft.robotics.ContinuousRotationServo

Constructs a ContinuousRotationServo object.

Controller - interface com.ridgesoft.robotics.Controller.

Generic feedback-based controller interface.

calibrate() - Method in class com.ridgesoft.robotics.sensors.DevantechCMPS03I2C

Calibrate the compass.

ceil(double) - Static method in class java.lang.Math

Returns value of the next integer which is higher than the argument.

charValue() - Method in class java.lang.Character

Returns the char value.

checkError() - Method in class java.io.PrintStream

Returns the value of error.

clear() - Method in class com.ridgesoft.intellibrain.IntelliBrainDigitalIO

Clears the digital output (sets it low) if the port is configured as an output.

clear() - Method in interface com.ridgesoft.robotics.DigitalOutput

Sets the digital output low.

clearBit(int, int) - Static method in class com.ridgesoft.vm.VM

Clears a bit in the byte at the specified address.

clearDigitalOutput(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Clears the specified digital output bit.

click() - Static method in class com.ridgesoft.handyboard.HandyBoard

Click the buzzer.

click() - Method in class com.ridgesoft.io.Speaker

Clicks the speaker.

clone() - Method in class java.lang.Object

Returns a clone of this object if this object supports the cloneable interface, otherwise throws a CloneNotSupportedException.

close() - Method in class com.ridgesoft.io.OutputStreamTee

Closes this OutputStream by releasing the two underlying OutputStreams.

close() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Closes communication with the camera by issuing an idle command to the camera and terminating the receive and listener threads.

close() - Method in class java.io.FilterOutputStream

Close the output stream.

close() - Method in class java.io.InputStream

Closes the input stream.

close() - Method in class java.io.OutputStream

Close the output stream.

close() - Method in class javax.comm.CommPort

Closes this port.

cmuCamDataEvent(CMUcamData) - Method in interface com.ridgesoft.robotics.sensors.CMUcam.CMUcamDataListener

Listener method called when new data is received from the camera.

com.ridgesoft.handyboard - package com.ridgesoft.handyboard

Contains classes that interface to the Handy Board and Sumo11 robotics controllers.

com.ridgesoft.intellibrain - package com.ridgesoft.intellibrain

Contains classes that interface to the IntelliBrain^TM 2 and IntelliBrain^TM robotics controllers.

com.ridgesoft.io - package com.ridgesoft.io

Contains classes for various input and output functions.

com.ridgesoft.robotics - package com.ridgesoft.robotics

Contains classes useful to robotics applications.

com.ridgesoft.robotics.behaviors - package com.ridgesoft.robotics.behaviors

Contains classes that implement behaviors.

com.ridgesoft.robotics.effectors - package com.ridgesoft.robotics.effectors

Contains classes for interfacing to specific effectors.

com.ridgesoft.robotics.sensors - package com.ridgesoft.robotics.sensors

Contains classes for interfacing to specific sensors.

com.ridgesoft.robotics.sensors.CMUcam - package com.ridgesoft.robotics.sensors.CMUcam

Contains classes for interfacing to the CMUcam and CMUcam2.

com.ridgesoft.ui - package com.ridgesoft.ui

Contains user interface related classes.

com.ridgesoft.vm - package com.ridgesoft.vm

Contains classes specific to the RoboJDE^TM virtual machine.

confidence - Variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamTrackingData

A measure of the confidence in the tracking data.

control(float, float) - Method in interface com.ridgesoft.robotics.Controller

Calculates the controller output given a target and current sample of the controlled variable.

control(float, float) - Method in class com.ridgesoft.robotics.PIDController

Calculates the controller output given a target and current sample of the controlled variable.

cos(double) - Static method in class java.lang.Math

Returns the cosine of the angle.

currentThread() - Static method in class java.lang.Thread

Returns the Thread object for the current thread.

currentTimeMillis() - Static method in class java.lang.System

Returns the system's millisecond counter.

D

DATABITS_5 - Static variable in class javax.comm.SerialPort

DATABITS_6 - Static variable in class javax.comm.SerialPort

DATABITS_7 - Static variable in class javax.comm.SerialPort

DATABITS_8 - Static variable in class javax.comm.SerialPort

DIGITAL_IN - Static variable in class com.ridgesoft.handyboard.HandyBoard

Address of the digital input port.

DebugOutputStream - class com.ridgesoft.vm.DebugOutputStream.

An output stream for writing to the debug output display on the host.

DevantechCMPS03 - class com.ridgesoft.robotics.sensors.DevantechCMPS03.

Class to interface with a Devantech CMPS03 magnetic compass attached to a pulse input.

DevantechCMPS03(PulseInput) - Constructor for class com.ridgesoft.robotics.sensors.DevantechCMPS03

Constructs a Compass object for a CMPS03 compass attached to a pulse input port.

DevantechCMPS03I2C - class com.ridgesoft.robotics.sensors.DevantechCMPS03I2C.

Class to interface with a Devantech CMPS03 magnetic compass attached to an I2C port.

DevantechCMPS03I2C(I2CMaster) - Constructor for class com.ridgesoft.robotics.sensors.DevantechCMPS03I2C

Constructs a Compass object for a CMPS03 compass attached to an I2C bus.

DevantechMD03 - class com.ridgesoft.robotics.effectors.DevantechMD03.

Class to interface with a Devantech MD03 motor driver attached to an I2C port.

DevantechMD03(I2CMaster, int) - Constructor for class com.ridgesoft.robotics.effectors.DevantechMD03

Constructs a DevantechMD03 object.

DevantechMD22 - class com.ridgesoft.robotics.effectors.DevantechMD22.

Class to interface with a Devantech MD22 dual motor driver attached to an I2C port.

DevantechMD22(I2CMaster, int) - Constructor for class com.ridgesoft.robotics.effectors.DevantechMD22

Constructs a DevantechMD22 object.

DevantechSP03 - class com.ridgesoft.robotics.effectors.DevantechSP03.

Class to interface with the Devantech SP03 speech synthesizer.

DevantechSP03(I2CMaster) - Constructor for class com.ridgesoft.robotics.effectors.DevantechSP03

Constructs a DevantechSP03 object.

DevantechSRF04 - class com.ridgesoft.robotics.sensors.DevantechSRF04.

Class to interface with the Devantech SRF04 ultrasonic range finder.

DevantechSRF04(PulseOutput, PulseInput) - Constructor for class com.ridgesoft.robotics.sensors.DevantechSRF04

Constructs a range finder object.

DevantechSRF08 - class com.ridgesoft.robotics.sensors.DevantechSRF08.

Class to interface with the Devantech SRF08 ultrasonic range finder.

DevantechSRF08(I2CMaster, int) - Constructor for class com.ridgesoft.robotics.sensors.DevantechSRF08

Constructs a DevantechSRF08 object.

DevantechSRF08(I2CMaster) - Constructor for class com.ridgesoft.robotics.sensors.DevantechSRF08

Constructs a DevantechSRF08 object using the default device address, 0xe0.

DifferentialDriveNavigator - class com.ridgesoft.robotics.DifferentialDriveNavigator.

Implements a navigator for a differential-drive robot.

DifferentialDriveNavigator(Motor, Motor, Localizer, int, int, float, float, float, int, int) - Constructor for class com.ridgesoft.robotics.DifferentialDriveNavigator

Constructs a DifferentialDriveNavigator object.

DigitalInput - interface com.ridgesoft.robotics.DigitalInput.

Generic sampling interface to a digital input port.

DigitalOutput - interface com.ridgesoft.robotics.DigitalOutput.

Generic interface to a digital output port.

DirectionListener - interface com.ridgesoft.robotics.DirectionListener.

Generic listener interface to listen for changes in direction.

Display - class com.ridgesoft.io.Display.

Abstract class for character output displays.

Display(int, int) - Constructor for class com.ridgesoft.io.Display

Initializes a Display object.

DisplayOutputStream - class com.ridgesoft.io.DisplayOutputStream.

An output stream for writing to a multi-line display.

DisplayOutputStream(Display) - Constructor for class com.ridgesoft.io.DisplayOutputStream

Constructs an OutputStream for the specified display.

Double - class java.lang.Double.

Class to represent a double as an immutable object.

Double(double) - Constructor for class java.lang.Double

Constructs a Double object.

defaultVirtualWindow() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcam2

Sets the default camera window (1, 1, 80, 143).

defaultWindow() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcam

Sets the default camera window (1, 1, 80, 143).

direction(int) - Static method in class com.ridgesoft.robotics.Compass

Converts a compass heading to a String indicating a compass direction.

direction() - Method in class com.ridgesoft.robotics.Compass

Gets a String indicating the current compass direction.

dumpStack() - Static method in class java.lang.Thread

Dumps a stack trace for the current state of this thread.

E

E - Static variable in class java.lang.Math

The constant e.

EEPROM - class com.ridgesoft.io.EEPROM.

Abstract class to interface to an EEPROM.

EEPROM() - Constructor for class com.ridgesoft.io.EEPROM

Constructor for sub-classes to use.

Error - error java.lang.Error.

Base class for exceptions that are errors that applications normally cannot recover from.

Error() - Constructor for class java.lang.Error

Error(String) - Constructor for class java.lang.Error

Exception - exception java.lang.Exception.

Base class for exceptions that applications can commonly handle and recover from.

Exception() - Constructor for class java.lang.Exception

Exception(String) - Constructor for class java.lang.Exception

enableEncoder(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Enables the specified shaft encoder.

enablePulseMeasurement(int, boolean) - Static method in class com.ridgesoft.handyboard.HandyBoard

Initializes digital input 7 or 8 for pulse measurement.

enablePulseMeasurement(boolean) - Method in class com.ridgesoft.intellibrain.IntelliBrainDigitalIO

Enables pulse measurement.

enablePulseMeasurement(boolean) - Method in interface com.ridgesoft.robotics.PulseInput

Enables or disables pulse measurement.

ensureCapacity(int) - Method in class java.lang.StringBuffer

Ensures the buffer is large enough to hold the minimum length specified.

equals(Object) - Method in class java.lang.Object

Returns true if the specified object is equal to this object.

equals(Object) - Method in class java.lang.String

Returns true if the specified object is a String of the same characters as this String.

err - Static variable in class java.lang.System

Current error output stream.

exit(int) - Static method in class java.lang.System

Exit the application.

exp(double) - Static method in class java.lang.Math

Returns e raised to the specified power.

F

FPS_11 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Clock register setting for 11 frames per second.

FPS_13 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Clock register setting for 13 frames per second.

FPS_17 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Clock register setting for 17 frames per second.

FPS_26 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcam2

Clock register setting for 13 frames per second.

FPS_4 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcam

Clock register setting for 4 frames per second.

FPS_5 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Clock register setting for 5 frames per second.

FPS_50 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcam2

Clock register setting for 50 frames per second.

FPS_6 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Clock register setting for 6 frames per second.

FPS_7 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Clock register setting for 7 frames per second.

FPS_8 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Clock register setting for 8 frames per second.

FPS_9 - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Clock register setting for 9 frames per second.

FilterOutputStream - class java.io.FilterOutputStream.

Base class for all filtering output streams.

FilterOutputStream(OutputStream) - Constructor for class java.io.FilterOutputStream

Constructs a FilterOutputStream.

Float - class java.lang.Float.

Class to represent a float as an immutable object.

Float(float) - Constructor for class java.lang.Float

Constructs a Float object.

fillInStackTrace() - Method in class java.lang.Throwable

Fills in the stack trace in this throwable.

floatToRawIntBits(float) - Static method in class java.lang.Float

Returns an int containing the bits that represent the specified float.

floor(double) - Static method in class java.lang.Math

Returns value of the next integer which is lower than the argument.

flush() - Method in class com.ridgesoft.io.DisplayOutputStream

Flushes all characters to the display.

flush() - Method in class com.ridgesoft.io.OutputStreamTee

Flushes the two streams.

flush() - Method in class com.ridgesoft.vm.DebugOutputStream

Flushes all characters to the display.

flush() - Method in class java.io.FilterOutputStream

Flush the data to the output stream.

flush() - Method in class java.io.OutputStream

Flush the data to the output stream.

freeMenuItems() - Method in class com.ridgesoft.ui.BasicMenuItemList

Does nothing.

freeMenuItems() - Method in class com.ridgesoft.ui.MenuItemList

Allows menu items to be freed if they aren't being used by the display system.

G

GoToBehavior - class com.ridgesoft.robotics.behaviors.GoToBehavior.

Implements a behavior that will cause a robot to strive to navigate to a particular x, y location when the behavior is enabled.

GoToBehavior(Navigator, float, float, boolean) - Constructor for class com.ridgesoft.robotics.behaviors.GoToBehavior

Constructs a GoToBehavior object.

getAnalogInput(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the AnalogInput object for the specified input port.

getAnalogInput(int) - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the IntelliBrainAnalogInput object for the specified input port.

getBatteryInput() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the IntelliBrain controller battery digital input.

getBoardType() - Static method in class com.ridgesoft.handyboard.HandyBoard

Returns the board type.

getBuzzer() - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the Speaker object for the buzzer.

getBuzzer() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the Speaker object for the buzzer.

getBytes() - Method in class java.lang.String

Returns a clone of the ASCII bytes which represent this String.

getBytes(int, int, byte[], int) - Method in class java.lang.String

Copies bytes from this string to the specified byte buffer.

getClass() - Method in class java.lang.Object

Returns the Class object for this object.

getCom1() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the SerialPort object for COM1.

getCom2() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the SerialPort object for COM2.

getCounts() - Method in class com.ridgesoft.intellibrain.IntelliBrainShaftEncoder

Reads the current shaft encoder counter value.

getCounts() - Method in class com.ridgesoft.robotics.AnalogShaftEncoder

Gets the current value of the encoder counter.

getCounts() - Method in interface com.ridgesoft.robotics.ShaftEncoder

Reads the current shaft encoder counter value.

getCpuEEPROM() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the EEPROM object for the CPU EEPROM.

getDebugOutputStream() - Static method in class com.ridgesoft.vm.VM

Gets the output stream for the debug output display.

getDigitalIO(int) - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the IntelliBrainDigitalIO object for the specified digital port.

getDigitalInput(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the DigitalInput object for the specified input port.

getDigitalOutput(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the DigitalOutput object for the specified output number.

getDirection() - Method in class com.ridgesoft.robotics.Vector2D

Gets the direction of the vector.

getDistanceCm() - Method in interface com.ridgesoft.robotics.RangeFinder

Gets the distance to the nearest object in centimeters.

getDistanceCm() - Method in class com.ridgesoft.robotics.SonarRangeFinder

Gets the distance to the nearest object in centimeters based on the speed of sound at sea level (340.29 m/s).

getDistanceCm() - Method in class com.ridgesoft.robotics.sensors.SharpGP2D12

Gets the distance to the nearest object in centimeters based on an curve fitting apporximation of the output voltage verse distance curve.

getDistanceCm() - Method in class com.ridgesoft.robotics.sensors.SharpGP2Y0A02

Gets the distance to the nearest object in centimeters based on an curve fitting apporximation of the output voltage verse distance curve.

getDistanceCm() - Method in class com.ridgesoft.robotics.sensors.SharpGP2Y0A21

Gets the distance to the nearest object in centimeters based on an curve fitting apporximation of the output voltage verse distance curve.

getDistanceInches() - Method in interface com.ridgesoft.robotics.RangeFinder

Gets the distance to the nearest object in inches.

getDistanceInches() - Method in class com.ridgesoft.robotics.SonarRangeFinder

Gets the distance to the nearest object in inches based on the speed of sound at sea level (1116.4 ft/s).

getDistanceInches() - Method in class com.ridgesoft.robotics.sensors.SharpGP2D12

Gets the distance to the nearest object in inches based on an curve fitting apporximation of the output voltage verse distance curve.

getEchoData() - Method in class com.ridgesoft.robotics.sensors.DevantechSRF08

Gets the echo data array from the SRF08.

getEchoDelay() - Method in class com.ridgesoft.robotics.SonarRangeFinder

Gets the echo delay.

getEchoDelay() - Method in class com.ridgesoft.robotics.sensors.DevantechSRF04

Gets the echo delay, including 100 usec blanking time.

getEchoDelay() - Method in class com.ridgesoft.robotics.sensors.DevantechSRF08

Gets the echo delay.

getEchoDelay() - Method in class com.ridgesoft.robotics.sensors.ParallaxPing

Gets the echo delay.

getEncoderCounts(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Read the counts for the particular encoder.

getEncoderRate(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Read the current rate of the encoder counter.

getExpansionEEPROM() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the EEPROM object for the expansion board EEPROM.

getFaultLed() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the LED object for the fault LED (red) on the main board.

getHeight() - Method in class com.ridgesoft.io.Display

Gets the height of the display in characters.

getHistogram(int) - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcam2

Issues the get histogram command.

getHistogramData() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Retrieves the latest histogram data reported by the CMUcam2.

getI2CMaster() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the I2CMaster object for the I2C bus.

getInputStream() - Method in class javax.comm.CommPort

Gets the InputStream for this port.

getIrLed() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the LED object for the infrared LED on the IntelliBrain 2 controller or the expansion board on the original IntelliBrain controller.

getIrReceiver() - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the IrReceiver object for the infrared receiver.

getIrReceiver() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the IrRreceiver object for the infrared receiver on the main board.

getLcdDisplay() - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the Display object for the LCD.

getLcdDisplay() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the Display object for the LCD.

getListenerThread() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Gets the camera's listener thread.

getMagnitude() - Method in class com.ridgesoft.robotics.Vector2D

Gets the magnitude of the vector.

getMaximum() - Method in class com.ridgesoft.intellibrain.IntelliBrainAnalogInput

Gets the maximum possible value for this analog input.

getMaximum() - Method in interface com.ridgesoft.robotics.AnalogInput

Gets the maximum possible value for this analog input.

getMean() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Issues the get mean command to the camera, instructing it to start sending statistic data.

getMenuItems() - Method in class com.ridgesoft.ui.BasicMenuItemList

Gets the list of menu items in this list.

getMenuItems() - Method in class com.ridgesoft.ui.MenuItemList

Gets the list of menu items in this list.

getMessage() - Method in class java.lang.Throwable

Gets the message for this throwable.

getModel() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the model number of the IntelliBrain controller.

getMotor(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the Motor object for the specified motor.

getMotor(int) - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the motor object for a particular motor.

getMotor1() - Method in class com.ridgesoft.robotics.effectors.DevantechMD22

Gets the Motor object for motor 1.

getMotor2() - Method in class com.ridgesoft.robotics.effectors.DevantechMD22

Gets the Motor object for motor 2.

getName() - Method in class java.lang.Class

Gets the name string for the Class.

getName() - Method in class java.lang.Thread

Gets the name of this thread.

getName() - Method in class javax.comm.CommPort

Gets the name of this port.

getOutputStream() - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the OutputStream for the LCD.

getOutputStream() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the OutputStream for the LCD.

getOutputStream() - Method in class javax.comm.CommPort

Gets the OutputStream for this port.

getPose() - Method in interface com.ridgesoft.robotics.Localizer

Gets the robot's pose (x, y position and heading).

getPose() - Method in class com.ridgesoft.robotics.OdometricLocalizer

Gets the robot's pose (x, y position and heading).

getPriority() - Method in class java.lang.Thread

Gets the priority of this thread.

getRate() - Method in class com.ridgesoft.intellibrain.IntelliBrainShaftEncoder

Read the current rate of the encoder counter.

getRate() - Method in class com.ridgesoft.robotics.AnalogShaftEncoder

Not supported.

getRate() - Method in interface com.ridgesoft.robotics.ShaftEncoder

Reads the current counting rate of the shaft encoder.

getReceiveThread() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Gets the camera's receiver thread.

getRxErrors() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Gets the count of receive errors.

getScrollIndex(int) - Method in interface com.ridgesoft.ui.MenuController

Samples the scroll input and scales the result such that this method returns an index from the specified number of values.

getScrollIndex(int) - Method in class com.ridgesoft.ui.TwoLineDisplayMenuController

Samples the scroll input and scales the result such that this method returns an index from the specified number of values.

getServo(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the Servo object for a particular Handy Board servo.

getServo(int) - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the Servo object for the specified servo.

getShaftEncoder(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the ShaftEncoder object for a particular quadrature shaft encoder.

getShaftEncoder(int) - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the IntelliBrainShaftEncoder object for a particular quadrature shaft encoder.

getSoftwareRevision() - Method in class com.ridgesoft.robotics.effectors.DevantechMD03

Gets the software revsion of the device's software.

getSoftwareRevision() - Method in class com.ridgesoft.robotics.effectors.DevantechMD22

Gets the software revsion of the device's software.

getSoftwareRevision() - Method in class com.ridgesoft.robotics.effectors.DevantechSP03

Gets the software revsion of the device's software.

getSoftwareRevision() - Method in class com.ridgesoft.robotics.sensors.DevantechCMPS03I2C

Gets the software revsion of the device's software.

getSoftwareRevision() - Method in class com.ridgesoft.robotics.sensors.DevantechSRF08

Gets the software revsion of the device's software.

getStartButton() - Static method in class com.ridgesoft.handyboard.HandyBoard

Returns the PushButton object for the START button.

getStartButton() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the PushButton object for the START button.

getStatisticData() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Retrieves the latest statistic data reported by the camera.

getStatusLed() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the LED object for the status LED (green) on the main board.

getStopButton() - Static method in class com.ridgesoft.handyboard.HandyBoard

Returns the PushButton object for the STOP button.

getStopButton() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the PushButton object for the STOP button.

getThumbWheel() - Static method in class com.ridgesoft.handyboard.HandyBoard

Gets the AnalogInput object for the thumbwheel.

getThumbWheel() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the AnalogInput object for the thumbwheel.

getTrackingData() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Retrieves the latest tracking data reported by the camera.

getUserLed(int) - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Gets the LED object for the specified LED on the IntelliBrain 2 board or the expansion board on the original IntelliBrain controller.

getWidth() - Method in class com.ridgesoft.io.Display

Gets the width of the display in characters.

go(float) - Method in class com.ridgesoft.robotics.DifferentialDriveNavigator

Drive the robot indefinitely in the direction specified.

go(float) - Method in interface com.ridgesoft.robotics.Navigator

Drive the robot indefinitely in the direction specified.

greenDeviation - Variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamStatisticData

The deviation of the green values in the current window.

greenMean - Variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamStatisticData

The mean green value in the current window.

H

HandyBoard - class com.ridgesoft.handyboard.HandyBoard.

Handy Board support class.

hashCode() - Method in class java.lang.Object

Returns a unique number for this Object.

hashCode() - Method in class java.lang.String

Returns a hash code generated from the characters that make up this String.

heading() - Method in class com.ridgesoft.robotics.Compass

Reads the current heading from the compass.

heading - Variable in class com.ridgesoft.robotics.Pose

The heading in radians.

heading() - Method in class com.ridgesoft.robotics.sensors.DevantechCMPS03

Reads the current heading from the compass.

heading() - Method in class com.ridgesoft.robotics.sensors.DevantechCMPS03I2C

Reads the current heading from the compass.

histogram - Variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamHistogramData

An array of histogram data.

I

I2CEEPROM - class com.ridgesoft.robotics.I2CEEPROM.

Class to interface to and I2C EEPROM.

I2CEEPROM(I2CMaster, int, int, int) - Constructor for class com.ridgesoft.robotics.I2CEEPROM

Constructs an I2CEEPROM object.

I2CMaster - interface com.ridgesoft.io.I2CMaster.

Interface to a class that provides master control of an I2C bus.

IOException - exception java.io.IOException.

Exception thrown if an IO operation fails.

IOException() - Constructor for class java.io.IOException

IOException(String) - Constructor for class java.io.IOException

IllegalArgumentException - exception java.lang.IllegalArgumentException.

Exception thrown when an argument to a method has an illegal value.

IllegalArgumentException() - Constructor for class java.lang.IllegalArgumentException

IllegalArgumentException(String) - Constructor for class java.lang.IllegalArgumentException

IllegalMonitorStateException - exception java.lang.IllegalMonitorStateException.

Exception thrown when a thread synchronization primitives are not used as intended.

IllegalMonitorStateException() - Constructor for class java.lang.IllegalMonitorStateException

IllegalMonitorStateException(String) - Constructor for class java.lang.IllegalMonitorStateException

IllegalThreadStateException - exception java.lang.IllegalThreadStateException.

Exception thrown if a thread is not in the correct state to perform the requested operation.

IllegalThreadStateException() - Constructor for class java.lang.IllegalThreadStateException

IllegalThreadStateException(String) - Constructor for class java.lang.IllegalThreadStateException

IndexOutOfBoundsException - exception java.lang.IndexOutOfBoundsException.

Exception thrown if an index is not in the valid range for the requested operation.

IndexOutOfBoundsException() - Constructor for class java.lang.IndexOutOfBoundsException

IndexOutOfBoundsException(String) - Constructor for class java.lang.IndexOutOfBoundsException

InputStream - class java.io.InputStream.

Abstract base class for input streams.

InputStream() - Constructor for class java.io.InputStream

Constructor for subclasses to call.

Integer - class java.lang.Integer.

Class to represent an int as an immutable object.

Integer(int) - Constructor for class java.lang.Integer

Constructs an Integer object.

IntelliBrain - class com.ridgesoft.intellibrain.IntelliBrain.

This class serves as the main point of access to features of the IntelliBrain robotics controller.

IntelliBrainAnalogInput - class com.ridgesoft.intellibrain.IntelliBrainAnalogInput.

Class representing a single analog input pin.

IntelliBrainDigitalIO - class com.ridgesoft.intellibrain.IntelliBrainDigitalIO.

Class representing a single digital input/output port.

IntelliBrainExpDigitalIO - class com.ridgesoft.intellibrain.IntelliBrainExpDigitalIO.

Class representing a single digital input/output pin on the expansion board.

IntelliBrainIrReceiver - class com.ridgesoft.intellibrain.IntelliBrainIrReceiver.

Class to interface to the infrared receiver on the IntelliBrain main board.

IntelliBrainPinPort - class com.ridgesoft.intellibrain.IntelliBrainPinPort.

Base class for all analog and digital ports.

IntelliBrainShaftEncoder - class com.ridgesoft.intellibrain.IntelliBrainShaftEncoder.

IntelliBrain specific quadrature shaft encoder reader.

InternalError - error java.lang.InternalError.

Exception thrown if the virtual machine encounters an error which is due to a problem internal to the virtual machine.

InternalError() - Constructor for class java.lang.InternalError

InternalError(String) - Constructor for class java.lang.InternalError

InterruptedException - exception java.lang.InterruptedException.

Exception thrown when an inactive Thread becomes active because it was interrupted.

InterruptedException() - Constructor for class java.lang.InterruptedException

InterruptedException(String) - Constructor for class java.lang.InterruptedException

IrReceiver - interface com.ridgesoft.io.IrReceiver.

Interface to an infrared receiver which receives data from an infrared remote control.

IrRemote - interface com.ridgesoft.robotics.IrRemote.

Generic interface to an object that supports receiving data from an infrared remote control.

identityHashCode(Object) - Static method in class java.lang.System

Gets the default (identity) hash code for the specified object.

initialize(int, int, int, int, int, int, boolean, boolean) - Method in class com.ridgesoft.intellibrain.IntelliBrainIrReceiver

Initializes the infrared receiver.

initialize(IntelliBrainDigitalIO, IntelliBrainDigitalIO) - Method in class com.ridgesoft.intellibrain.IntelliBrainShaftEncoder

Initializes the encoder.

initialize(int, int, int, int, int, int, boolean, boolean) - Method in interface com.ridgesoft.io.IrReceiver

Initializes the receiver.

intBitsToFloat(int) - Static method in class java.lang.Float

Returns the float represented by the bit in the specified int.

intValue() - Method in class java.lang.Integer

Returns the int value of this object.

interrupt() - Method in class java.lang.Thread

Interrupts this thread.

interrupted() - Static method in class java.lang.Thread

Indicates if the current thread has been interrupted.

irRead() - Static method in class com.ridgesoft.handyboard.HandyBoard

Reads a waiting character from the infrared receiver.

irRxInitialize(int, int, int, int, int, int, boolean, boolean) - Static method in class com.ridgesoft.handyboard.HandyBoard

Initializes the receiver.

isAlive() - Method in class java.lang.Thread

Returns if this thread is currently alive (hasn't terminated).

isBusy() - Method in class com.ridgesoft.robotics.effectors.DevantechSP03

Returns true if the SP03 is busy with the previous command.

isDaemon() - Method in class java.lang.Thread

Returns true if this thread is a daemon thread.

isDigitalInputSet(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Reads a digital input bit.

isDigitalOutputSet(int) - Static method in class com.ridgesoft.handyboard.HandyBoard

Returns the state of the specified digital output bit.

isExpansionBoardPresent() - Static method in class com.ridgesoft.intellibrain.IntelliBrain

Indicates if the IntelliBrain expansion board is present.

isInfinite(double) - Static method in class java.lang.Double

Checks if the double value specified is infinite.

isInfinite(float) - Static method in class java.lang.Float

Checks if the float value specified is infinite.

isInterrupted() - Method in class java.lang.Thread

Indicates if this thread has been interrupted.

isNaN(double) - Static method in class java.lang.Double

Checks if the double value specified is Not-a-Number (NaN).

isNaN() - Method in class java.lang.Double

Checks if this Double is Not-a-Number (NaN).

isNaN(float) - Static method in class java.lang.Float

Checks if the float value specified is Not-a-Number (NaN).

isNaN() - Method in class java.lang.Float

Checks if this Float is Not-a-Number (NaN).

isOn() - Method in interface com.ridgesoft.io.LED

Reads the state of the LED.

isOn() - Method in class com.ridgesoft.robotics.BasicLED

Reads the state of the LED.

isPressed() - Method in class com.ridgesoft.robotics.BasicPushButton

Returns true if the button is currently pressed.

isPressed() - Method in interface com.ridgesoft.robotics.PushButton

Gets the current state of the button.

isReceiving() - Method in class com.ridgesoft.intellibrain.IntelliBrainIrReceiver

Sample this digital input from the IR demodulator.

isSet() - Method in class com.ridgesoft.intellibrain.IntelliBrainDigitalIO

Samples the state of the port's signal pin.

isSet() - Method in class com.ridgesoft.intellibrain.IntelliBrainPinPort

Samples the state of the port's signal pin.

isSet() - Method in interface com.ridgesoft.robotics.DigitalInput

Returns the state of the digital input.

isSet() - Method in interface com.ridgesoft.robotics.DigitalOutput

Gets the state of this digital output.

isSet(int, int) - Static method in class com.ridgesoft.vm.VM

Tests to see if the bit in the byte at the specified address is set.

isTracking() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Returns whether the camera is currently tracking.

J

java.io - package java.io

Contains IO classes defined by the Java^TM specifications.

java.lang - package java.lang

Contains basic classes defined by the Java^TM specifications.

java.util - package java.util

Contains utility classes defined by the Java^TM specifications.

javax.comm - package javax.comm

Contains communication port classes.

join(long) - Method in class java.lang.Thread

Suspends the current thread until this thread terminates or the specified time expires or the current thread is interrupted.

join() - Method in class java.lang.Thread

Suspends the current thread until this thread terminates or the current thread is interrupted.

L

LED - interface com.ridgesoft.io.LED.

Generic interface to control an LED.

LED_OFF - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Tracking LED mode value to turn the LED off.

LED_ON - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Tracking LED mode value to turn the LED on.

LED_TRACK - Static variable in class com.ridgesoft.robotics.sensors.CMUcam.CMUcamBase

Tracking LED mode value to give the camera control of the LED.

LicenseError - error com.ridgesoft.vm.LicenseError.

Exception thrown when a limit imposed by the current license has been exceeded.

LicenseError(String) - Constructor for class com.ridgesoft.vm.LicenseError

Constructs a LicenseError object.

LinkageError - error java.lang.LinkageError.

Exception thrown if a run-time linking operation fails.

LinkageError() - Constructor for class java.lang.LinkageError

LinkageError(String) - Constructor for class java.lang.LinkageError

Localizer - interface com.ridgesoft.robotics.Localizer.

Generic interface implemented by classes that support two dimensional position tracking.

Long - class java.lang.Long.

Class to represent a long as an immutable object.

Long(long) - Constructor for class java.lang.Long

Constructs a Long object.

length() - Method in class java.lang.String

Returns the count of characters in this String.

loadFrame() - Method in class com.ridgesoft.robotics.sensors.CMUcam.CMUcam2

Loads a baseline frame for motion differencing and motion tracking.

log(double) - Static method in class java.lang.