Stop

class Stop

A class that represents a location to be visited along a route. The Stop class contains location inputs for the Route_task. The Route_task will create a route between two or more Stops. A Stop object is not an arbitrary bag of properties, but contains only the properties needed for routing (for example, a Stop object does not have address information). Stop objects are collected into a MutableList by value, and passed as an input to RouteTask.

The stop class is derived from the graphic class.

Since

200.1.0

See also

Constructors

Link copied to clipboard
constructor(point: Point)

Creates a stop instance with point. Creates a stop.

Properties

Link copied to clipboard

Arrival curb approach.

Link copied to clipboard

Arrival time.

Link copied to clipboard

Time zone shift for arrival time, in minutes.

Link copied to clipboard

Curb approach.

Link copied to clipboard

Current bearing in degrees. Current bearing in degrees, measured clockwise from true north. Typical values are 0 to 360 or NaN, negative values will be subtracted from 360 (e.g. -15 => 345), values greater than 360 will be have 360 subtracted from them (e.g. 385 => 25). For this property to be used the bearing tolerance also has to be set.

Link copied to clipboard

Current bearing tolerance in degrees. Valid values are 0 to 180 or NaN.

Link copied to clipboard

Departure curb approach.

Link copied to clipboard

Departure time.

Link copied to clipboard

Time zone shift for departure time, in minutes.

Link copied to clipboard

Distance to network location in meters.

Link copied to clipboard

The geometry of a stop. The point geometry of Stop.

Link copied to clipboard

Location status.

Link copied to clipboard

Stop's name.

Link copied to clipboard

Navigation latency in seconds.

Link copied to clipboard

Navigation speed in meters per second.

Link copied to clipboard

Network location. A null for resetting a network location.

Link copied to clipboard

Route's name.

Link copied to clipboard

Sequence.

Link copied to clipboard
var stopId: Int

Stop ID. This is a caller supplied foreign key that can be used to associate output stops with input stops.

Link copied to clipboard

Stop's type. Default value that will be returned on error is StopType.Stop.

Link copied to clipboard

Time window end.

Link copied to clipboard

Time window start.

Link copied to clipboard

Violation time in minutes.

Link copied to clipboard

Wait time in minutes.

Functions

Link copied to clipboard
fun clone(): Stop

Clones the Stop.

Link copied to clipboard
fun getAddedCost(attributeName: String): Double

Gets added cost attribute value. In case when attribute's name can not be found 0.0 will be returned.

Link copied to clipboard
fun getCumulativeCost(attributeName: String): Double

Gets cumulative cost attribute value. In case when attribute's name can not be found 0.0 will be returned.

Link copied to clipboard
fun setAddedCost(attributeName: String, addedCost: Double)

Sets added cost.