Search this API

y.layout.router.polyline
Class CellEntrance

java.lang.Object
  extended by y.layout.router.polyline.CellEntrance

public class CellEntrance
extends Object

Describes where and from which direction a PartitionCell has been entered during a path search. The path to reach the cell can be reconstructed by traversing the previous entrances. The enter interval and enter direction determine how the cell was entered.


Constructor Summary
CellEntrance(CellEntrance other)
          Creates a copy of the given CellEntrance.
CellEntrance(PartitionCell cell)
          Creates a new instance.
 
Method Summary
 PartitionCell getCell()
          Returns this entrance's partition cell.
 double getCosts()
          Returns the costs for the implicit path given by the previous entrances.
 Direction getEnterDirection()
          Returns the direction from which this cell was entered.
 OrthogonalInterval getEnterInterval()
          Returns the OrthogonalInterval that was used to enter this cell.
 EdgeCellInfo getPreviousEdgeCellInfo()
          Returns the EdgeCellInfo describing how the previous cell was crossed.
 CellEntrance getPreviousEntrance()
          Returns the previous CellEntrance in the path that reached this cell.
 void setCosts(double costs)
          Sets the costs for the implicit path given by the previous entrances.
 void setEnterDirection(Direction direction)
          Sets the direction from which this cell was entered.
 void setEnterInterval(OrthogonalInterval interval)
          Sets the OrthogonalInterval that was used to enter this cell.
 void setPreviousEdgeCellInfo(EdgeCellInfo previousEdgeCellInfo)
          Sets the EdgeCellInfo describing how the previous cell was crossed.
 void setPreviousEntrance(CellEntrance previous)
          Sets the previous CellEntrance in the path that reached this cell.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CellEntrance

public CellEntrance(PartitionCell cell)
Creates a new instance.

Parameters:
cell - The entered partition cell.

CellEntrance

public CellEntrance(CellEntrance other)
Creates a copy of the given CellEntrance.

Parameters:
other - the CellEntrance, of which a copy is to be made
Method Detail

toString

public String toString()
Overrides:
toString in class Object

getCell

public PartitionCell getCell()
Returns this entrance's partition cell.

Returns:
this entrance's partition cell

getPreviousEntrance

public CellEntrance getPreviousEntrance()
Returns the previous CellEntrance in the path that reached this cell.

Returns:
The previous CellEntrance in the path that reached this cell or null if this is a start entrance.

setPreviousEntrance

public void setPreviousEntrance(CellEntrance previous)
Sets the previous CellEntrance in the path that reached this cell.

Parameters:
previous - The previous CellEntrance in the path that reached this cell.

getEnterInterval

public OrthogonalInterval getEnterInterval()
Returns the OrthogonalInterval that was used to enter this cell.

Returns:
The OrthogonalInterval that was used to enter this cell or null if this is a start entrance.

setEnterInterval

public void setEnterInterval(OrthogonalInterval interval)
Sets the OrthogonalInterval that was used to enter this cell.

Parameters:
interval - The OrthogonalInterval that was used to enter this cell.

getEnterDirection

public Direction getEnterDirection()
Returns the direction from which this cell was entered.

Returns:
the direction from which this cell was entered or null if this is a start entrance.

setEnterDirection

public void setEnterDirection(Direction direction)
Sets the direction from which this cell was entered.

Parameters:
direction - the direction from which this cell was entered

getCosts

public double getCosts()
Returns the costs for the implicit path given by the previous entrances.

Returns:
the costs for the implicit path given by the previous entrances

setCosts

public void setCosts(double costs)
Sets the costs for the implicit path given by the previous entrances.

Parameters:
costs - the costs for the implicit path given by the previous entrances

getPreviousEdgeCellInfo

public EdgeCellInfo getPreviousEdgeCellInfo()
Returns the EdgeCellInfo describing how the previous cell was crossed.

Returns:
The EdgeCellInfo describing how the previous cell was crossed or null if this is a start entrance.

setPreviousEdgeCellInfo

public void setPreviousEdgeCellInfo(EdgeCellInfo previousEdgeCellInfo)
Sets the EdgeCellInfo describing how the previous cell was crossed.

Parameters:
previousEdgeCellInfo - The EdgeCellInfo describing how the previous cell was crossed.

© Copyright 2000-2013,
yWorks GmbH.
All rights reserved.