PTStopScheduleFilter class Maps & 3D Scenes

Optional departures filter for the public transport stop schedule request (see OverlayItem.getPreviewExtendedData / OverlayItem.getPTStopInfo).

A departure is kept when: routeId ∈ routeIds OR (routeShortName ∈ lineNames AND (headings empty OR heading ∈ headings)).

routeIds and lineNames are OR'd - both may be used in one request. headings only refines lineNames matches; it never selects by itself and does not affect routeIds matches. String matching is exact and case-sensitive. The filter narrows only the trips (departures) section - the stops[].routes[] line catalogue is always returned complete.

shapes additionally requests the route shapes (PTStopInfo.shapes) - they are the largest part of the payload, request them only when they will be drawn.

An empty filter (all defaults) behaves exactly like the filter-less request.

An inconsistent filter (a time before the Unix epoch; empty string entry in lineNames / headings; headings non-empty while lineNames is empty) is rejected with GemError.invalidInput before any request is sent.

Constructors

PTStopScheduleFilter({List<int> routeIds = const <int>[], List<String> lineNames = const <String>[], List<String> headings = const <String>[], int maxRows = 0, Duration? window, DateTime? time, bool shapes = false})
Creates a PTStopScheduleFilter.
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
headings → List<String>
Optional direction restriction for lineNames matches (see PTRouteInfo.heading).
final
isEmpty → bool
True when all fields have their defaults - such a filter behaves exactly like the filter-less request.
no setter
lineNames → List<String>
Keep departures whose route short name is in this set (see PTRouteInfo.routeShortName).
final
maxRows → int
Departures to return; 0 = server default.
final
routeIds → List<int>
Keep departures whose route id is in this set.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shapes → bool
Request the route shapes; false = no shapes (the default).
final
time → DateTime?
Absolute time to search forward from; null = now.
final
window → Duration?
Forward search horizon from time; null = server default.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Builds the native request arguments. Route ids and time are serialized as decimal strings to preserve the full signed 64-bit precision across the JSON channel on every platform (including web, where ints are IEEE doubles).
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited