State (OpenTripPlanner 1.3.0 API)

java.lang.Object
- org.opentripplanner.routing.core.State

All Implemented Interfaces:: Cloneable

public class State
extends Object
implements Cloneable

Field Summary

Fields
Modifier and Type	Field and Description
`Edge`	`backEdge`
`protected State`	`backState`
`protected State`	`next`
`protected int[]`	`pathParserStates`
`StateData`	`stateData`
`protected long`	`time`
`protected Vertex`	`vertex`
`double`	`walkDistance`
`double`	`weight`

Constructor Summary

Constructors
Constructor and Description
`State(RoutingRequest opt)` Create an initial state representing the beginning of a search for the given routing context.
`State(Vertex vertex, Edge backEdge, long timeSeconds, long startTime, RoutingRequest options)` Create an initial state, forcing vertex, back edge, time and start time to the specified values.
`State(Vertex vertex, Edge backEdge, long timeSeconds, RoutingRequest options)` Create an initial state, forcing vertex, back edge and time to the specified values.
`State(Vertex vertex, long timeSeconds, RoutingRequest options)` Create an initial state, forcing vertex and time to the specified values.
`State(Vertex vertex, RoutingRequest opt)` Create an initial state, forcing vertex to the specified value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`State`	`addToExistingResultChain(State existingResultChain)` Extend an exiting result chain by appending this result to the existing chain.
`void`	`checkNegativeWeight()`
`protected State`	`clone()`
`State`	`detachNextResult()`
`void`	`dumpPath()`
`StateEditor`	`edit(Edge e)` Create a state editor to produce a child of this state, which will be the result of traversing the given edge.
`boolean`	`exceedsWeightLimit(double maxWeight)`
`int`	`getAbsTimeDeltaSeconds()`
`long`	`getActiveTime()` Returns the length of the trip in seconds up to this time, not including the initial wait.
`String`	`getBackDirection()` Get the name of the direction used to get to this state.
`Edge`	`getBackEdge()`
`TraverseMode`	`getBackMode()`
`State`	`getBackState()`
`org.onebusaway.gtfs.model.Trip`	`getBackTrip()` Get the back trip of the given state.
`Set<String>`	`getBikeRentalNetworks()`
`RoutingContext`	`getContext()`
`long`	`getElapsedTimeSeconds()` returns the length of the trip in seconds up to this state
`Object`	`getExtension(Object key)` Retrieve a State extension based on its key.
`long`	`getLastAlightedTimeSeconds()`
`int`	`getLastNextArrivalDelta()`
`TripPattern`	`getLastPattern()`
`State`	`getNextResult()` Optional next result that allows `Edge` to return multiple results.
`TraverseMode`	`getNonTransitMode()` This method is on State rather than RoutingRequest because we care whether the user is in possession of a rented bike.
`int`	`getNumBoardings()`
`double`	`getOptimizedElapsedTimeSeconds()`
`RoutingRequest`	`getOptions()`
`String`	`getPathParserStates()`
`int`	`getPreTransitTime()`
`int`	`getPreTransitTimeDelta()`
`org.onebusaway.gtfs.model.Stop`	`getPreviousStop()`
`org.onebusaway.gtfs.model.Trip`	`getPreviousTrip()`
`boolean`	`getReverseOptimizing()`
`org.onebusaway.gtfs.model.AgencyAndId`	`getRoute()`
`ServiceDay`	`getServiceDay()`
`long`	`getStartTimeSeconds()`
`int`	`getTimeDeltaSeconds()`
`long`	`getTimeInMillis()`
`long`	`getTimeSeconds()` Returns time in seconds since epoch
`org.onebusaway.gtfs.model.AgencyAndId`	`getTripId()`
`TripTimes`	`getTripTimes()`
`Vertex`	`getVertex()`
`double`	`getWalkAtLastTransit()`
`double`	`getWalkDistance()`
`double`	`getWalkDistanceDelta()`
`double`	`getWalkSinceLastTransit()`
`double`	`getWeight()`
`double`	`getWeightDelta()`
`String`	`getZone()`
`boolean`	`hasEnteredNoThruTrafficArea()`
`boolean`	`isBackWalkingBike()`
`boolean`	`isBikeParked()`
`boolean`	`isBikeRenting()`
`boolean`	`isCarParked()`
`boolean`	`isEverBoarded()` Whether this path has ever previously boarded (or alighted from, in a reverse search) a transit vehicle
`boolean`	`isFinal()`
`boolean`	`isOnboard()`
`boolean`	`multipleOptionsBefore()`
`State`	`optimize()` Reverse-optimize a path after it is complete, by default
`State`	`optimizeOrReverse(boolean optimize, boolean forward)` Reverse the path implicit in the given state, re-traversing all edges in the opposite direction so as to remove any unnecessary waiting in the resulting itinerary.
`State`	`reverse()` Reverse a path
`State`	`reversedClone()`
`boolean`	`routeSequencePrefix(State that)`
`boolean`	`routeSequenceSubset(State that)`
`boolean`	`routeSequenceSubsetSymmetric(State that)`
`boolean`	`routeSequenceSuperset(State that)`
`String`	`toString()`
`String`	`toStringVerbose()`

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

- Field Detail
  - time
```
protected long time
```
  - weight
```
public double weight
```
  - vertex
```
protected Vertex vertex
```
  - backState
```
protected State backState
```
  - backEdge
```
public Edge backEdge
```
  - next
```
protected State next
```
  - stateData
```
public StateData stateData
```
  - walkDistance
```
public double walkDistance
```
  - pathParserStates
```
protected int[] pathParserStates
```
- Constructor Detail
  - State
```
public State(RoutingRequest opt)
```
    Create an initial state representing the beginning of a search for the given routing context. Initial "parent-less" states can only be created at the beginning of a trip. elsewhere, all states must be created from a parent and associated with an edge.
  - State
```
public State(Vertex vertex,
             RoutingRequest opt)
```
    Create an initial state, forcing vertex to the specified value. Useful for reusing a RoutingContext in TransitIndex, tests, etc.
  - State
```
public State(Vertex vertex,
             long timeSeconds,
             RoutingRequest options)
```
    Create an initial state, forcing vertex and time to the specified values. Useful for reusing a RoutingContext in TransitIndex, tests, etc.
  - State
```
public State(Vertex vertex,
             Edge backEdge,
             long timeSeconds,
             RoutingRequest options)
```
    Create an initial state, forcing vertex, back edge and time to the specified values. Useful for reusing a RoutingContext in TransitIndex, tests, etc.
  - State
```
public State(Vertex vertex,
             Edge backEdge,
             long timeSeconds,
             long startTime,
             RoutingRequest options)
```
    Create an initial state, forcing vertex, back edge, time and start time to the specified values. Useful for starting a multiple initial state search, for example when propagating profile results to the street network in RoundBasedProfileRouter.
- Method Detail
  - edit
```
public StateEditor edit(Edge e)
```
    Create a state editor to produce a child of this state, which will be the result of traversing the given edge.
    
    Parameters:
    
    e -
    
    Returns:
  - clone
```
protected State clone()
```
    Overrides:
    
    clone in class Object
  - getExtension
```
public Object getExtension(Object key)
```
    Retrieve a State extension based on its key.
    
    Parameters:
    
    key - - An Object that is a key in this State's extension map
    
    Returns:
    
    - The extension value for the given key, or null if not present
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringVerbose
```
public String toStringVerbose()
```
  - getTimeSeconds
```
public long getTimeSeconds()
```
    Returns time in seconds since epoch
  - getElapsedTimeSeconds
```
public long getElapsedTimeSeconds()
```
    returns the length of the trip in seconds up to this state
  - getTripTimes
```
public TripTimes getTripTimes()
```
  - getActiveTime
```
public long getActiveTime()
```
    Returns the length of the trip in seconds up to this time, not including the initial wait. It subtracts out the initial wait, up to a clamp value specified in the request. If the clamp value is set to -1, no clamping will occur. If the clamp value is set to 0, the initial wait time will not be subtracted out (i.e. it will be clamped to zero). This is used in lieu of reverse optimization in Analyst.
  - getTripId
```
public org.onebusaway.gtfs.model.AgencyAndId getTripId()
```
  - getPreviousTrip
```
public org.onebusaway.gtfs.model.Trip getPreviousTrip()
```
  - getZone
```
public String getZone()
```
  - getRoute
```
public org.onebusaway.gtfs.model.AgencyAndId getRoute()
```
  - getNumBoardings
```
public int getNumBoardings()
```
  - isEverBoarded
```
public boolean isEverBoarded()
```
    Whether this path has ever previously boarded (or alighted from, in a reverse search) a transit vehicle
  - isBikeRenting
```
public boolean isBikeRenting()
```
  - isCarParked
```
public boolean isCarParked()
```
  - isBikeParked
```
public boolean isBikeParked()
```
  - isFinal
```
public boolean isFinal()
```
    Returns:
    
    True if the state at vertex can be the end of path.
  - getPreviousStop
```
public org.onebusaway.gtfs.model.Stop getPreviousStop()
```
  - getLastAlightedTimeSeconds
```
public long getLastAlightedTimeSeconds()
```
  - getWalkDistance
```
public double getWalkDistance()
```
  - getPreTransitTime
```
public int getPreTransitTime()
```
  - getVertex
```
public Vertex getVertex()
```
  - getLastNextArrivalDelta
```
public int getLastNextArrivalDelta()
```
  - getWeight
```
public double getWeight()
```
  - getTimeDeltaSeconds
```
public int getTimeDeltaSeconds()
```
  - getAbsTimeDeltaSeconds
```
public int getAbsTimeDeltaSeconds()
```
  - getWalkDistanceDelta
```
public double getWalkDistanceDelta()
```
  - getPreTransitTimeDelta
```
public int getPreTransitTimeDelta()
```
  - getWeightDelta
```
public double getWeightDelta()
```
  - checkNegativeWeight
```
public void checkNegativeWeight()
```
  - isOnboard
```
public boolean isOnboard()
```
  - getBackState
```
public State getBackState()
```
  - getBackMode
```
public TraverseMode getBackMode()
```
  - isBackWalkingBike
```
public boolean isBackWalkingBike()
```
  - getBackDirection
```
public String getBackDirection()
```
    Get the name of the direction used to get to this state. For transit, it is the headsign, while for other things it is what you would expect.
  - getBackTrip
```
public org.onebusaway.gtfs.model.Trip getBackTrip()
```
    Get the back trip of the given state. For time dependent transit, State will find the right thing to do.
  - getBackEdge
```
public Edge getBackEdge()
```
  - exceedsWeightLimit
```
public boolean exceedsWeightLimit(double maxWeight)
```
  - getStartTimeSeconds
```
public long getStartTimeSeconds()
```
  - getNextResult
```
public State getNextResult()
```
    Optional next result that allows Edge to return multiple results.
    
    Returns:
    
    the next additional result from an edge traversal, or null if no more results
  - addToExistingResultChain
```
public State addToExistingResultChain(State existingResultChain)
```
    Extend an exiting result chain by appending this result to the existing chain. The usage model looks like this: TraverseResult result = null; for( ... ) { TraverseResult individualResult = ...; result = individualResult.addToExistingResultChain(result); } return result;
    
    Parameters:
    
    existingResultChain - the tail of an existing result chain, or null if the chain has not been started
    
    Returns:
  - detachNextResult
```
public State detachNextResult()
```
  - getContext
```
public RoutingContext getContext()
```
  - getOptions
```
public RoutingRequest getOptions()
```
  - getNonTransitMode
```
public TraverseMode getNonTransitMode()
```
    This method is on State rather than RoutingRequest because we care whether the user is in possession of a rented bike.
    
    Returns:
    
    BICYCLE if routing with an owned bicycle, or if at this state the user is holding on to a rented bicycle.
  - reversedClone
```
public State reversedClone()
```
  - dumpPath
```
public void dumpPath()
```
  - getTimeInMillis
```
public long getTimeInMillis()
```
  - routeSequencePrefix
```
public boolean routeSequencePrefix(State that)
```
  - routeSequenceSubsetSymmetric
```
public boolean routeSequenceSubsetSymmetric(State that)
```
  - routeSequenceSubset
```
public boolean routeSequenceSubset(State that)
```
  - routeSequenceSuperset
```
public boolean routeSequenceSuperset(State that)
```
  - getWalkSinceLastTransit
```
public double getWalkSinceLastTransit()
```
  - getWalkAtLastTransit
```
public double getWalkAtLastTransit()
```
  - multipleOptionsBefore
```
public boolean multipleOptionsBefore()
```
  - getPathParserStates
```
public String getPathParserStates()
```
  - getLastPattern
```
public TripPattern getLastPattern()
```
    Returns:
    
    the last TripPattern used in this path (which is set when leaving the vehicle).
  - getServiceDay
```
public ServiceDay getServiceDay()
```
  - getBikeRentalNetworks
```
public Set<String> getBikeRentalNetworks()
```
  - optimizeOrReverse
```
public State optimizeOrReverse(boolean optimize,
                               boolean forward)
```
    Reverse the path implicit in the given state, re-traversing all edges in the opposite direction so as to remove any unnecessary waiting in the resulting itinerary. This produces a path that passes through all the same edges, but which may have a shorter overall duration due to different weights on time-dependent (e.g. transit boarding) edges. If the optimize parameter is false, the path will be reversed but will have the same duration. This is the result of combining the functions from GraphPath optimize and reverse.
    
    Parameters:
    
    optimize - Should this path be optimized or just reversed?
    
    forward - Is this an on-the-fly reverse search in the midst of a forward search?
  - optimize
```
public State optimize()
```
    Reverse-optimize a path after it is complete, by default
  - reverse
```
public State reverse()
```
    Reverse a path
  - getReverseOptimizing
```
public boolean getReverseOptimizing()
```
  - getOptimizedElapsedTimeSeconds
```
public double getOptimizedElapsedTimeSeconds()
```
  - hasEnteredNoThruTrafficArea
```
public boolean hasEnteredNoThruTrafficArea()
```

Class State

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

time

weight

vertex

backState

backEdge

next

stateData

walkDistance

pathParserStates

Constructor Detail

State

State

State

State

State

Method Detail

edit

clone

getExtension

toString

toStringVerbose

getTimeSeconds

getElapsedTimeSeconds

getTripTimes

getActiveTime

getTripId

getPreviousTrip

getZone

getRoute

getNumBoardings

isEverBoarded

isBikeRenting

isCarParked

isBikeParked

isFinal

getPreviousStop

getLastAlightedTimeSeconds

getWalkDistance

getPreTransitTime

getVertex

getLastNextArrivalDelta

getWeight

getTimeDeltaSeconds

getAbsTimeDeltaSeconds

getWalkDistanceDelta

getPreTransitTimeDelta

getWeightDelta

checkNegativeWeight

isOnboard

getBackState

getBackMode

isBackWalkingBike

getBackDirection

getBackTrip

getBackEdge

exceedsWeightLimit

getStartTimeSeconds

getNextResult

addToExistingResultChain

detachNextResult

getContext

getOptions

getNonTransitMode

reversedClone

dumpPath

getTimeInMillis

routeSequencePrefix

routeSequenceSubsetSymmetric

routeSequenceSubset

routeSequenceSuperset

getWalkSinceLastTransit

getWalkAtLastTransit

multipleOptionsBefore

getPathParserStates