y.layout.router.polyline
Class CellEntrance

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

public class CellEntrance
extends java.lang.Object

This class describes the location and the direction from which a given partition cell has been entered during a path search.

The path that was followed in order to reach a given partition cell can be reconstructed by traversing all previous entrances. The enter interval and enter direction determine how the partition cell was entered.

Constructor Summary

CellEntrance(CellEntrance other)
Creates a new CellEntrance instance that is a copy of a given other CellEntrance.

CellEntrance(PartitionCell cell)
Creates a new CellEntrance instance for a given PartitionCell.

Method Summary

PartitionCell	getCell() Returns the partition cell of this CellEntrance instance.
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 for entering this cell.
double	getHeuristicCosts() Returns the heuristic costs for the implicit path given by the previous entrances.
EdgeCellInfo	getPreviousEdgeCellInfo() Returns the EdgeCellInfo describing how the previous partition cell was traversed.
CellEntrance	getPreviousEntrance() Returns the previous CellEntrance along the path that was traversed in order to reach the cell.
void	setCosts(double costs) Specifies the costs for the implicit path given by the previous entrances.
void	setEnterDirection(Direction direction) Specifies the direction from which this cell was entered.
void	setEnterInterval(OrthogonalInterval interval) Specifies the OrthogonalInterval that was used for entering this cell.
void	setHeuristicCosts(double heuristicCosts) Specifies the heuristic costs for the implicit path given by the previous entrances.
void	setPreviousEdgeCellInfo(EdgeCellInfo previousEdgeCellInfo) Specifies the EdgeCellInfo describing how the previous partition cell was traversed.
void	setPreviousEntrance(CellEntrance previous) Specifies the previous CellEntrance along the path that was traversed in order to reach the cell.
java.lang.String	toString() Returns a string representation of this CellEntrance.

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 CellEntrance instance for a given PartitionCell.

Parameters:

cell - the PartitionCell that is entered

CellEntrance

public CellEntrance(CellEntrance other)

Creates a new CellEntrance instance that is a copy of a given other CellEntrance.

Parameters:

other - the CellEntrance to be copied

Method Detail

toString

public java.lang.String toString()

Returns a string representation of this CellEntrance.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this CellEntrance

getCell

public PartitionCell getCell()

Returns the partition cell of this CellEntrance instance.

Returns:

the partition cell of this CellEntrance instance

getPreviousEntrance

public CellEntrance getPreviousEntrance()

Returns the previous CellEntrance along the path that was traversed in order to reach the cell.

Returns:

the previous CellEntrance or null if this cell is a start entrance

See Also:

setPreviousEntrance(CellEntrance)

setPreviousEntrance

public void setPreviousEntrance(CellEntrance previous)

Specifies the previous CellEntrance along the path that was traversed in order to reach the cell.

Parameters:

previous - the previous CellEntrance or null if this cell is a start entrance

getEnterInterval

public OrthogonalInterval getEnterInterval()

Returns the OrthogonalInterval that was used for entering this cell.

Returns:

the OrthogonalInterval used for entering this cell or null if it is a start entrance

See Also:

setEnterInterval(OrthogonalInterval)

setEnterInterval

public void setEnterInterval(OrthogonalInterval interval)

Specifies the OrthogonalInterval that was used for entering this cell.

Parameters:

interval - the OrthogonalInterval used for entering this cell or null if it is a start entrance

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 cell is a start entrance

See Also:

setEnterDirection(Direction)

setEnterDirection

public void setEnterDirection(Direction direction)

Specifies the direction from which this cell was entered.

Parameters:

direction - the direction from which this cell was entered or null if this cell is a start entrance

getCosts

public double getCosts()

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

The costs must be non-negative.

Returns:

the costs for the implicit path given by the previous entrances

See Also:

setCosts(double)

setCosts

public void setCosts(double costs)

Specifies the costs for the implicit path given by the previous entrances.

The costs must be non-negative.

Default Value:

The default value is 0.

Parameters:

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

Throws:

java.lang.IllegalArgumentException - if the costs are negative

getHeuristicCosts

public double getHeuristicCosts()

Returns the heuristic costs for the implicit path given by the previous entrances.

Heuristic costs must be non-negative.

Returns:

the heuristic costs for the implicit path given by the previous entrances

See Also:

setHeuristicCosts(double)

setHeuristicCosts

public void setHeuristicCosts(double heuristicCosts)

Specifies the heuristic costs for the implicit path given by the previous entrances.

Heuristic costs must be non-negative.

Default Value:

The default value is 0.

Parameters:

heuristicCosts - the heuristic costs for the implicit path given by the previous entrances

Throws:

java.lang.IllegalArgumentException - if the heuristic costs are negative

getPreviousEdgeCellInfo

public EdgeCellInfo getPreviousEdgeCellInfo()

Returns the EdgeCellInfo describing how the previous partition cell was traversed.

Returns:

the EdgeCellInfo describing how the previous cell was traversed or null if this cell is a start entrance

setPreviousEdgeCellInfo

public void setPreviousEdgeCellInfo(EdgeCellInfo previousEdgeCellInfo)

Specifies the EdgeCellInfo describing how the previous partition cell was traversed.

Parameters:

previousEdgeCellInfo - the EdgeCellInfo describing how the previous cell was traversed