Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RouteStop

Represents a stop on a route. Fields include the location of the stop, a description of the stop and the nearest intersection.

Hierarchy

  • RouteStop

Index

Constructors

constructor

  • Initializes this from an existing RouteStop.

    Parameters

    Returns RouteStop

  • Initializes this from a location.

    Parameters

    • latlon: ILatLon

      The location of the route stop.

    Returns RouteStop

Properties

approaches

approaches: AccessPath[]

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

averageTime

averageTime: TimeSpan

The average time spent at the stop.

departures

departures: AccessPath[]

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

description

description: string

A description of the route stop.

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.

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.

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.

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.

speed

speed: Speed

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

tag

tag: any

For external use - set to whatever you like.

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.

windowEnd

windowEnd: Date

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

windowStart

windowStart: Date

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

Static ASSEMBLY_NAME

ASSEMBLY_NAME: string = GEOBASE_ASSEMBLY_NAME

Static CLASS_NAME

CLASS_NAME: string = "Telogis.GeoBase.RouteStop"

Methods

equals

  • equals(other: any): boolean
  • Parameters

    • other: any

    Returns boolean

setApproaches

  • Parameters

    Returns void

setDepartures

  • Parameters

    Returns void

Generated using TypeDoc