com.conveyal.r5.analyst.scenario

Class SetFareCalculator

java.lang.Object

com.conveyal.r5.analyst.scenario.Modification

com.conveyal.r5.analyst.scenario.SetFareCalculator

All Implemented Interfaces:

Serializable

public class SetFareCalculator
extends Modification

Set the fare calculator on a transport network.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
InRoutingFareCalculator	fareCalculator

Fields inherited from class com.conveyal.r5.analyst.scenario.Modification

activeInVariants, comment, errors, warnings

Constructor Summary

Constructors

Constructor and Description
SetFareCalculator()

Method Summary

Modifier and Type	Method and Description
boolean	apply(TransportNetwork network) Apply this single modification to a TransportNetwork.
int	getSortOrder() This determines the sequence in which modifications will be applied.

Methods inherited from class com.conveyal.r5.analyst.scenario.Modification

affectsStreetLayer, affectsTransitLayer, checkIds, findOrCreateStops, resolve

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fareCalculator

public InRoutingFareCalculator fareCalculator

Constructor Detail

SetFareCalculator

public SetFareCalculator()

Method Detail

apply

public boolean apply(TransportNetwork network)

Description copied from class: Modification

Apply this single modification to a TransportNetwork. The TransportNetwork should be pre-cloned by the caller, but may still contain references to collections or other deep objects from the original TransportNetwork. The Modification is responsible for ensuring that no damage is done to the original TransportNetwork by making copies of referenced objects as necessary. TODO arguably this and resolve() don't need to return booleans - all implementations just check whether the errors list is empty, so we could just supply a method that does that. TODO remove the network field, and use the network against which this Modification was resolved.

Specified by:

apply in class Modification

Returns:

true if any errors happened while applying the modification.

getSortOrder

public int getSortOrder()

Description copied from class: Modification

This determines the sequence in which modifications will be applied. It is used in a standard compare function, so lower numbered modifications will be applied before higher ones. Typical values are 10 through 100.

Specified by:

getSortOrder in class Modification