ProfileRequest (r5 4.6.1-SNAPSHOT API)

java.lang.Object
- com.conveyal.r5.profile.ProfileRequest

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

AnalysisTask, SpeedTestProfileRequest
```
public class ProfileRequest
extends Object
implements Serializable, Cloneable
```
All the modifiable parameters for profile routing.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`EnumSet<LegMode>`	`accessModes` The modes used to access transit
`float`	`bikeSpeed` The speed of cycling, in meters per second
`int`	`bikeTrafficStress` maximum level of traffic stress for cycling, 1 - 4
`float`	`carSpeed` The speed of driving, in meters per second.
`LocalDate`	`date` The date of the search
`EnumSet<LegMode>`	`directModes` The modes used to reach the destination without transit
`EnumSet<LegMode>`	`egressModes` The modes used to reach the destination after leaving transit
`double`	`fromLat` The latitude of the origin.
`double`	`fromLon` The longitude of the origin.
`int`	`fromTime` The beginning of the departure window, in seconds since midnight.
`InRoutingFareCalculator`	`inRoutingFareCalculator` An object that should have at a minimum a "type" set according to the list in InRoutingFareCalculator.
`int`	`limit` the maximum number of options presented PER ACCESS MODE
`int`	`maxBikeTime` Maximum bike time when using transit, in minutes
`int`	`maxCarTime` Maximum car time before when using transit, in minutes
`int`	`maxFare` Maximum fare for constraining monetary cost of paths during search in Analysis.
`int`	`maxRides` The maximum number of rides, e.g.
`int`	`maxTripDurationMinutes` The maximum duration of any trip found by this search.
`int`	`maxWalkTime` Maximum walk time before and after using transit, in minutes NB the time to reach the destination after leaving transit is considered separately from the time to reach transit at the start of the search; e.g.
`int`	`minBikeTime` Minimum time to ride a bike (to prevent extremely short bike legs), in minutes
`int`	`minCarTime` Minimum time to drive (to prevent extremely short driving legs), in minutes
`int`	`monteCarloDraws` Number of Monte Carlo draws to take for frequency searches.
`boolean`	`reverseSearch` If true current search is reverse search AKA we are looking for a path from destination to origin in reverse It differs from searchType because it is used as egress search.
`Scenario`	`scenario` A non-destructive scenario to apply when executing this request
`String`	`scenarioId` The ID of a scenario stored in S3 as JSON.
`int`	`streetTime` Maximum time to reach the destination without using transit in minutes
`int`	`suboptimalMinutes` This parameter compensates for the fact that GTFS does not contain information about schedule deviation (lateness).
`double`	`toLat` The latitude of the destination.
`double`	`toLon` The longitude of the destination.
`int`	`toTime` The end of the departure window, in seconds since midnight.
`EnumSet<TransitModes>`	`transitModes` The transit modes used
`float`	`walkSpeed` The speed of walking, in meters per second
`boolean`	`wheelchair` Require all streets and transit to be wheelchair-accessible.
`ZoneId`	`zoneId`

Constructor Summary

Constructors
Constructor and Description

ProfileRequest()

Constructors
Constructor and Description
`ProfileRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProfileRequest`	`clone()`
`static ProfileRequest`	`fromGraphqlEnvironment(graphql.schema.DataFetchingEnvironment environment, ZoneId timezone)` Factory method to create a profile request with query parameters from a GraphQL request
`long`	`getFromTimeDate()` Returns number of milliseconds UNIX time made with date and fromTime It reads date as date in transportNetwork timezone when it is converted to UNIX time it is in UTC It needs to be decided how to do this correctly: #37 If date isn't set current date is used.
`ZonedDateTime`	`getFromTimeDateZD()` Returns ZonedDateTime made with date and fromTime fields It reads date as date in transportNetwork timezone when it is converted to UNIX time it is in UTC It needs to be decided how to do this correctly: #37 If date isn't set current date is used.
`int`	`getMaxTimeSeconds(LegMode mode)`
`int`	`getMaxTimeSeconds(StreetMode mode)`
`int`	`getMinTimeSeconds(StreetMode mode)`
`int`	`getMonteCarloDrawsPerMinute()` Return the number of Monte Carlo draws that must be done each minute to get at least the desired number of total Monte Carlo draws over all minutes.
`float`	`getSpeedForMode(StreetMode streetMode)`
`int`	`getTimeWindowLengthMinutes()` Return the length of the time window in truncated integer minutes
`boolean`	`hasTransit()`
`void`	`setTime(String fromTime, String toTime)` Sets time and date from fromTime and toTime It is used in tests

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - fromLat
```
public double fromLat
```
    The latitude of the origin.
  - fromLon
```
public double fromLon
```
    The longitude of the origin.
  - toLat
```
public double toLat
```
    The latitude of the destination. Must be set even in Analyst mode.
  - toLon
```
public double toLon
```
    The longitude of the destination. Must be set even in Analyst mode.
  - fromTime
```
public int fromTime
```
    The beginning of the departure window, in seconds since midnight.
  - toTime
```
public int toTime
```
    The end of the departure window, in seconds since midnight.
  - walkSpeed
```
public float walkSpeed
```
    The speed of walking, in meters per second
  - bikeSpeed
```
public float bikeSpeed
```
    The speed of cycling, in meters per second
  - bikeTrafficStress
```
public int bikeTrafficStress
```
    maximum level of traffic stress for cycling, 1 - 4
  - carSpeed
```
public float carSpeed
```
    The speed of driving, in meters per second. Roads from OSM use the speed limit; this is the speed used when linking the street network to a pointset (i.e. it is applied between the true origin and the first street vertex, and between the last street vertex and the true destination). Note that slow speeds specified here may result in longer travel times than expected on long, high-speed blocks. But we tolerate some imprecision at the scale of individual blocks (see conversation at #436)
  - streetTime
```
public int streetTime
```
    Maximum time to reach the destination without using transit in minutes
  - maxWalkTime
```
public int maxWalkTime
```
    Maximum walk time before and after using transit, in minutes NB the time to reach the destination after leaving transit is considered separately from the time to reach transit at the start of the search; e.g. if you set maxWalkTime to 10, you could potentially walk up to ten minutes to reach transit, and up to _another_ ten minutes to reach the destination after leaving transit. This is required because hard resource limiting on non-objective variables is algorithmically invalid. Consider a case where there is a destination 10 minutes from transit and an origin 5 minutes walk from a feeder bus and 15 minutes walk from a fast train, and the walk budget is 20 minutes. If an intermediate point in the search (for example, a transfer station) is reached by the fast train before it is reached by the bus, the route using the bus will be dominated. When we leave transit, though, we have already used up 15 minutes of our walk budget and don't have enough remaining to reach the destination. This is solved by using separate walk budgets at the origin and destination. It could also be solved (although this would slow the algorithm down) by retaining all Pareto-optimal combinations of (travel time, walk distance).
  - maxBikeTime
```
public int maxBikeTime
```
    Maximum bike time when using transit, in minutes
  - maxCarTime
```
public int maxCarTime
```
    Maximum car time before when using transit, in minutes
  - minBikeTime
```
public int minBikeTime
```
    Minimum time to ride a bike (to prevent extremely short bike legs), in minutes
  - minCarTime
```
public int minCarTime
```
    Minimum time to drive (to prevent extremely short driving legs), in minutes
  - date
```
public LocalDate date
```
    The date of the search
  - limit
```
public int limit
```
    the maximum number of options presented PER ACCESS MODE
  - accessModes
```
public EnumSet<LegMode> accessModes
```
    The modes used to access transit
  - egressModes
```
public EnumSet<LegMode> egressModes
```
    The modes used to reach the destination after leaving transit
  - directModes
```
public EnumSet<LegMode> directModes
```
    The modes used to reach the destination without transit
  - transitModes
```
public EnumSet<TransitModes> transitModes
```
    The transit modes used
  - suboptimalMinutes
```
public int suboptimalMinutes
```
    This parameter compensates for the fact that GTFS does not contain information about schedule deviation (lateness). The min-max travel time range for some trains is zero, since the trips are reported to always have the same timings in the schedule. Such an option does not overlap (temporally) its alternatives, and is too easily eliminated by an alternative that is only marginally better. We want to effectively push the max travel time of alternatives out a bit to account for the fact that they don't always run on schedule.
  - maxTripDurationMinutes
```
public int maxTripDurationMinutes
```
    The maximum duration of any trip found by this search.
  - maxRides
```
public int maxRides
```
    The maximum number of rides, e.g. taking the L2 to the Red line to the Green line would be three rides.
  - scenario
```
public Scenario scenario
```
    A non-destructive scenario to apply when executing this request
  - scenarioId
```
public String scenarioId
```
    The ID of a scenario stored in S3 as JSON. You must specify one (but only one) of scenario or scenarioId. It is an error if both scenario and the scenarioId are specified.
  - zoneId
```
public ZoneId zoneId
```
  - wheelchair
```
public boolean wheelchair
```
    Require all streets and transit to be wheelchair-accessible. This is not fully implemented and doesn't work at all in Analysis (FastRaptorWorker), only in Modeify (McRaptorSuboptimalPathProfileRouter).
  - reverseSearch
```
public boolean reverseSearch
```
    If true current search is reverse search AKA we are looking for a path from destination to origin in reverse It differs from searchType because it is used as egress search. Note that NON_DEFAULT allows the broker to talk to older workers.
  - maxFare
```
public int maxFare
```
    Maximum fare for constraining monetary cost of paths during search in Analysis. If nonnegative, fares will be used in routing.
  - inRoutingFareCalculator
```
public InRoutingFareCalculator inRoutingFareCalculator
```
    An object that should have at a minimum a "type" set according to the list in InRoutingFareCalculator.
  - monteCarloDraws
```
public int monteCarloDraws
```
    Number of Monte Carlo draws to take for frequency searches. We loop over all departure minutes and do a search on the scheduled portion of the network, and then while holding the departure minute and scheduled search results stable, we run several Monte Carlo searches with randomized frequency schedules that minute. The number of Monte Carlo draws does not need to be particularly high as it happens each minute, and there is likely a lot of repetition in the scheduled service (i.e. many minutes look like each other), so several minutes' Monte Carlo draws are effectively pooled. FastRaptorWorker divides up the number of draws into an equal number at each minute of the time window, then rounds up. Note that the algorithm may actually take somewhat more draws than this, depending on the width of your time window. As an extreme example, if your time window is 120 minutes and you request 121 draws, you will actually get 240, because 1 < 121 / 120 < 2. McRaptor worker samples departure times, repeating a random walk over the departure time window until a sample with exactly this number of departure times is generated.
- Constructor Detail
  - ProfileRequest
```
public ProfileRequest()
```
- Method Detail
  - clone
```
public ProfileRequest clone()
```
    Overrides:
    
    clone in class Object
  - getFromTimeDate
```
public long getFromTimeDate()
```
    Returns number of milliseconds UNIX time made with date and fromTime It reads date as date in transportNetwork timezone when it is converted to UNIX time it is in UTC It needs to be decided how to do this correctly: #37 If date isn't set current date is used. Time is empty (one hour before midnight in UTC if +1 timezone is used) uses getFromTimeDateZD()
  - getFromTimeDateZD
```
public ZonedDateTime getFromTimeDateZD()
```
    Returns ZonedDateTime made with date and fromTime fields It reads date as date in transportNetwork timezone when it is converted to UNIX time it is in UTC It needs to be decided how to do this correctly: #37 If date isn't set current date is used. Time is empty (one hour before midnight in UTC if +1 timezone is used)
  - getSpeedForMode
```
public float getSpeedForMode(StreetMode streetMode)
```
    Returns:
    
    the speed at which the given mode will traverse street edges, in floating point meters per second.
  - getMaxTimeSeconds
```
public int getMaxTimeSeconds(StreetMode mode)
```
    Returns:
    
    the maximum travel time on a single leg for the given mode in integer seconds.
  - hasTransit
```
public boolean hasTransit()
```
    Returns:
    
    true if there is any transitMode in transitModes (Safe to call if transitModes is null)
  - fromGraphqlEnvironment
```
public static ProfileRequest fromGraphqlEnvironment(graphql.schema.DataFetchingEnvironment environment,
                                                    ZoneId timezone)
```
    Factory method to create a profile request with query parameters from a GraphQL request
  - setTime
```
public void setTime(String fromTime,
                    String toTime)
```
    Sets time and date from fromTime and toTime It is used in tests
    
    Parameters:
    
    fromTime - The beginning of the departure window, in ISO 8061 YYYY-MM-DDTHH:MM:SS+HH:MM
    
    toTime - The end of the departure window, in ISO 8061 YYYY-MM-DDTHH:MM:SS+HH:MM
  - getMaxTimeSeconds
```
public int getMaxTimeSeconds(LegMode mode)
```
    Returns:
    
    maximum time in integer seconds that may be spent on a leg using the given mode
  - getMinTimeSeconds
```
public int getMinTimeSeconds(StreetMode mode)
```
    Returns:
    
    min number of seconds that the specified mode should be used to get to stop/Park ride/bike share etc. defaults to zero for modes other than CAR or BICYCLE.
  - getTimeWindowLengthMinutes
```
public int getTimeWindowLengthMinutes()
```
    Return the length of the time window in truncated integer minutes
  - getMonteCarloDrawsPerMinute
```
public int getMonteCarloDrawsPerMinute()
```
    Return the number of Monte Carlo draws that must be done each minute to get at least the desired number of total Monte Carlo draws over all minutes.

Class ProfileRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fromLat

fromLon

toLat

toLon

fromTime

toTime

walkSpeed

bikeSpeed

bikeTrafficStress

carSpeed

streetTime

maxWalkTime

maxBikeTime

maxCarTime

minBikeTime

minCarTime

date

limit

accessModes

egressModes

directModes

transitModes

suboptimalMinutes

maxTripDurationMinutes

maxRides

scenario

scenarioId

zoneId

wheelchair

reverseSearch

maxFare

inRoutingFareCalculator

monteCarloDraws

Constructor Detail

ProfileRequest

Method Detail

clone

getFromTimeDate

getFromTimeDateZD

getSpeedForMode

getMaxTimeSeconds

hasTransit

fromGraphqlEnvironment

setTime

getMaxTimeSeconds

getMinTimeSeconds

getTimeWindowLengthMinutes

getMonteCarloDrawsPerMinute