Class Edge

This class represents an edge within the Dijkstra graph. These connect all of the waypoints for the graph.

Since

2.0.0

Hierarchy

Edge

Index

Constructors

Methods

getDestinationId getSourceId getWeight toString getInstance

Constructors

constructor

new Edge(sourceId, destinationId, weight): Edge
Parameters
- sourceId: string
- destinationId: string
- weight: number
Returns Edge

Methods

getDestinationId

getDestinationId(): string
Returns string

getSourceId

getSourceId(): string
Returns string

getWeight

getWeight(): number
Returns number

toString

toString(): string
Returns string

`Static` getInstance

getInstance(source, destination, weight): Edge
Factory method to create an Edge using Waypioint instaces
Parameters
- source: Waypoint
  
  The source or origin waypoint
- destination: Waypoint
  
  The target point
- weight: number
  
  The wheight
Returns Edge
a new instance of the Edge

Generated using TypeDoc