Open Traffic Sim waterway classes

ots-water 1.04.04

MODULES v1

• 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-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
65	8	106	0

Files

File	I	W	E
org/opentrafficsim/water/demand/Container.java	0	1	0
org/opentrafficsim/water/role/Company.java	0	1	0
org/opentrafficsim/water/statistics/ContainerTransportCO2BreakdownEnum.java	4	8	0
org/opentrafficsim/water/statistics/ContainerTransportCostBreakdownEnum.java	0	11	0
org/opentrafficsim/water/statistics/ContainerTransportFeeBreakdownEnum.java	0	8	0
org/opentrafficsim/water/statistics/ContainerTransportTimeBreakdownEnum.java	4	8	0
org/opentrafficsim/water/statistics/DirectionEnum.java	0	1	0
org/opentrafficsim/water/statistics/FullEmptyEnum.java	0	1	0
org/opentrafficsim/water/statistics/LandWaterEnum.java	0	1	0
org/opentrafficsim/water/statistics/SailingServiceTimeBreakdownEnum.java	0	22	0
org/opentrafficsim/water/statistics/XCounter.java	0	3	0
org/opentrafficsim/water/statistics/XFrequency.java	0	5	0
org/opentrafficsim/water/statistics/XPersistent.java	0	7	0
org/opentrafficsim/water/statistics/XTally.java	0	4	0
org/opentrafficsim/water/statistics/XTimeTally.java	0	2	0
org/opentrafficsim/water/transfer/Terminal.java	0	2	0
org/opentrafficsim/water/transfer/TerminalPortTax.java	0	18	0
org/opentrafficsim/water/transport/SailingServiceType.java	0	3	0

Rules

Category	Rule	Violations	Severity
blocks	NeedBraces	11	Warning
design	DesignForExtension	7	Warning
	VisibilityModifier	7	Warning
javadoc	JavadocVariable	62	Warning
misc	FinalParameters	10	Warning
	TodoComment	1	Warning
modifier	RedundantModifier	8	Warning
sizes	LineLength max: "128"	8	Info

Details

org/opentrafficsim/water/demand/Container.java

Severity	Category	Rule	Message	Line
Warning	misc	TodoComment	Comment matches to-do format 'TODO:'.	246

org/opentrafficsim/water/role/Company.java

Severity	Category	Rule	Message	Line
Warning	design	VisibilityModifier	Variable 'code' must be private and have accessor methods.	22

org/opentrafficsim/water/statistics/ContainerTransportCO2BreakdownEnum.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	19
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	21
Info	sizes	LineLength	Line is longer than 128 characters (found 171).	22
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	24
Info	sizes	LineLength	Line is longer than 128 characters (found 201).	25
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	27
Info	sizes	LineLength	Line is longer than 128 characters (found 135).	28
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Info	sizes	LineLength	Line is longer than 128 characters (found 161).	31
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	33
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	35
Warning	modifier	RedundantModifier	Redundant 'private' modifier.	47

org/opentrafficsim/water/statistics/ContainerTransportCostBreakdownEnum.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	19
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	21
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	25
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	28
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	32
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	34
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	38
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	42
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	44
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	47
Warning	modifier	RedundantModifier	Redundant 'private' modifier.	59

org/opentrafficsim/water/statistics/ContainerTransportFeeBreakdownEnum.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	19
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	21
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	24
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	28
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	31
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	35
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	37
Warning	modifier	RedundantModifier	Redundant 'private' modifier.	60

org/opentrafficsim/water/statistics/ContainerTransportTimeBreakdownEnum.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	19
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	21
Info	sizes	LineLength	Line is longer than 128 characters (found 168).	22
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	24
Info	sizes	LineLength	Line is longer than 128 characters (found 160).	25
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	27
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	29
Info	sizes	LineLength	Line is longer than 128 characters (found 135).	30
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	32
Info	sizes	LineLength	Line is longer than 128 characters (found 154).	33
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	35
Warning	modifier	RedundantModifier	Redundant 'private' modifier.	47

org/opentrafficsim/water/statistics/DirectionEnum.java

Severity	Category	Rule	Message	Line
Warning	modifier	RedundantModifier	Redundant 'private' modifier.	33

org/opentrafficsim/water/statistics/FullEmptyEnum.java

Severity	Category	Rule	Message	Line
Warning	modifier	RedundantModifier	Redundant 'private' modifier.	33

org/opentrafficsim/water/statistics/LandWaterEnum.java

Severity	Category	Rule	Message	Line
Warning	modifier	RedundantModifier	Redundant 'private' modifier.	33

org/opentrafficsim/water/statistics/SailingServiceTimeBreakdownEnum.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	19
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	21
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	23
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	26
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	28
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	32
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	34
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	36
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	38
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	40
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	42
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	44
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	46
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	48
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	50
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	52
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	54
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	56
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	58
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	60
Warning	modifier	RedundantModifier	Redundant 'private' modifier.	72

org/opentrafficsim/water/statistics/XCounter.java

Severity	Category	Rule	Message	Line
Warning	design	VisibilityModifier	Variable 'count' must be private and have accessor methods.	32
Warning	design	VisibilityModifier	Variable 'n' must be private and have accessor methods.	35
Warning	design	VisibilityModifier	Variable 'description' must be private and have accessor methods.	38

org/opentrafficsim/water/statistics/XFrequency.java

Severity	Category	Rule	Message	Line
Warning	design	VisibilityModifier	Variable 'frequency' must be private and have accessor methods.	34
Warning	design	VisibilityModifier	Variable 'n' must be private and have accessor methods.	37
Warning	design	VisibilityModifier	Variable 'description' must be private and have accessor methods.	40
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	91
Warning	blocks	NeedBraces	'else' construct must use '{}'s.	93

org/opentrafficsim/water/statistics/XPersistent.java

Severity	Category	Rule	Message	Line
Warning	misc	FinalParameters	Parameter description should be final.	52
Warning	misc	FinalParameters	Parameter simulator should be final.	52
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	62
Warning	blocks	NeedBraces	'else' construct must use '{}'s.	64
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	120
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	122
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	125

org/opentrafficsim/water/statistics/XTally.java

Severity	Category	Rule	Message	Line
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	91
Warning	blocks	NeedBraces	'else' construct must use '{}'s.	93
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	262
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	264

org/opentrafficsim/water/statistics/XTimeTally.java

Severity	Category	Rule	Message	Line
Warning	misc	FinalParameters	Parameter description should be final.	34
Warning	misc	FinalParameters	Parameter simulator should be final.	34

org/opentrafficsim/water/transfer/Terminal.java

Severity	Category	Rule	Message	Line
Warning	misc	FinalParameters	Parameter name should be final.	25
Warning	misc	FinalParameters	Parameter location should be final.	25

org/opentrafficsim/water/transfer/TerminalPortTax.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	6
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	8
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	10
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	12
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	14
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	16
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	18
Warning	misc	FinalParameters	Parameter feePortPerFullMove should be final.	20
Warning	misc	FinalParameters	Parameter feePortPerEmptyMove should be final.	20
Warning	misc	FinalParameters	Parameter feePortPerDWT should be final.	20
Warning	misc	FinalParameters	Parameter feeStrategy should be final.	20
Warning	design	DesignForExtension	Class 'TerminalPortTax' looks like designed for extension (can be subclassed), but the method 'getFeePortPerShipDWT' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TerminalPortTax' final or making the method 'getFeePortPerShipDWT' static/final/abstract/empty, or adding allowed annotation for the method.	51
Warning	design	DesignForExtension	Class 'TerminalPortTax' looks like designed for extension (can be subclassed), but the method 'getFeePortPerFullMove' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TerminalPortTax' final or making the method 'getFeePortPerFullMove' static/final/abstract/empty, or adding allowed annotation for the method.	57
Warning	design	DesignForExtension	Class 'TerminalPortTax' looks like designed for extension (can be subclassed), but the method 'getFeePortPerEmptyMove' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TerminalPortTax' final or making the method 'getFeePortPerEmptyMove' static/final/abstract/empty, or adding allowed annotation for the method.	62
Warning	design	DesignForExtension	Class 'TerminalPortTax' looks like designed for extension (can be subclassed), but the method 'isUsePortFeePerEmptyMove' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TerminalPortTax' final or making the method 'isUsePortFeePerEmptyMove' static/final/abstract/empty, or adding allowed annotation for the method.	67
Warning	design	DesignForExtension	Class 'TerminalPortTax' looks like designed for extension (can be subclassed), but the method 'isUsePortFeePerFullMove' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TerminalPortTax' final or making the method 'isUsePortFeePerFullMove' static/final/abstract/empty, or adding allowed annotation for the method.	72
Warning	design	DesignForExtension	Class 'TerminalPortTax' looks like designed for extension (can be subclassed), but the method 'isUsePortFeePerShipDWT' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TerminalPortTax' final or making the method 'isUsePortFeePerShipDWT' static/final/abstract/empty, or adding allowed annotation for the method.	77
Warning	design	DesignForExtension	Class 'TerminalPortTax' looks like designed for extension (can be subclassed), but the method 'getFeeStrategy' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TerminalPortTax' final or making the method 'getFeeStrategy' static/final/abstract/empty, or adding allowed annotation for the method.	82

org/opentrafficsim/water/transport/SailingServiceType.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	20
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	21
Warning	javadoc	JavadocVariable	Missing a Javadoc comment.	22