com.qualcomm.robotcore.hardware

Class GyroSensor

java.lang.Object

com.qualcomm.robotcore.hardware.GyroSensor

All Implemented Interfaces:

HardwareDevice

public abstract class GyroSensor
extends java.lang.Object
implements HardwareDevice

Gyro Sensor

Constructor Summary

Constructors

Constructor and Description
GyroSensor()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	calibrate() Calibrate the gyro.
abstract int	getHeading() Return the integrated Z axis as a cartesian heading.
abstract double	getRotation() Return the rotation of this sensor
abstract boolean	isCalibrating() Is the gyro performing a calibration operation?
void	notSupported()
abstract int	rawX() Return the gyro's raw X value.
abstract int	rawY() Return the gyro's raw Y value.
abstract int	rawZ() Return the gyro's raw Z value.
abstract void	resetZAxisIntegrator() Set the integrated Z axis to zero.
abstract java.lang.String	status() Status of this sensor, in string form
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.qualcomm.robotcore.hardware.HardwareDevice

close, getConnectionInfo, getDeviceName, getVersion

Constructor Detail

GyroSensor

public GyroSensor()

Method Detail

calibrate

public abstract void calibrate()

Calibrate the gyro. For the Modern Robotics device this will null, or reset, the Z axis heading.

Throws:

java.lang.UnsupportedOperationException - if unsupported; not all gyro devices support this feature

isCalibrating

public abstract boolean isCalibrating()

Is the gyro performing a calibration operation?

Returns:

true if yes, false otherwise

Throws:

java.lang.UnsupportedOperationException - if unsupported; not all gyro devices support this feature

getHeading

public abstract int getHeading()

Return the integrated Z axis as a cartesian heading.

Returns:

heading between 0-360.

Throws:

java.lang.UnsupportedOperationException - if unsupported; not all gyro devices support this feature

getRotation

public abstract double getRotation()

Return the rotation of this sensor

Returns:

rotation

Throws:

java.lang.UnsupportedOperationException - if unsupported; not all gyro devices support this feature

rawX

public abstract int rawX()

Return the gyro's raw X value.

Returns:

X value

Throws:

java.lang.UnsupportedOperationException - if unsupported; not all gyro devices support this feature

rawY

public abstract int rawY()

Return the gyro's raw Y value.

Returns:

Y value

Throws:

java.lang.UnsupportedOperationException - if unsupported; not all gyro devices support this feature

rawZ

public abstract int rawZ()

Return the gyro's raw Z value.

Returns:

Z value

Throws:

java.lang.UnsupportedOperationException - if unsupported; not all gyro devices support this feature

resetZAxisIntegrator

public abstract void resetZAxisIntegrator()

Set the integrated Z axis to zero.

Throws:

java.lang.UnsupportedOperationException - if unsupported; not all gyro devices support this feature

status

public abstract java.lang.String status()

Status of this sensor, in string form

Returns:

status

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

notSupported

public void notSupported()