com.ridgesoft.robotics
Interface Navigator

All Known Implementing Classes:

DifferentialDriveNavigator

public interface Navigator

Generic interface implemented by classes that support two dimensional navigation.

Method Summary

void	go(float heading) Drive the robot indefinitely in the direction specified.
void	moveTo(float x, float y) Move the robot to the specified coordinates.
void	moveTo(float x, float y, boolean wait) Move the robot to the specified coordinates.
void	moveTo(float x, float y, NavigatorListener listener) Move the robot to the specified coordinates.
void	stop() Stop the robot.
void	turnTo(float heading) Turn the robot to the specified heading.
void	turnTo(float heading, boolean wait) Turn the robot to the specified heading.
void	turnTo(float heading, NavigatorListener listener) Turn the robot to the specified heading.

Method Detail

go

void go(float heading)

Drive the robot indefinitely in the direction specified.

Parameters:

heading - direction in radians to head toward

moveTo

void moveTo(float x,
            float y)

Move the robot to the specified coordinates.

This method does not return until the robot has reached the destination.

Parameters:

x - x coordinate to move to

y - y coordinate to move to

moveTo

void moveTo(float x,
            float y,
            boolean wait)

Move the robot to the specified coordinates.

Parameters:

x - x coordinate to move to

y - y coordinate to move to

wait - true if the method should wait for the operation to terminate

moveTo

void moveTo(float x,
            float y,
            NavigatorListener listener)

Move the robot to the specified coordinates.

This method returns without waiting for the movement to complete.

Parameters:

x - x coordinate to move to

y - y coordinate to move to

listener - listener to call when the operation terminates, may be null

stop

void stop()

Stop the robot.

turnTo

void turnTo(float heading)

Turn the robot to the specified heading.

This method does not return until the robot is facing the new heading.

Parameters:

heading - heading to turn to in radians

turnTo

void turnTo(float heading,
            boolean wait)

Turn the robot to the specified heading.

Parameters:

heading - heading to turn to in radians

wait - true if the method should wait for the operation to terminate

turnTo

void turnTo(float heading,
            NavigatorListener listener)

Turn the robot to the specified heading.

This method returns without waiting for the turn to complete.

Parameters:

heading - heading to turn to in radians

listener - listener to call when the operation terminates, may be null