de.jaetzold.art.platform
Interface ActuatorPeer

All Superinterfaces:
SensorPeer
All Known Subinterfaces:
MotorPeer, ServoPeer, StepperMotorPeer
All Known Implementing Classes:
Mindstorms.RCXActuatorPeer, AWTRobotInterface.TextFieldActuatorPeer

public interface ActuatorPeer
extends SensorPeer

This is for Peers which allow manipulation of the represented value and forward this value-change to some part of the hardware.


Method Summary
 void setValue(double value)
          Set the actuator to the value given as a parameter.
 void setValue(double value, boolean waitForCompletion)
          Set the actuator to the value given as a parameter.
 
Methods inherited from interface de.jaetzold.art.platform.SensorPeer
addPropertyChangeListener, disableEvent, enableEvent, getDeliversFloatingPoint, getPrecision, getValue, isConnected, processEvent, removePropertyChangeListener, update
 

Method Detail

setValue

public void setValue(double value)
Set the actuator to the value given as a parameter.
See Also:
setValue(double,boolean)

setValue

public void setValue(double value,
                     boolean waitForCompletion)
Set the actuator to the value given as a parameter. If waitForCompletion is false this method may return before the new value has been sent to the hardware. This way the method could return almost immediatly and informing the peer and thus the hardware may happen asynchronous. If for some reason the value is not o.k. for this Peer it is not required to accept the value and it is also not required to report that through an Exception.
Parameters:
value - the value this Actuator should have.
waitForCompletion - whether this method may set the value asynchronous.
See Also:
setValue(double)