org.opentrafficsim.road.network.factory.xml.demand

Class XmlOdParser

java.lang.Object

org.opentrafficsim.road.network.factory.xml.demand.XmlOdParser

All Implemented Interfaces:

Serializable

public class XmlOdParser
extends Object
implements Serializable

OD parser.

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 25 mei 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Map<String,CategoryTag>	categories Categories.
(package private) org.opentrafficsim.road.gtu.strategical.od.Categorization	categorization Categorization.
(package private) org.opentrafficsim.core.gtu.NestedCache<Set<DemandTag>>	demand Demand.
(package private) org.opentrafficsim.road.gtu.strategical.od.Interpolation	globalInterpolation Global interpolation.
(package private) org.djunits.value.vdouble.vector.TimeVector	globalTime Global time vector.
(package private) org.opentrafficsim.core.network.OTSNetwork	network Network.

Constructor Summary

Constructors

Constructor and Description
XmlOdParser(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, org.opentrafficsim.core.network.OTSNetwork network, Set<org.opentrafficsim.core.gtu.GTUType> gtuTypes) Constructor.

Method Summary

Modifier and Type	Method and Description
void	apply(InputStream stream) Applies demand from stream.
void	apply(InputStream stream, org.opentrafficsim.road.gtu.generator.od.ODOptions odOptions) Applies demand from stream using OD options.
void	apply(Node xmlNode) Applies demand from xml node.
void	apply(Node xmlNode, org.opentrafficsim.road.gtu.generator.od.ODOptions odOptions) Applies demand from URL using OD options.
void	apply(URL url) Applies demand from URL.
void	apply(URL url, org.opentrafficsim.road.gtu.generator.od.ODOptions odOptions) Applies demand from URL using OD options.
org.opentrafficsim.road.gtu.strategical.od.ODMatrix	build(InputStream stream) Build demand from stream.
org.opentrafficsim.road.gtu.strategical.od.ODMatrix	build(Node xmlNode) Build demand from xml node.
org.opentrafficsim.road.gtu.strategical.od.ODMatrix	build(URL url) Build demand from URL.
org.opentrafficsim.core.gtu.GTUType	getGTUType(String id) Returns the GTU type for the given id.
(package private) static Double	nullMultiply(Double d1, Double d2) Returns the multiplication of two values, taking 1.0 for null and returning null if both null.

Methods inherited from class java.lang.Object

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

Field Detail

network

final org.opentrafficsim.core.network.OTSNetwork network

Network.

categorization

org.opentrafficsim.road.gtu.strategical.od.Categorization categorization

Categorization.

categories

Map<String,CategoryTag> categories

Categories.

globalTime

org.djunits.value.vdouble.vector.TimeVector globalTime

Global time vector.

globalInterpolation

org.opentrafficsim.road.gtu.strategical.od.Interpolation globalInterpolation

Global interpolation.

demand

org.opentrafficsim.core.gtu.NestedCache<Set<DemandTag>> demand

Demand.

Constructor Detail

XmlOdParser

public XmlOdParser(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                   org.opentrafficsim.core.network.OTSNetwork network,
                   Set<org.opentrafficsim.core.gtu.GTUType> gtuTypes)

Constructor.

Parameters:

simulator - OTSDEVSSimulatorInterface; simulator

network - OTSNetwork; network

gtuTypes - Set; set of GTU types

Method Detail

getGTUType

public org.opentrafficsim.core.gtu.GTUType getGTUType(String id)
                                               throws XmlParserException

Returns the GTU type for the given id.

Parameters:

id - String; id

Returns:

GTU type for the given id

Throws:

XmlParserException - if the GTU type is not available

apply

public final void apply(URL url)
                 throws XmlParserException

Applies demand from URL.

Parameters:

url - URL; URL to file

Throws:

XmlParserException - if URL cannot be parsed

apply

public void apply(URL url,
                  org.opentrafficsim.road.gtu.generator.od.ODOptions odOptions)
           throws XmlParserException

Applies demand from URL using OD options.

Parameters:

url - URL; URL to file

odOptions - ODOptions; OD options

Throws:

XmlParserException - if URL cannot be parsed

apply

public final void apply(InputStream stream)
                 throws XmlParserException

Applies demand from stream.

Parameters:

stream - InputStream; stream

Throws:

XmlParserException - if URL cannot be parsed

apply

public final void apply(InputStream stream,
                        org.opentrafficsim.road.gtu.generator.od.ODOptions odOptions)
                 throws XmlParserException

Applies demand from stream using OD options.

Parameters:

stream - InputStream; stream

odOptions - ODOptions; OD options

Throws:

XmlParserException - if URL cannot be parsed

apply

public final void apply(Node xmlNode)
                 throws XmlParserException

Applies demand from xml node.

Parameters:

xmlNode - Node; node

Throws:

XmlParserException - if URL cannot be parsed

apply

public void apply(Node xmlNode,
                  org.opentrafficsim.road.gtu.generator.od.ODOptions odOptions)
           throws XmlParserException

Applies demand from URL using OD options.

Parameters:

xmlNode - Node; node

odOptions - ODOptions; OD options

Throws:

XmlParserException - if URL cannot be parsed

build

public final org.opentrafficsim.road.gtu.strategical.od.ODMatrix build(URL url)
                                                                throws XmlParserException

Build demand from URL.

Parameters:

url - URL; URL to file

Returns:

ODMatrix; OD matrix

Throws:

XmlParserException - if URL cannot be parsed

build

public final org.opentrafficsim.road.gtu.strategical.od.ODMatrix build(InputStream stream)
                                                                throws XmlParserException

Build demand from stream.

Parameters:

stream - InputStream; stream

Returns:

ODMatrix; OD matrix

Throws:

XmlParserException - if stream cannot be parsed

build

public final org.opentrafficsim.road.gtu.strategical.od.ODMatrix build(Node xmlNode)
                                                                throws XmlParserException

Build demand from xml node.

Parameters:

xmlNode - Node; node

Returns:

ODMatrix; OD matrix

Throws:

XmlParserException - if stream cannot be parsed

nullMultiply

static final Double nullMultiply(Double d1,
                                 Double d2)

Returns the multiplication of two values, taking 1.0 for null and returning null if both null.

Parameters:

d1 - Double value 1

d2 - Double value 2

Returns:

multiplication of two values, taking 1.0 for null and returning null if both null