de.jaetzold.art
Interface ActuatorPort

All Superinterfaces:
Port, SensorPort
All Known Implementing Classes:
BaseActuatorPort

public interface ActuatorPort
extends SensorPort

Interface which describes the capabilities of an ActuatorPort. It guarantees that all SensorPeers delivered are actually instances of ActuatorPeer.


Method Summary
 void connectWith(Actuator actuator)
          Connects the given Actuator to this port.
 void disconnect(Actuator actuator)
          Disconnects the given Actuator from this port.
 ActuatorPeer getPeerFor(Actuator actuator)
          Returns an ActuatorPeer which can be used by the given Actuator.
 String getType()
          Returns the type of this port as a String.
 
Methods inherited from interface de.jaetzold.art.SensorPort
connectWith, disconnect, getPeerFor
 
Methods inherited from interface de.jaetzold.art.Port
conformsTo, getExcludedPorts, getGranularity, getMaximumValue, getMinimumValue, getPortID, getPortNumber
 

Method Detail

getPeerFor

public ActuatorPeer getPeerFor(Actuator actuator)
Returns an ActuatorPeer which can be used by the given Actuator. There should never be the need in calling this method from somewhere outside of an Actuator-implementation.
See Also:
connectWith(Actuator), RawActuator.connectWith(ActuatorPort)

connectWith

public void connectWith(Actuator actuator)
Connects the given Actuator to this port. This sets the peer for the Actuator and disconnects it from any other port it was previously connected to.

disconnect

public void disconnect(Actuator actuator)
Disconnects the given Actuator from this port. If this has been the last Actuator connected with this port it will automatically become disabled, that means all associated resources are freed.

getType

public String getType()
Returns the type of this port as a String. Typical types could be "DC" or "Variable". This feature is not fully used and for now the String should be in some human-understandable form.