net.maritimecloud.util.geometry

Class PositionReaderSimulator

java.lang.Object

net.maritimecloud.util.geometry.PositionReaderSimulator

public final class PositionReaderSimulator
extends Object

A simple builder for creating position readers that simulate simple sailing patterns.

Author:

Kasper Nielsen

Constructor Summary

Constructors

Constructor and Description
PositionReaderSimulator() Creates a new PositionReaderSimulator.
PositionReaderSimulator(Random random) Creates a new PositionReaderSimulator.

Method Summary

Modifier and Type	Method and Description
PositionReader	forArea(Area area) Creates a new simulated position reader.
PositionReader	forRoute(Position... positions) Creates a new simulated reader with the specified route.
PositionReaderSimulator	setSpeedFixed(double speed, SpeedUnit speedUnit) Sets a fixed speed for the vessel.
PositionReaderSimulator	setSpeedVariable(double minSpeed, double maxSpeed, SpeedUnit speedUnit) Sets a variable speed for the vessel.
PositionReaderSimulator	setTimeSource(java.util.function.LongSupplier timeSource) Sets the time source that is used to determine how long duration has passed between succint invocations of PositionReader.getCurrentPosition().
PositionReaderSimulator	setTimeSourceFixedSlice(long milliesIncrement) Sets a deterministic time source that increment the time with the specified amount of milliseconds every time.

Methods inherited from class java.lang.Object

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

Constructor Detail

PositionReaderSimulator

public PositionReaderSimulator()

Creates a new PositionReaderSimulator. With a non-deterministic random source

PositionReaderSimulator

public PositionReaderSimulator(Random random)

Creates a new PositionReaderSimulator.

Parameters:

random - the random source of data

Method Detail

forArea

public PositionReader forArea(Area area)

Creates a new simulated position reader. The simulated vessel will start at random position within the specified area. And then travel to another random position within the area. When it arrives at the position it will choose another random position within the area to travel to and so on.

Parameters:

area - the area to travel within

Returns:

a new position reader

Throws:

NullPointerException - if the specified area is null

forRoute

public PositionReader forRoute(Position... positions)

Creates a new simulated reader with the specified route. When the vessel reaches the last of the specified positions. It will sail the same route back. Continuing indefinitely.

If the first position and the last position is equivalent the positions will be delivered as if the vessel is sailing in a circle. When the ship reaches the final position it will sail to position number 2 instead of sailing the same route back.

Parameters:

positions - each position for route

Returns:

a new simulated reader

setSpeedFixed

public PositionReaderSimulator setSpeedFixed(double speed,
                                             SpeedUnit speedUnit)

Sets a fixed speed for the vessel.

If no speed is set the simulated position reader will use a variable speed between 1 and 40 knots.

Parameters:

speed - the speed of the vessel

speedUnit - the unit of speed

Returns:

this builder

Throws:

NullPointerException - if the speed unit is null

IllegalArgumentException - if the specified speed is non positive

See Also:

setSpeedVariable(double, double, SpeedUnit)

setSpeedVariable

public PositionReaderSimulator setSpeedVariable(double minSpeed,
                                                double maxSpeed,
                                                SpeedUnit speedUnit)

Sets a variable speed for the vessel. Every time the vessel reaches a target position. It will change the speed to a random number between minimum speed and maximum speed.

If no speed is set the simulated position reader will use a variable speed between 1 and 40 knots.

Parameters:

minSpeed - the minimum speed of the vessel

maxSpeed - the maximum speed of the vessel

speedUnit - the unit of speed

Returns:

this builder

Throws:

NullPointerException - if the speed unit is null

IllegalArgumentException - if the specified minimum speed is non positive or the max speed is than or equal to minimum speed

See Also:

setSpeedFixed(double, SpeedUnit)

setTimeSource

public PositionReaderSimulator setTimeSource(java.util.function.LongSupplier timeSource)

Sets the time source that is used to determine how long duration has passed between succint invocations of PositionReader.getCurrentPosition(). If no time source is set, System.currentTimeMillis() is used.

Parameters:

timeSource - the time source

Returns:

this builder

Throws:

NullPointerException - if the specified time source is null

setTimeSourceFixedSlice

public PositionReaderSimulator setTimeSourceFixedSlice(long milliesIncrement)

Sets a deterministic time source that increment the time with the specified amount of milliseconds every time.

Parameters:

milliesIncrement - the number of milliseconds that the ship will sail every time PositionReader.getCurrentPosition() is invoked

Returns:

this builder