|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--de.jaetzold.art.RawSensor | +--de.jaetzold.art.RawActuator
This class represents a basic output-device of a hardware-interface. Each output device, such as an Actuator or a Motor needs to be connected to an ActuatorPort first. Through connecting with a Port this Object gets its peer which is required for proper use.
connectWith(ActuatorPort)
Inner classes inherited from class de.jaetzold.art.RawSensor |
RawSensor.ValueSensorPort |
Field Summary | |
protected boolean |
localReturn
This is false by default. |
protected VetoableChangeSupport |
vetos
|
protected boolean |
waitForCompletion
This is true by default. |
Fields inherited from class de.jaetzold.art.RawSensor |
changes, precision, precisionSet, propertyChangeEventDescriptor |
Constructor Summary | |
RawActuator()
|
Method Summary | |
void |
addVetoableChangeListener(VetoableChangeListener l)
For Listeners which can refuse some values to be set. |
void |
connectWith(ActuatorPort port)
Connects this Object with the given Port. |
void |
connectWith(SensorPort port)
Connects this Sensor with the given Port. |
protected double |
convertToActuatorIncoming(double externalValue)
|
protected double |
convertToActuatorOutgoing(double internalValue)
|
void |
disconnect()
Disconnects this Sensor from it's Peer and it's Port. |
Conversion |
getActuatorIncomingConversionDelegate()
|
Conversion |
getActuatorOutgoingConversionDelegate()
|
boolean |
getLocalReturn()
Returns the whether value-returning methods assume no one else is using this Actuator. |
double |
getValue()
Returns the value this Sensor represents as a double. |
boolean |
getWaitForCompletion()
Returns the default for synchronous or asynchronous behavior of state-changing methods. |
void |
removeVetoableChangeListener(VetoableChangeListener l)
For Listeners which can refuse some values to be set. |
void |
setActuatorIncomingConversionDelegate(Conversion delegate)
|
void |
setActuatorOutgoingConversionDelegate(Conversion delegate)
|
void |
setLocalReturn(boolean returnMode)
Controls the behaviour of value-returning Methods. |
void |
setReversed(boolean reversed)
Controls whether this Actuator should treat negative values as positive and the other way round. |
void |
setValue(double value)
Set this Actuator to the value given as a parameter. |
void |
setValue(double value,
boolean waitMode)
Set this Actuator to the Value given as a parameter. |
void |
setWaitForCompletion(boolean waitMode)
Controls when state-changing Methods return. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface de.jaetzold.art.Sensor |
addPropertyChangeListener, addSensorListener, connectWith, getIntValue, getPort, getPrecision, getSensorPort, isConnected, processEvent, propertyChange, removePropertyChangeListener, removeSensorListener, update |
Field Detail |
protected VetoableChangeSupport vetos
protected boolean waitForCompletion
setWaitForCompletion(boolean)
protected boolean localReturn
setLocalReturn(boolean)
Constructor Detail |
public RawActuator()
Method Detail |
protected double convertToActuatorOutgoing(double internalValue)
protected double convertToActuatorIncoming(double externalValue)
public void setActuatorIncomingConversionDelegate(Conversion delegate)
public Conversion getActuatorIncomingConversionDelegate()
public void setActuatorOutgoingConversionDelegate(Conversion delegate)
public Conversion getActuatorOutgoingConversionDelegate()
public void setValue(double value)
Actuator
setValue
in interface Actuator
de.jaetzold.art.Actuator
value
- the value this Actuator should have.NotConnectedException
- if this Actuator has no Peer or the Peer itself isn't connected (e.g. because the connection to the hardware went down)Actuator.setValue(double,boolean)
,
Actuator.setWaitForCompletion(boolean)
public void setValue(double value, boolean waitMode)
Actuator
VetoableChangeListener
-instances vetoes. In this case the method should return without changing anything.setValue
in interface Actuator
de.jaetzold.art.Actuator
value
- the value this Actuator should have.waitForCompletion
- whether this method may set the value asynchronous.NotConnectedException
- if this Actuator has no Peer or the Peer itself isn't connected (e.g. because the connection to the hardware went down)Actuator.setWaitForCompletion(boolean)
,
Actuator.setValue(double)
,
Sensor.isConnected()
,
Actuator.addVetoableChangeListener(VetoableChangeListener)
public double getValue()
Sensor
getValue
in interface Sensor
getValue
in class RawSensor
public void addVetoableChangeListener(VetoableChangeListener l)
Actuator
RawActuator
makes takes these listeners into account.addVetoableChangeListener
in interface Actuator
de.jaetzold.art.Actuator
setValue(double)
public void removeVetoableChangeListener(VetoableChangeListener l)
Actuator
removeVetoableChangeListener
in interface Actuator
de.jaetzold.art.Actuator
Actuator.addVetoableChangeListener(VetoableChangeListener)
public void disconnect()
Sensor
disconnect
in interface Sensor
disconnect
in class RawSensor
de.jaetzold.art.Sensor
Sensor.connectWith(Port)
public void connectWith(ActuatorPort port)
public void connectWith(SensorPort port)
RawSensor
connectWith
in class RawSensor
de.jaetzold.art.RawSensor
RawSensor.ValueSensorPort
,
RawSensor.connectWith(Port)
public void setReversed(boolean reversed)
setReversed
in class RawSensor
public boolean getWaitForCompletion()
Actuator
getWaitForCompletion
in interface Actuator
de.jaetzold.art.Actuator
Actuator.setWaitForCompletion(boolean)
public void setWaitForCompletion(boolean waitMode)
Actuator
setWaitForCompletion
in interface Actuator
de.jaetzold.art.Actuator
waitMode
- whether state-changing methods may return immediatelyActuator.setValue(double)
,
ActuatorPeer.setValue(double,boolean)
public boolean getLocalReturn()
Actuator
getLocalReturn
in interface Actuator
de.jaetzold.art.Actuator
Actuator.setLocalReturn(boolean)
public void setLocalReturn(boolean returnMode)
Actuator
setLocalReturn
in interface Actuator
de.jaetzold.art.Actuator
returnMode
- whether value-returning methods should assume that the value last set is the one the Actuator really has.Sensor.getValue()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |