org.opentrafficsim.road.gtu.strategical.od

Class ODMatrix

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ODMatrixTrips

public class ODMatrix
extends Object
implements Serializable

The minimal OD matrix has 1 origin, 1 destination and 1 time period. More of each can be used. Further categorization of data is possible, i.e. for origin O to destination D, for lane L, for route R and for vehicle class C, the demand at time T is D. The further categorization is defined by an array of Class's that define the categorization.

Copyright (c) 2013-2017 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 15, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ODMatrix(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.

Method Summary

Modifier and Type	Method and Description
boolean	contains(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category)
boolean	equals(Object obj)
Set<Category>	getCategories(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination) Returns the categories specified for given origin-destination combination.
Categorization	getCategorization()
org.djunits.value.vdouble.scalar.Frequency	getDemand(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category, org.djunits.value.vdouble.scalar.Duration time) Returns the demand at given time.
org.djunits.value.vdouble.vector.FrequencyVector	getDemandVector(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category)
List<org.opentrafficsim.core.network.Node>	getDestinations()
Interpolation	getGlobalInterpolation()
org.djunits.value.vdouble.vector.DurationVector	getGlobalTimeVector()
String	getId()
Interpolation	getInterpolation(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category)
List<org.opentrafficsim.core.network.Node>	getOrigins()
org.djunits.value.vdouble.vector.DurationVector	getTimeVector(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category)
int	hashCode()
static void	main(String[] args)
void	print() Prints the complete OD matrix with each demand data on a single line.
void	putDemandVector(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category, org.djunits.value.vdouble.vector.FrequencyVector demand)
void	putDemandVector(org.opentrafficsim.core.network.Node origin, org.opentrafficsim.core.network.Node destination, Category category, org.djunits.value.vdouble.vector.FrequencyVector demand, org.djunits.value.vdouble.vector.DurationVector timeVector, Interpolation interpolation)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ODMatrix

public ODMatrix(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.

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

getId

public final String getId()

Returns:

id.

getOrigins

public final List<org.opentrafficsim.core.network.Node> getOrigins()

Returns:

origins.

getDestinations

public final List<org.opentrafficsim.core.network.Node> getDestinations()

Returns:

destinations.

getCategorization

public final Categorization getCategorization()

Returns:

categorization.

getGlobalTimeVector

public final org.djunits.value.vdouble.vector.DurationVector getGlobalTimeVector()

Returns:

globalTimeVector.

getGlobalInterpolation

public final Interpolation getGlobalInterpolation()

Returns:

globalInterpolation.

putDemandVector

public final void putDemandVector(org.opentrafficsim.core.network.Node origin,
                                  org.opentrafficsim.core.network.Node destination,
                                  Category category,
                                  org.djunits.value.vdouble.vector.FrequencyVector demand)

Parameters:

origin - origin

destination - destination

category - category

demand - demand data, length has to be equal to the global 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

putDemandVector

public final void putDemandVector(org.opentrafficsim.core.network.Node origin,
                                  org.opentrafficsim.core.network.Node destination,
                                  Category category,
                                  org.djunits.value.vdouble.vector.FrequencyVector demand,
                                  org.djunits.value.vdouble.vector.DurationVector timeVector,
                                  Interpolation interpolation)

Parameters:

origin - origin

destination - destination

category - category

demand - demand data, length has to be equal to the time vector

timeVector - time vector

interpolation - interpolation

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

getDemandVector

public final org.djunits.value.vdouble.vector.FrequencyVector getDemandVector(org.opentrafficsim.core.network.Node origin,
                                                                              org.opentrafficsim.core.network.Node destination,
                                                                              Category category)

Parameters:

origin - origin

destination - destination

category - category

Returns:

demand 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

getTimeVector

public final org.djunits.value.vdouble.vector.DurationVector getTimeVector(org.opentrafficsim.core.network.Node origin,
                                                                           org.opentrafficsim.core.network.Node destination,
                                                                           Category category)

Parameters:

origin - origin

destination - destination

category - category

Returns:

interpolation 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

getInterpolation

public final Interpolation getInterpolation(org.opentrafficsim.core.network.Node origin,
                                            org.opentrafficsim.core.network.Node destination,
                                            Category category)

Parameters:

origin - origin

destination - destination

category - category

Returns:

interpolation 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

getDemand

public final org.djunits.value.vdouble.scalar.Frequency getDemand(org.opentrafficsim.core.network.Node origin,
                                                                  org.opentrafficsim.core.network.Node destination,
                                                                  Category category,
                                                                  org.djunits.value.vdouble.scalar.Duration time)

Returns the demand at given time. If given time is before the first time slice or after the last time slice, 0 demand is returned.

Parameters:

origin - origin

destination - destination

category - category

time - time

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

NullPointerException - if an input is null

contains

public final boolean contains(org.opentrafficsim.core.network.Node origin,
                              org.opentrafficsim.core.network.Node destination,
                              Category category)

Parameters:

origin - origin

destination - destination

category - category

Returns:

whether there is data for the specified origin, destination and category

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

getCategories

public final Set<Category> getCategories(org.opentrafficsim.core.network.Node origin,
                                         org.opentrafficsim.core.network.Node destination)

Returns the categories specified for given origin-destination combination.

Parameters:

origin - origin

destination - destination

Returns:

categories specified 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 String toString()

Overrides:

toString in class Object

print

public final void print()

Prints the complete OD matrix with each demand data on a single line.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

main

public static void main(String[] args)
                 throws org.djunits.value.ValueException,
                        org.opentrafficsim.core.network.NetworkException

Throws:

org.djunits.value.ValueException

org.opentrafficsim.core.network.NetworkException