| type | description |
|---|---|
| AbsoluteDirection | An absolute cardinal or intermediate direction. |
| Alert | |
| AlertPatch | This adds a note to all boardings of a given route or stop (optionally, in a given direction) |
| AlertPatchCreationResponse | |
| AlertPatchResponse | |
| AlertPatchSet | |
| ArrivalTime | |
| BikeRentalStation | |
| BikeRentalStationList | |
| BoardAlightType | Distinguish between special ways a passenger may board or alight at a stop. The majority of boardings and alightings will be of type "default" -- a regular boarding or alighting at a regular transit stop. Currently, the only non-default types are related to GTFS-Flex, but this pattern can be extended as necessary. |
| CarFuelType | |
| CarRentalStation | |
| CarRentalStationList | |
| Coordinate | |
| CoordinateArrayListSequence | An instance of CoordinateSequence that can be efficiently extended |
| CoordinateSequence | |
| CoordinateSequenceFactory | |
| DEFAULT | |
| DebugOutput | Holds information to be included in the REST Response for debugging and profiling purposes. startedCalculating is called in the routingContext constructor. finishedCalculating and finishedRendering are all called in PlanGenerator.generate(). finishedPrecalculating and foundPaths are called in the SPTService implementations. |
| ElevationMetadata | Contains elevation-specific metadata to be included in the response Created by demory on 2/16/17. |
| EncodedPolylineBean | A list of coordinates encoded as a string. See Encoded polyline algorithm format |
| EntryOfStringAndString | |
| Envelope | |
| Fare | Fare is a set of fares for different classes of users. |
| FareComponent | FareComponent is a sequence of routes for a particular fare. |
| FareType | |
| FeedScopedId | |
| GeocoderResult | |
| GeocoderResults | |
| Geometry | |
| GeometryFactory | |
| I18NString | This interface is used when providing translations on server side. |
| InspectorLayer | |
| InspectorLayersList | |
| Itinerary | An Itinerary is one complete way of getting from the start location to the end location. |
| Leg | One leg of a trip -- that is, a temporally continuous piece of the journey that takes place on a particular vehicle (or on foot). |
| LocalizedAlert | |
| LocalizedString | This is used to localize strings for which localization are known beforehand. Those are local names for: unanamedStreet, corner of x and y, path, bike_path etc. Translations are in src/main/resources/WayProperties_lang.properties and internals_lang.properties locale is set in request. |
| MavenVersion | |
| Message | The purpose of Messages is to read supply Message.properties to underlying calling code... The ENUM's enumerated values should be named to reflect the property names inside of Message.properties |
| Money | Fare support is very, very preliminary. |
| NonLocalizedString | This is to support strings which can't be localized. It just returns string it is given in constructor. |
| P2 | An ordered pair of objects of the same type |
| P2OfDouble | An ordered pair of objects of the same type |
| PackedCoordinateSequence | A CoordinateSequence implementation based on a packed arrays. In this implementation,
Coordinates returned by #toArray and #get are copies of the internal values. To change
the actual values, use the provided setters.
For efficiency, created Coordinate arrays are cached using a soft reference. The cache is cleared each time the coordinate sequence contents are modified through a setter method. 2009-11-25 - bdferris - This class copied from JTS (LGPL-licensed) to add Serializable to the class so that we can serialize it with our graphs |
| Place | A Place is where a journey starts or ends, or a transit stop along the way. |
| PlannerError | This API response element represents an error in trip planning. |
| Point | |
| PrecisionModel | |
| RelativeDirection | Represents a turn direction, relative to the current heading. CIRCLE_CLOCKWISE and CIRCLE_CLOCKWISE are used to represent traffic circles. |
| RentalStation | |
| Response | Represents a trip planner response, will be serialized into XML or JSON by Jersey |
| RideEstimate | |
| RouterInfo | |
| RouterList | |
| Serializable2DPackedCoordinateSequenceFactory | |
| ServerInfo | |
| T2 | An ordered pair of objects of potentially different types |
| TranslatedString | This is for translated strings for which translations are read from OSM or GTFS alerts. This can be translated street names, GTFS alerts and notes. |
| TransportationNetworkCompany | |
| TransportationNetworkCompanyResponse | |
| TransportationNetworkCompanySummary | Simplified TNC summary included with itinerary Leg. |
| TravelOption | This class is used to send to client which Travel Options are possible on this server This options are used in client "Travel by" drop down. Each travel option consist of two variables: - value is a value which is sent to the server if this is chosen ("TRANSIT, WALK", "CAR", etc.) - name is a name with which client can nicely name this option even if specific value changes ("TRANSIT", "PARKRIDE", "TRANSIT_BICYCLE", etc.) Travel options are created from org.opentripplanner.routing.graph.Graph transitModes variable and based if park & ride, bike & ride, bike sharing is supported. List itself is created in TravelOptionsMaker#makeOptions(HashSet, boolean, boolean, boolean) |
| TraverseMode | |
| TripPlan | A TripPlan is a set of ways to get from point A to point B at time T. |
| Type | |
| VehicleRentalStation | This class models a place where a rental vehicle can be returned or picked up. This class is typically used in one of 3 ways: 1. To model a docking station that may have multiple vehicles that can be rented and also parking spaces to return a rented vehicle. 2. To model a single floating vehicle that can only be picked up. 3. To model a border dropoff where the extent of vehicle rental region ends. At this point, the StreetEdge is split and a vehicle rental station is created to facilitate the dropoff of vehicles no further than the allowable dropoff area. FIXME: border dropoff stations, vertices and edges are probably not needed anymore with updated StreetEdge dropoff checks. |
| VehicleRentalStationList | |
| VertexType | Represent type of vertex, used in Place aka from, to in API for easier client side localization |
| WalkStep | Represents one instruction in walking directions. Three examples from New York City:
Turn onto Broadway from W 57th St (coming from 7th Ave):
Now, turn from Broadway onto Central Park S via Columbus Circle
Instead, go through the circle to continue on Broadway |
| WrappedCurrency | A Bean wrapper class for java.util.Currency |
| type | description |
|---|---|
| locale | |
| geometry | |
| message | The purpose of Messages is to read supply Message.properties to underlying calling code... The ENUM's enumerated values should be named to reflect the property names inside of Message.properties |
| absoluteDirection | An absolute cardinal or intermediate direction. |
| boardAlightType | Distinguish between special ways a passenger may board or alight at a stop. The majority of boardings and alightings will be of type "default" -- a regular boarding or alighting at a regular transit stop. Currently, the only non-default types are related to GTFS-Flex, but this pattern can be extended as necessary. |
| itinerary | An Itinerary is one complete way of getting from the start location to the end location. |
| leg | One leg of a trip -- that is, a temporally continuous piece of the journey that takes place on a particular vehicle (or on foot). |
| place | A Place is where a journey starts or ends, or a transit stop along the way. |
| relativeDirection | Represents a turn direction, relative to the current heading. CIRCLE_CLOCKWISE and CIRCLE_CLOCKWISE are used to represent traffic circles. |
| routerInfo | |
| routerList | |
| transportationNetworkCompanyResponse | |
| transportationNetworkCompanySummary | Simplified TNC summary included with itinerary Leg. |
| tripPlan | A TripPlan is a set of ways to get from point A to point B at time T. |
| vertexType | Represent type of vertex, used in Place aka from, to in API for easier client side localization |
| walkStep | Represents one instruction in walking directions. Three examples from New York City:
Turn onto Broadway from W 57th St (coming from 7th Ave):
Now, turn from Broadway onto Central Park S via Columbus Circle
Instead, go through the circle to continue on Broadway |
| alertPatchCreationResponse | |
| alertPatchResponse | |
| alertPatchSet | |
| localizedAlert | |
| plannerError | This API response element represents an error in trip planning. |
| bikeRentalStationList | |
| carRentalStationList | |
| debugOutput | Holds information to be included in the REST Response for debugging and profiling purposes. startedCalculating is called in the routingContext constructor. finishedCalculating and finishedRendering are all called in PlanGenerator.generate(). finishedPrecalculating and foundPaths are called in the SPTService implementations. |
| elevationMetadata | Contains elevation-specific metadata to be included in the response Created by demory on 2/16/17. |
| inspectorLayersList | |
| inspectorLayer | |
| response | Represents a trip planner response, will be serialized into XML or JSON by Jersey |
| serverInfo | |
| vehicleRentalStationList | |
| mavenVersion | |
| p2 | An ordered pair of objects of the same type |
| t2 | An ordered pair of objects of potentially different types |
| feedScopedId | |
| alert | |
| alertPatch | This adds a note to all boardings of a given route or stop (optionally, in a given direction) |
| bikeRentalStation | |
| carFuelType | |
| carRentalStation | |
| fare | Fare is a set of fares for different classes of users. |
| fareType | |
| fareComponent | FareComponent is a sequence of routes for a particular fare. |
| money | Fare support is very, very preliminary. |
| TraverseMode | |
| wrappedCurrency | A Bean wrapper class for java.util.Currency |
| arrivalTime | |
| rideEstimate | |
| transportationNetworkCompany | |
| rentalStation | |
| vehicleRentalStation | This class models a place where a rental vehicle can be returned or picked up. This class is typically used in one of 3 ways: 1. To model a docking station that may have multiple vehicles that can be rented and also parking spaces to return a rented vehicle. 2. To model a single floating vehicle that can only be picked up. 3. To model a border dropoff where the extent of vehicle rental region ends. At this point, the StreetEdge is split and a vehicle rental station is created to facilitate the dropoff of vehicles no further than the allowable dropoff area. FIXME: border dropoff stations, vertices and edges are probably not needed anymore with updated StreetEdge dropoff checks. |
| i18NString | This interface is used when providing translations on server side. |
| localizedString | This is used to localize strings for which localization are known beforehand. Those are local names for: unanamedStreet, corner of x and y, path, bike_path etc. Translations are in src/main/resources/WayProperties_lang.properties and internals_lang.properties locale is set in request. |
| nonLocalizedString | This is to support strings which can't be localized. It just returns string it is given in constructor. |
| translatedString | This is for translated strings for which translations are read from OSM or GTFS alerts. This can be translated street names, GTFS alerts and notes. |
| travelOption | This class is used to send to client which Travel Options are possible on this server This options are used in client "Travel by" drop down. Each travel option consist of two variables: - value is a value which is sent to the server if this is chosen ("TRANSIT, WALK", "CAR", etc.) - name is a name with which client can nicely name this option even if specific value changes ("TRANSIT", "PARKRIDE", "TRANSIT_BICYCLE", etc.) Travel options are created from org.opentripplanner.routing.graph.Graph transitModes variable and based if park & ride, bike & ride, bike sharing is supported. List itself is created in TravelOptionsMaker#makeOptions(HashSet, boolean, boolean, boolean) |
| encodedPolylineBean | A list of coordinates encoded as a string. See Encoded polyline algorithm format |