org.opentrafficsim.road.network.factory.xml

Class XmlNetworkLaneParser

java.lang.Object

org.opentrafficsim.road.network.factory.xml.XmlNetworkLaneParser

All Implemented Interfaces:

Serializable

public class XmlNetworkLaneParser
extends Object
implements Serializable

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.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Jul 23, 2015

Author:

Alexander Verbraeck

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,ConnectorTag>	connectorTags The UNprocessed connectors for further reference.
protected GlobalTag	globalTag Global values from the GLOBAL tag.
protected Map<String,GTUMixTag>	gtuMixTags The GTUmix tags for further reference.
Map<String,GTUTag>	gtuTags The GTU tags for further reference.
Map<String,org.opentrafficsim.core.gtu.GTUType>	gtuTypes The GTUTypes that have been created.
protected Map<String,org.opentrafficsim.road.network.lane.LaneType>	laneTypes The LaneTypes that have been created.
protected Map<String,LaneTypeTag>	laneTypeTags The LaneType tags that have been created.
protected Map<String,LinkTag>	linkTags The UNprocessed links for further reference.
protected org.opentrafficsim.core.network.OTSNetwork	network The network to register the GTUs in.
protected Map<String,NodeTag>	nodeTags The UNprocessed nodes for further reference.
protected Map<String,RoadLayoutTag>	roadLayoutTags The road layout tags for further reference.
protected Map<String,RoadTypeTag>	roadTypeTags The road type tags for further reference.
protected Map<String,RouteMixTag>	routeMixTags The route mix tags for further reference.
protected Map<String,RouteTag>	routeTags The route tags for further reference.
protected Map<String,ShortestRouteMixTag>	shortestRouteMixTags The shortest route mix tags for further reference.
protected Map<String,ShortestRouteTag>	shortestRouteTags The shortest route tags for further reference.
protected org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface	simulator The simulator for creating the animation.
(package private) List<String>	xmlComments All comments encountered in the XML file.

Constructor Summary

Constructors

Constructor and Description
XmlNetworkLaneParser(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)
XmlNetworkLaneParser(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator, org.opentrafficsim.core.gtu.animation.GTUColorer colorer)

Method Summary

Modifier and Type	Method and Description
org.opentrafficsim.core.network.OTSNetwork	build(InputStream stream, boolean interpretXMLComments)
org.opentrafficsim.core.network.OTSNetwork	build(InputStream stream, org.opentrafficsim.core.network.OTSNetwork otsNetwork, boolean interpretXMLComments)
org.opentrafficsim.core.network.OTSNetwork	build(URL url, boolean interpretXMLComments)
org.opentrafficsim.core.network.OTSNetwork	build(URL url, org.opentrafficsim.core.network.OTSNetwork otsNetwork, boolean interpretXMLComments)
nl.tudelft.simulation.immutablecollections.ImmutableList<String>	getXMLComments() Obtain an immutable copy of the collected XML comments.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

globalTag

protected GlobalTag globalTag

Global values from the GLOBAL tag.

nodeTags

protected Map<String,NodeTag> nodeTags

The UNprocessed nodes for further reference.

connectorTags

protected Map<String,ConnectorTag> connectorTags

The UNprocessed connectors for further reference.

linkTags

protected Map<String,LinkTag> linkTags

The UNprocessed links for further reference.

gtuTags

public Map<String,GTUTag> gtuTags

The GTU tags for further reference.

gtuMixTags

protected Map<String,GTUMixTag> gtuMixTags

The GTUmix tags for further reference.

routeTags

protected Map<String,RouteTag> routeTags

The route tags for further reference.

routeMixTags

protected Map<String,RouteMixTag> routeMixTags

The route mix tags for further reference.

shortestRouteTags

protected Map<String,ShortestRouteTag> shortestRouteTags

The shortest route tags for further reference.

shortestRouteMixTags

protected Map<String,ShortestRouteMixTag> shortestRouteMixTags

The shortest route mix tags for further reference.

roadTypeTags

protected Map<String,RoadTypeTag> roadTypeTags

The road type tags for further reference.

roadLayoutTags

protected Map<String,RoadLayoutTag> roadLayoutTags

The road layout tags for further reference.

gtuTypes

public Map<String,org.opentrafficsim.core.gtu.GTUType> gtuTypes

The GTUTypes that have been created. public to make it accessible from LaneAttributes.

laneTypeTags

protected Map<String,LaneTypeTag> laneTypeTags

The LaneType tags that have been created.

laneTypes

protected Map<String,org.opentrafficsim.road.network.lane.LaneType> laneTypes

The LaneTypes that have been created.

simulator

protected org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator

The simulator for creating the animation. Null if no animation needed.

network

protected org.opentrafficsim.core.network.OTSNetwork network

The network to register the GTUs in.

xmlComments

List<String> xmlComments

All comments encountered in the XML file.

Constructor Detail

XmlNetworkLaneParser

public XmlNetworkLaneParser(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)

Parameters:

simulator - the simulator for creating the animation. Null if no animation needed.

XmlNetworkLaneParser

public XmlNetworkLaneParser(org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator,
                            org.opentrafficsim.core.gtu.animation.GTUColorer colorer)

Parameters:

simulator - the simulator for creating the animation. Null if no animation needed.

colorer - GTU colorer

Method Detail

build

public final org.opentrafficsim.core.network.OTSNetwork build(URL url,
                                                              boolean interpretXMLComments)
                                                       throws org.opentrafficsim.core.network.NetworkException,
                                                              ParserConfigurationException,
                                                              SAXException,
                                                              IOException,
                                                              NamingException,
                                                              org.opentrafficsim.core.gtu.GTUException,
                                                              org.opentrafficsim.core.geometry.OTSGeometryException,
                                                              nl.tudelft.simulation.dsol.SimRuntimeException,
                                                              org.djunits.value.ValueException,
                                                              org.opentrafficsim.base.parameters.ParameterException

Parameters:

url - the file with the network in the agreed xml-grammar.

interpretXMLComments - boolean; if true; interpret specifically formatted XML comments and modify the network accordingly

Returns:

the network with Nodes, Links, and Lanes.

Throws:

org.opentrafficsim.core.network.NetworkException - in case of parsing problems.

SAXException - in case of parsing problems.

ParserConfigurationException - in case of parsing problems.

IOException - in case of file reading problems.

NamingException - in case the animation context cannot be found

org.opentrafficsim.core.gtu.GTUException - in case of a problem with creating the LaneBlock (which is a GTU right now)

org.opentrafficsim.core.geometry.OTSGeometryException - when construction of a lane contour or offset design line fails

nl.tudelft.simulation.dsol.SimRuntimeException - when simulator cannot be used to schedule GTU generation

org.opentrafficsim.base.parameters.ParameterException - ...

org.djunits.value.ValueException - ...

build

public final org.opentrafficsim.core.network.OTSNetwork build(InputStream stream,
                                                              boolean interpretXMLComments)
                                                       throws org.opentrafficsim.core.network.NetworkException,
                                                              ParserConfigurationException,
                                                              SAXException,
                                                              IOException,
                                                              NamingException,
                                                              org.opentrafficsim.core.gtu.GTUException,
                                                              org.opentrafficsim.core.geometry.OTSGeometryException,
                                                              nl.tudelft.simulation.dsol.SimRuntimeException,
                                                              org.djunits.value.ValueException,
                                                              org.opentrafficsim.base.parameters.ParameterException

Parameters:

stream - the input stream with the network in the agreed xml-grammar.

interpretXMLComments - boolean; if true; interpret specifically formatted XML comments and modify the network accordingly

Returns:

the network with Nodes, Links, and Lanes.

Throws:

org.opentrafficsim.core.network.NetworkException - in case of parsing problems.

SAXException - in case of parsing problems.

ParserConfigurationException - in case of parsing problems.

IOException - in case of file reading problems.

NamingException - in case the animation context cannot be found

org.opentrafficsim.core.gtu.GTUException - in case of a problem with creating the LaneBlock (which is a GTU right now)

org.opentrafficsim.core.geometry.OTSGeometryException - when construction of a lane contour or offset design line fails

nl.tudelft.simulation.dsol.SimRuntimeException - when simulator cannot be used to schedule GTU generation

org.opentrafficsim.base.parameters.ParameterException - ...

org.djunits.value.ValueException - ...

build

public final org.opentrafficsim.core.network.OTSNetwork build(URL url,
                                                              org.opentrafficsim.core.network.OTSNetwork otsNetwork,
                                                              boolean interpretXMLComments)
                                                       throws org.opentrafficsim.core.network.NetworkException,
                                                              ParserConfigurationException,
                                                              SAXException,
                                                              IOException,
                                                              NamingException,
                                                              org.opentrafficsim.core.gtu.GTUException,
                                                              org.opentrafficsim.core.geometry.OTSGeometryException,
                                                              nl.tudelft.simulation.dsol.SimRuntimeException,
                                                              org.djunits.value.ValueException,
                                                              org.opentrafficsim.base.parameters.ParameterException

Parameters:

url - the file with the network in the agreed xml-grammar.

otsNetwork - OTSNetwork; the network

interpretXMLComments - boolean; if true; interpret specifically formatted XML comments and modify the network accordingly

Returns:

the network with Nodes, Links, and Lanes.

Throws:

org.opentrafficsim.core.network.NetworkException - in case of parsing problems.

SAXException - in case of parsing problems.

ParserConfigurationException - in case of parsing problems.

IOException - in case of file reading problems.

NamingException - in case the animation context cannot be found

org.opentrafficsim.core.gtu.GTUException - in case of a problem with creating the LaneBlock (which is a GTU right now)

org.opentrafficsim.core.geometry.OTSGeometryException - when construction of a lane contour or offset design line fails

nl.tudelft.simulation.dsol.SimRuntimeException - when simulator cannot be used to schedule GTU generation

org.opentrafficsim.base.parameters.ParameterException - ...

org.djunits.value.ValueException - ...

build

public final org.opentrafficsim.core.network.OTSNetwork build(InputStream stream,
                                                              org.opentrafficsim.core.network.OTSNetwork otsNetwork,
                                                              boolean interpretXMLComments)
                                                       throws org.opentrafficsim.core.network.NetworkException,
                                                              ParserConfigurationException,
                                                              SAXException,
                                                              IOException,
                                                              NamingException,
                                                              org.opentrafficsim.core.gtu.GTUException,
                                                              org.opentrafficsim.core.geometry.OTSGeometryException,
                                                              nl.tudelft.simulation.dsol.SimRuntimeException,
                                                              org.djunits.value.ValueException,
                                                              org.opentrafficsim.base.parameters.ParameterException

Parameters:

stream - the input stream with the network in the agreed xml-grammar.

otsNetwork - OTSNetwork; the network

interpretXMLComments - boolean; if true; interpret specifically formatted XML comments and modify the network accordingly

Returns:

the network with Nodes, Links, and Lanes.

Throws:

org.opentrafficsim.core.network.NetworkException - in case of parsing problems.

SAXException - in case of parsing problems.

ParserConfigurationException - in case of parsing problems.

IOException - in case of file reading problems.

NamingException - in case the animation context cannot be found

org.opentrafficsim.core.gtu.GTUException - in case of a problem with creating the LaneBlock (which is a GTU right now)

org.opentrafficsim.core.geometry.OTSGeometryException - when construction of a lane contour or offset design line fails

nl.tudelft.simulation.dsol.SimRuntimeException - when simulator cannot be used to schedule GTU generation

org.opentrafficsim.base.parameters.ParameterException - ...

org.djunits.value.ValueException - ...

getXMLComments

public nl.tudelft.simulation.immutablecollections.ImmutableList<String> getXMLComments()

Obtain an immutable copy of the collected XML comments.

Returns:

List<String>; a list of the XML comments

toString

public String toString()

Overrides:

toString in class Object