Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRouteStop

An interface for a RouteStop.

Hierarchy

  • IRouteStop

Index

Properties

Optional approaches

approaches: AccessPath[]

A list of access paths that can be used to approach the route stop.

Optional averageTime

averageTime: TimeSpan

The average time spent at the stop.

Optional departures

departures: AccessPath[]

A list of access paths that can be used to depart from the route stop.

Optional description

description: string

A description of the route stop.

Optional heading

heading: number

The direction that the vehicle is heading when at or passing the route stop. This value will be used to choose which street this RouteStop belongs on.

Optional idlePenalty

idlePenalty: number

Used to specify a penalty for the idle time. When set, this value is used as the penalty for a TooEarly violation during Route Optimization i.e., the waiting time at the stop.

Optional intersection

intersection: LatLon

The point where you enter or exit the street network to get to this stop.

location

location: LatLon

The location of the route stop; as LatLon coordinates.

Optional penalty

penalty: number

Represents a penalty incurred for missing the alloted delivery window. The penalty must be greater than or equal to zero. A value of -1 indicates that the penalty has not been set.

Optional speed

speed: Speed

The speed that the vehicle was going when at or passing the route stop.

Optional tag

tag: any

For external use - set to whatever you like.

Optional timeSincePreviousStop

timeSincePreviousStop: TimeSpan

Time (in seconds) since the vehicle was at the previous stop in the route history. Used when calculating a route highlight. If this value is too small, the routing engine will fail to query an area that is sufficiently large in size.

Optional windowEnd

windowEnd: Date

The latest time that the vehicle should arrive at the route stop; as a Date object.

Optional windowStart

windowStart: Date

The earliest time that the vehicle should arrive at the route stop; as a Date object.

Generated using TypeDoc