A PathSearchResult represents the result of a path search as a list of consecutive CellEntrances.
Inheritance Hierarchy
Remarks
A path starts with a CellEntrance for a PartitionCell of the source node and ends with one for a PartitionCell of the target node.
Members
No filters for this type
Constructors
Creates a new instance of PathSearchResult for the given edge, CellEntrances, and cost.
Creates a new instance of PathSearchResult for the given edge, CellEntrances, and cost.
Parameters
- entrances: IList<CellEntrance>
- the list of CellEntrance objects describing the edge path from source node to target node
- cost: number
- the overall cost of this path
Properties
Returns the number of CellEntrance objects in this path.
Returns the number of CellEntrance objects in this path.
readonlyfinal
Methods
Returns the CellEntrance at the given position of this path.
Returns the CellEntrance at the given position of this path.
final
Parameters
- position: number
- the position of the CellEntrance to return
Return Value
- CellEntrance
- the CellEntrance at the given position of this path
See Also
API
- setEntrance
Returns the position of the first occurrence of the given CellEntrance in this path, or -1 if this path does not contain this CellEntrance.
Returns the position of the first occurrence of the given CellEntrance in this path, or
-1 if this path does not contain this CellEntrance.final
Parameters
- entrance: CellEntrance
- the CellEntrance for which the position is retrieved
Return Value
- number
- the position of the first occurrence of the given CellEntrance in this path, or
-1if this path does not contain this CellEntrance
Replaces the CellEntrance at the given position of this path with the given CellEntrance.
Replaces the CellEntrance at the given position of this path with the given CellEntrance.
final
Parameters
- position: number
- the position of the CellEntrance to replace
- entrance: CellEntrance
- the CellEntrance to be stored at the given position
See Also
API
- getEntrance