org.opentrafficsim.road.gtu.strategical.od

Class ODMatrixTrips

java.lang.Object

org.opentrafficsim.road.gtu.strategical.od.ODMatrix

org.opentrafficsim.road.gtu.strategical.od.ODMatrixTrips

All Implemented Interfaces:

Serializable

public class ODMatrixTrips
extends ODMatrix

Extension of ODMatrix where all input and output can be given in number of trips. All data that is defined in number of trips has Interpolation.STEPWISE.

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Sep 28, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ODMatrixTrips(String id, List<org.opentrafficsim.core.network.Node> origins, List<org.opentrafficsim.core.network.Node> destinations, Categorization categorization, org.djunits.value.vdouble.vector.DurationVector globalTimeVector, Interpolation globalInterpolation) Constructs an OD matrix based on trips.

Method Summary

Modifier and Type	Method and Description
int	destinationTotal(org.opentrafficsim.core.network.Node destination) Calculates total number of trips over time for given destination.
int	getTrips(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category, int periodIndex) Returns the number of trips in the given time period.
int[]	getTripsVector(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category)
void	increaseTrips(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category, int periodIndex, int trips) Adds a number of trips to given origin-destination combination, category and time period.
int	matrixTotal() Calculates total number of trips over time for the complete matrix.
int	originDestinationTotal(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination) Calculates total number of trips over time for given origin-destination combination.
int	originTotal(org.opentrafficsim.core.network.Node origin) Calculates total number of trips over time for given origin.
void	putTripsVector(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category, int[] trips)
void	putTripsVector(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category, int[] trips, org.djunits.value.vdouble.vector.DurationVector timeVector) Sets demand data by number of trips.
String	toString()

Methods inherited from class org.opentrafficsim.road.gtu.strategical.od.ODMatrix

contains, equals, getCategories, getCategorization, getDemand, getDemandVector, getDestinations, getGlobalInterpolation, getGlobalTimeVector, getId, getInterpolation, getOrigins, getTimeVector, hashCode, main, print, putDemandVector, putDemandVector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ODMatrixTrips

public ODMatrixTrips(String id,
                     List<org.opentrafficsim.core.network.Node> origins,
                     List<org.opentrafficsim.core.network.Node> destinations,
                     Categorization categorization,
                     org.djunits.value.vdouble.vector.DurationVector globalTimeVector,
                     Interpolation globalInterpolation)

Constructs an OD matrix based on trips.

Parameters:

id - id

origins - origin nodes

destinations - destination nodes

categorization - categorization of data

globalTimeVector - default time

globalInterpolation - interpolation of demand data

Throws:

NullPointerException - if any input is null

Method Detail

putTripsVector

public final void putTripsVector(org.opentrafficsim.core.network.Node origin,
                                 org.opentrafficsim.core.network.Node destination,
                                 Category category,
                                 int[] trips)

Parameters:

origin - origin

destination - destination

category - category

trips - trip data, length has to be equal to the global time vector - 1

Throws:

IllegalArgumentException - if origin or destination is not part of the OD matrix

IllegalArgumentException - if the category does not belong to the categorization

NullPointerException - if an input is null

putTripsVector

public final void putTripsVector(org.opentrafficsim.core.network.Node origin,
                                 org.opentrafficsim.core.network.Node destination,
                                 Category category,
                                 int[] trips,
                                 org.djunits.value.vdouble.vector.DurationVector timeVector)

Sets demand data by number of trips. Interpolation over time is stepwise.

Parameters:

origin - origin

destination - destination

category - category

trips - trip data, length has to be equal to the time vector - 1

timeVector - time vector

Throws:

IllegalArgumentException - if origin or destination is not part of the OD matrix

IllegalArgumentException - if the category does not belong to the categorization

NullPointerException - if an input is null

getTripsVector

public final int[] getTripsVector(org.opentrafficsim.core.network.Node origin,
                                  org.opentrafficsim.core.network.Node destination,
                                  Category category)

Parameters:

origin - origin

destination - destination

category - category

Returns:

trip data for given origin, destination and categorization, null if no data is given

Throws:

IllegalArgumentException - if origin or destination is not part of the OD matrix

IllegalArgumentException - if the category does not belong to the categorization

NullPointerException - if an input is null

getTrips

public final int getTrips(org.opentrafficsim.core.network.Node origin,
                          org.opentrafficsim.core.network.Node destination,
                          Category category,
                          int periodIndex)

Returns the number of trips in the given time period.

Parameters:

origin - origin

destination - destination

category - category

periodIndex - index of time period

Returns:

demand for given origin, destination and categorization, at given time

Throws:

IllegalArgumentException - if origin or destination is not part of the OD matrix

IllegalArgumentException - if the category does not belong to the categorization

IllegalArgumentException - if the period is outside of the specified range

NullPointerException - if an input is null

increaseTrips

public final void increaseTrips(org.opentrafficsim.core.network.Node origin,
                                org.opentrafficsim.core.network.Node destination,
                                Category category,
                                int periodIndex,
                                int trips)

Adds a number of trips to given origin-destination combination, category and time period. This can only be done for data with stepwise interpolation.

Parameters:

origin - origin

destination - destination

category - category

periodIndex - index of time period

trips - trips to add (may be negative)

Throws:

IllegalArgumentException - if origin or destination is not part of the OD matrix

IllegalArgumentException - if the category does not belong to the categorization

IllegalArgumentException - if the period is outside of the specified range

UnsupportedOperationException - if the interpolation of the data is not stepwise

NullPointerException - if an input is null

originTotal

public final int originTotal(org.opentrafficsim.core.network.Node origin)

Calculates total number of trips over time for given origin.

Parameters:

origin - origin

Returns:

total number of trips over time for given origin

Throws:

IllegalArgumentException - if origin is not part of the OD matrix

NullPointerException - if origin is null

destinationTotal

public final int destinationTotal(org.opentrafficsim.core.network.Node destination)

Calculates total number of trips over time for given destination.

Parameters:

destination - destination

Returns:

total number of trips over time for given destination

Throws:

IllegalArgumentException - if destination is not part of the OD matrix

NullPointerException - if destination is null

matrixTotal

public final int matrixTotal()

Calculates total number of trips over time for the complete matrix.

Returns:

total number of trips over time for the complete matrix

originDestinationTotal

public final int originDestinationTotal(org.opentrafficsim.core.network.Node origin,
                                        org.opentrafficsim.core.network.Node destination)

Calculates total number of trips over time for given origin-destination combination.

Parameters:

origin - origin

destination - destination

Returns:

total number of trips over time for given origin-destination combination

Throws:

IllegalArgumentException - if origin or destination is not part of the OD matrix

NullPointerException - if an input is null

toString

public final String toString()

Overrides:

toString in class ODMatrix