com.kuka.nav.fleet.graph.properties
Class WaitingZone

java.lang.Object
  com.kuka.nav.fleet.graph.properties.AbstractProperty
      com.kuka.nav.fleet.graph.properties.WaitingZone

All Implemented Interfaces:

Property, Serializable

public class WaitingZone
extends AbstractProperty

The waiting zone defines a list of waiting nodes for a node. Vehicles which are commanded to this node must wait in this zone if the node is blocked.

See Also:

Serialized Form

Constructor Summary

WaitingZone()
Constructor.

WaitingZone(List<Integer> nodeIds, double lengthOfStay)
Constructor.

Method Summary

Collection<Integer>	getAllowedTypes() Returns the allowed robot type ids for this property.
Double	getEstimatedLengthOfStay() Gets the estimated length of time which a vehicle spends at the node defining the waiting zone.
String	getValueToDisplay() Returns the value(s) in a way to show it in a UI.
List<Integer>	getWaitingNodeIdList() Returns an ordered list of waiting node.
String	getWaitingNodes() Returns a string representation of the waiting node id list, ordered in such a way that the first id is the waiting node closest to the goal.
void	setEstimatedLengthOfStay(Double lengthOfStay) Sets the estimated length of time which a vehicle spends at the node defining the waiting zone.
void	setWaitingNodeIdList(List<Integer> nodeIds) Set the waiting node ids as list.
void	setWaitingNodes(String waitingNodes) Sets the waiting node ids.
String	toString()

Methods inherited from class com.kuka.nav.fleet.graph.properties.AbstractProperty

equals, fireChanged, getId, hashCode, setId, tryGetParamFromString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WaitingZone

public WaitingZone(List<Integer> nodeIds,
                   double lengthOfStay)

Constructor.

Parameters:

nodeIds - the node ids to be set. No id may occur more than once, each id must correspond to a node which exists in the same graph as the node to which this property is added, and the node's own id must not occur in the list. The last id in the list corresponds to the first waiting node which must be visited, the second-last id corresponds to the second waiting node, etc. The first id in the list corresponds to the last waiting node visited before a vehicle may move to the goal.

lengthOfStay - the estimated time a vehicle spends at the node defining the waiting zone

WaitingZone

public WaitingZone()

Constructor. Creates an empty waiting zone.

Method Detail

getValueToDisplay

public String getValueToDisplay()

Description copied from interface: Property

Returns the value(s) in a way to show it in a UI.

Returns:

the values

toString

public String toString()

Overrides:

toString in class Object

getWaitingNodes

public String getWaitingNodes()

Returns a string representation of the waiting node id list, ordered in such a way that the first id is the waiting node closest to the goal.

Returns:

the a string representation of the waiting nodes.

getWaitingNodeIdList

public List<Integer> getWaitingNodeIdList()

Returns an ordered list of waiting node. The first element is the closest waiting node to the goal.

Returns:

the waiting node ids in a list

setWaitingNodes

public void setWaitingNodes(String waitingNodes)

Sets the waiting node ids.

Parameters:

waitingNodes - a comma separated list of node ids. No id may occur more than once, each id must correspond to a node which exists in the same graph as the node to which this property is added, and the node's own id must not occur in the list. The last id in the list corresponds to the first waiting node which must be visited, the second-last id corresponds to the second waiting node, etc. The first id in the list corresponds to the last waiting node visited before a vehicle may move to the goal.

setWaitingNodeIdList

public void setWaitingNodeIdList(List<Integer> nodeIds)

Set the waiting node ids as list. No id may occur more than once, each id must correspond to a node which exists in the same graph as the node to which this property is added, and the node's own id must not occur in the list. The last id in the list corresponds to the first waiting node which must be visited, the second-last id corresponds to the second waiting node, etc. The first id in the list corresponds to the last waiting node visited before a vehicle may move to the goal.

Parameters:

nodeIds - list of waiting nodes in correct order

getEstimatedLengthOfStay

public Double getEstimatedLengthOfStay()

Gets the estimated length of time which a vehicle spends at the node defining the waiting zone.

Returns:

the estimated length of time spent at the node [in seconds]

setEstimatedLengthOfStay

public void setEstimatedLengthOfStay(Double lengthOfStay)

Sets the estimated length of time which a vehicle spends at the node defining the waiting zone.

Parameters:

lengthOfStay - the estimated length of time spent at the node to be set [in seconds]

getAllowedTypes

public Collection<Integer> getAllowedTypes()

Description copied from interface: Property

Returns the allowed robot type ids for this property. Note that the id corresponding to all robot types (PropertyHolder.ROBOTTYPEALL) is considered as a separate robot type. If all possible types are allowed the returned collection is empty.

Specified by:

getAllowedTypes in interface Property

Overrides:

getAllowedTypes in class AbstractProperty

Returns:

the allowed robot type ids