C

PathSearchContext

Show Usages
This class provides context information that is useful for the path search algorithm of EdgeRouter.
Inheritance Hierarchy

Remarks

Most notably, the context provides access to the edge that is currently being routed (see currentEdge).

This class cannot be instantiated

Members

No filters for this type

Properties

combinedSourceCell

: PartitionCell
readonly
Gets an artificial PartitionCell with the size of the bounds of all source cells of the current path request.
readonlyfinal

Property Value

an artificial partition cell with the size of the bounds of all source cells

See Also

API
getSourceCell

combinedTargetCell

: PartitionCell
readonly
Gets an artificial PartitionCell with the size of the bounds of all target cells of the current path request.
readonlyfinal

Property Value

an artificial partition cell with the size of the bounds of all target cells

See Also

API
getTargetCell

configuration

: PathSearchConfiguration
readonly
Gets the configuration used for the path search phase.
readonlyfinal

Property Value

the configuration used for the path search

currentEdge

: LayoutEdge
readonly
Gets or sets the edge that is currently routed.
This edge is one of those returned by edges.
readonlyfinal

Property Value

the edge that is currently routed

currentEdgeDescriptor

: EdgeRouterEdgeDescriptor
readonly
Gets the EdgeRouterEdgeDescriptor for the currentEdge containing edge-specific settings for the path search.
readonlyfinal

Property Value

the descriptor for the current edge

currentRequest

: PathSearchRequest
readonly
Gets or sets the PathSearchRequest that is currently routed.
This request belongs to the currentEdge.
readonlyfinal

Property Value

the path request that is currently routed.

edges

: IListEnumerable<LayoutEdge>
readonly
Gets the ICursor<T> of LayoutEdge to iterate over the edges that are routed.
readonlyfinal

Property Value

The ICursor<T> of LayoutEdge to iterate over the edges for which a path is calculated.

Methods

addSourceCell

(cell: PartitionCell)
Adds an additional source cell of the current path request if it is not already contained in the list of source cells.
final

Parameters

cell: PartitionCell
the new source cell to add

See Also

API
sourceCellCount, getSourceCell

addTargetCell

(cell: PartitionCell)
Adds an additional target cell of the current path request if it is not already contained in the list of target cells.
final

Parameters

cell: PartitionCell
the new target cell to add

See Also

API
targetCellCount, getTargetCell

getSourceCell

(index: number): PartitionCell
Returns the source cell with the given index in the list of all cells that are covered by the source of the current path request.
final

Parameters

index: number
the index of the source cell

Return Value

PartitionCell
the source cell with the given index in the list of all source cells

getTargetCell

(index: number): PartitionCell
Returns the target cell with the given index in the list of all cells that are covered by the target of the current path request.
final

Parameters

index: number
The index of the target cell

Return Value

PartitionCell
The target cell with the given index in the list of all cells that are covered by the target of the current path request

isSourceCell

(cell: PartitionCell): boolean
Determines whether or not the given cell is a source cell of the current path request.
final

Parameters

cell: PartitionCell
the cell

Return Value

boolean
true if the given cell is in the list of source cells, false otherwise

See Also

API
sourceCellCount, getSourceCell

isTargetCell

(cell: PartitionCell): boolean
Determines whether or not the given cell is a target cell of the current path request.
final

Parameters

cell: PartitionCell
the cell

Return Value

boolean
true if the given cell is in the list of target cells, false otherwise

See Also

API
targetCellCount, getTargetCell

sourceCellCount

(): number
Returns the number of all cells that are covered by the source of the current path request.
final

Return Value

number
the number of all cells that are covered by the source

targetCellCount

(): number
Returns the number of all cells that are covered by the target of the current path request.
final

Return Value

number
the number of all cells that are covered by the target