com.qualcomm.robotcore.hardware

Interface Engagable

All Known Subinterfaces:

I2cDeviceSynch

All Known Implementing Classes:

I2cDeviceSynchImpl, I2cDeviceSynchImplOnSimple

public interface Engagable

The engageable interface can be used to temporarily disengage higher-level hardware objects from the services they manipulate, then later be able to re-engage them. Objects which implement this interface include legacy motor and servo controllers.

Method Summary

Modifier and Type	Method and Description
void	disengage() Disengage the object from underlying services it uses to render its function.
void	engage() (Re)enage the object with its underlying services.
boolean	isEngaged() Returns whether the object is currently in the engaged state.

Method Detail

disengage

void disengage()

Disengage the object from underlying services it uses to render its function. If the object is presently disenaged, this method has no effect.

engage

void engage()

(Re)enage the object with its underlying services. If the object is presently engaged, this method has no effect.

isEngaged

boolean isEngaged()

Returns whether the object is currently in the engaged state.

Returns:

whether the object is currently in the engaged state.