Open Traffic Sim parser classes for ESRI shape files

ots-parser-shape 1.04.02

MODULES

• ots
• ots-base
• ots-core
• ots-kpi
• ots-animation
• ots-road
• ots-rail
• ots-water
• ots-multimodal
• ots-trafficcontrol
• ots-xsd
• ots-parser-xml
• ots-parser-opendrive
• ots-parser-osm
• ots-parser-shape
• ots-parser-vissim
• ots-sim0mq
• ots-sim0mq-kpi
• ots-sim0mq-swing
• ots-draw
• ots-swing
• ots-web
• ots-demo
• ots-aimsun
• ots-aimsun-proto
• ots-aimsun-demo

API

• JavaDocs

PROJECT REPORTS

• Reports
• Dependencies
• Source Xref
• Test JavaDocs
• Test Xref
• Checkstyle
• Surefire report
• JaCoCo
• Tag List
• SpotBugs
• CPD
• PMD

PROJECT INFO

• About
• Project Summary
• Project Team
• Project License
• Versions + Changes

RELATED

• OTS Manual
• DSOL
• DJUNITS manual
• DJUTILS manual
• Sim0MQ
• DITTLab
• Simulation@TU Delft
• About OTS

Checkstyle Results

The following document contains the results of Checkstyle 8.35 with development/dsol-checks.xml ruleset. 

Summary

Files	Info	Warnings	Errors
7	3	88	0

Files

File	I	W	E
org/opentrafficsim/road/network/factory/shape/AbstractNWBRoadElement.java	0	12	0
org/opentrafficsim/road/network/factory/shape/LocatePoint.java	0	12	0
org/opentrafficsim/road/network/factory/shape/NWBDrivingLane.java	1	15	0
org/opentrafficsim/road/network/factory/shape/NWBRoadElement.java	1	24	0
org/opentrafficsim/road/network/factory/shape/NWBSpecialLane.java	1	15	0
org/opentrafficsim/road/network/factory/shape/SubstringLine.java	0	10	0

Rules

Category	Rule	Violations	Severity
design	DesignForExtension	20	Warning
javadoc	JavadocVariable	21	Warning
misc	FinalParameters	47	Warning
sizes	ParameterNumber	3	Info

Details

org/opentrafficsim/road/network/factory/shape/AbstractNWBRoadElement.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	16
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	18
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	20
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	23
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	26
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	29
Warning	design	DesignForExtension	Class 'AbstractNWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getMyGeom' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AbstractNWBRoadElement' final or making the method 'getMyGeom' static/final/abstract/empty, or adding allowed annotation for the method.	50
Warning	design	DesignForExtension	Class 'AbstractNWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getStartNode' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AbstractNWBRoadElement' final or making the method 'getStartNode' static/final/abstract/empty, or adding allowed annotation for the method.	55
Warning	design	DesignForExtension	Class 'AbstractNWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getEndNode' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AbstractNWBRoadElement' final or making the method 'getEndNode' static/final/abstract/empty, or adding allowed annotation for the method.	60
Warning	design	DesignForExtension	Class 'AbstractNWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getRoadId' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AbstractNWBRoadElement' final or making the method 'getRoadId' static/final/abstract/empty, or adding allowed annotation for the method.	65
Warning	design	DesignForExtension	Class 'AbstractNWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getBeginDistance' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AbstractNWBRoadElement' final or making the method 'getBeginDistance' static/final/abstract/empty, or adding allowed annotation for the method.	70
Warning	design	DesignForExtension	Class 'AbstractNWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getEndDistance' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AbstractNWBRoadElement' final or making the method 'getEndDistance' static/final/abstract/empty, or adding allowed annotation for the method.	75

org/opentrafficsim/road/network/factory/shape/LocatePoint.java

Severity	Category	Rule	Message	Line
Warning	misc	FinalParameters	Parameter p0 should be final.	15
Warning	misc	FinalParameters	Parameter p1 should be final.	15
Warning	misc	FinalParameters	Parameter distance should be final.	15
Warning	misc	FinalParameters	Parameter line should be final.	33
Warning	misc	FinalParameters	Parameter distance should be final.	33
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	39
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	41
Warning	misc	FinalParameters	Parameter line should be final.	43
Warning	misc	FinalParameters	Parameter distance should be final.	43
Warning	misc	FinalParameters	Parameter line should be final.	48
Warning	misc	FinalParameters	Parameter distance should be final.	48
Warning	design	DesignForExtension	Class 'LocatePoint' looks like designed for extension (can be subclassed), but the method 'getPoint' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'LocatePoint' final or making the method 'getPoint' static/final/abstract/empty, or adding allowed annotation for the method.	71

org/opentrafficsim/road/network/factory/shape/NWBDrivingLane.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	16
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	19
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	22
Info	sizes	ParameterNumber	More than 7 parameters (found 9).	35
Warning	misc	FinalParameters	Parameter myGeom should be final.	35
Warning	misc	FinalParameters	Parameter startNode should be final.	35
Warning	misc	FinalParameters	Parameter endNode should be final.	35
Warning	misc	FinalParameters	Parameter roadId should be final.	35
Warning	misc	FinalParameters	Parameter beginDistance should be final.	35
Warning	misc	FinalParameters	Parameter endDistance should be final.	36
Warning	misc	FinalParameters	Parameter startNumberOfLanes should be final.	36
Warning	misc	FinalParameters	Parameter endNumberOfLanes should be final.	36
Warning	misc	FinalParameters	Parameter sideCode should be final.	36
Warning	design	DesignForExtension	Class 'NWBDrivingLane' looks like designed for extension (can be subclassed), but the method 'getStartNumberOfLanes' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBDrivingLane' final or making the method 'getStartNumberOfLanes' static/final/abstract/empty, or adding allowed annotation for the method.	44
Warning	design	DesignForExtension	Class 'NWBDrivingLane' looks like designed for extension (can be subclassed), but the method 'getEndNumberOfLanes' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBDrivingLane' final or making the method 'getEndNumberOfLanes' static/final/abstract/empty, or adding allowed annotation for the method.	49
Warning	design	DesignForExtension	Class 'NWBDrivingLane' looks like designed for extension (can be subclassed), but the method 'getSideCode' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBDrivingLane' final or making the method 'getSideCode' static/final/abstract/empty, or adding allowed annotation for the method.	54

org/opentrafficsim/road/network/factory/shape/NWBRoadElement.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	17
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	20
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	23
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	26
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	29
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	32
Info	sizes	ParameterNumber	More than 7 parameters (found 12).	49
Warning	misc	FinalParameters	Parameter myGeom should be final.	49
Warning	misc	FinalParameters	Parameter startNode should be final.	49
Warning	misc	FinalParameters	Parameter endNode should be final.	49
Warning	misc	FinalParameters	Parameter roadId should be final.	49
Warning	misc	FinalParameters	Parameter beginDistance should be final.	49
Warning	misc	FinalParameters	Parameter endDistance should be final.	50
Warning	misc	FinalParameters	Parameter junctionIdBegin should be final.	50
Warning	misc	FinalParameters	Parameter junctionIdEnd should be final.	50
Warning	misc	FinalParameters	Parameter adminDirection should be final.	50
Warning	misc	FinalParameters	Parameter drivingDirection should be final.	50
Warning	misc	FinalParameters	Parameter beginKM should be final.	51
Warning	misc	FinalParameters	Parameter endKM should be final.	51
Warning	design	DesignForExtension	Class 'NWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getJunctionIdBegin' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBRoadElement' final or making the method 'getJunctionIdBegin' static/final/abstract/empty, or adding allowed annotation for the method.	62
Warning	design	DesignForExtension	Class 'NWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getJunctionIdEnd' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBRoadElement' final or making the method 'getJunctionIdEnd' static/final/abstract/empty, or adding allowed annotation for the method.	67
Warning	design	DesignForExtension	Class 'NWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getAdminDirection' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBRoadElement' final or making the method 'getAdminDirection' static/final/abstract/empty, or adding allowed annotation for the method.	72
Warning	design	DesignForExtension	Class 'NWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getDrivingDirection' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBRoadElement' final or making the method 'getDrivingDirection' static/final/abstract/empty, or adding allowed annotation for the method.	77
Warning	design	DesignForExtension	Class 'NWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getBeginKM' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBRoadElement' final or making the method 'getBeginKM' static/final/abstract/empty, or adding allowed annotation for the method.	82
Warning	design	DesignForExtension	Class 'NWBRoadElement' looks like designed for extension (can be subclassed), but the method 'getEndKM' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBRoadElement' final or making the method 'getEndKM' static/final/abstract/empty, or adding allowed annotation for the method.	87

org/opentrafficsim/road/network/factory/shape/NWBSpecialLane.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	15
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	18
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	21
Info	sizes	ParameterNumber	More than 7 parameters (found 9).	35
Warning	misc	FinalParameters	Parameter myGeom should be final.	35
Warning	misc	FinalParameters	Parameter startNode should be final.	35
Warning	misc	FinalParameters	Parameter endNode should be final.	35
Warning	misc	FinalParameters	Parameter roadId should be final.	35
Warning	misc	FinalParameters	Parameter beginDistance should be final.	35
Warning	misc	FinalParameters	Parameter endDistance should be final.	36
Warning	misc	FinalParameters	Parameter laneType should be final.	36
Warning	misc	FinalParameters	Parameter numberOfLanes should be final.	36
Warning	misc	FinalParameters	Parameter sideCode should be final.	36
Warning	design	DesignForExtension	Class 'NWBSpecialLane' looks like designed for extension (can be subclassed), but the method 'getLaneType' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBSpecialLane' final or making the method 'getLaneType' static/final/abstract/empty, or adding allowed annotation for the method.	44
Warning	design	DesignForExtension	Class 'NWBSpecialLane' looks like designed for extension (can be subclassed), but the method 'getNumberOfLanes' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBSpecialLane' final or making the method 'getNumberOfLanes' static/final/abstract/empty, or adding allowed annotation for the method.	49
Warning	design	DesignForExtension	Class 'NWBSpecialLane' looks like designed for extension (can be subclassed), but the method 'getSideCode' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NWBSpecialLane' final or making the method 'getSideCode' static/final/abstract/empty, or adding allowed annotation for the method.	54

org/opentrafficsim/road/network/factory/shape/SubstringLine.java

Severity	Category	Rule	Message	Line
Warning	misc	FinalParameters	Parameter line should be final.	35
Warning	misc	FinalParameters	Parameter startLength should be final.	35
Warning	misc	FinalParameters	Parameter endLength should be final.	35
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	41
Warning	misc	FinalParameters	Parameter line should be final.	43
Warning	design	DesignForExtension	Class 'SubstringLine' looks like designed for extension (can be subclassed), but the method 'getSubstring' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'SubstringLine' final or making the method 'getSubstring' static/final/abstract/empty, or adding allowed annotation for the method.	48
Warning	misc	FinalParameters	Parameter startDistance should be final.	48
Warning	misc	FinalParameters	Parameter endDistance should be final.	48
Warning	misc	FinalParameters	Parameter startDistance should be final.	77
Warning	misc	FinalParameters	Parameter endDistance should be final.	77