ch.sahits.game.openpatrician.model.sea

Class TravellingVessels

java.lang.Object

ch.sahits.game.openpatrician.model.sea.TravellingVessels

All Implemented Interfaces:

ITravellingVessels, Iterable<INavigableVessel>

@Component
 @Lazy
public class TravellingVessels
extends Object
implements ITravellingVessels

This iterable collection stores all vessels that are currently travelling. Vessels should be added when they start their travel and be removed when they reach their destination or otherwise stop traveling (e.g. are sunk).

Author:

Andi Hotz, (c) Sahits GmbH, 2016 Created on Jan 08, 2016

Field Summary

Fields

Modifier and Type	Field and Description
private Map<INavigableVessel,TravellingVessel>	vessels

Constructor Summary

Constructors

Constructor and Description
TravellingVessels()

Method Summary

Modifier and Type	Method and Description
void	addVessel(INavigableVessel vessel, Optional<javafx.scene.shape.Path> path, List<javafx.geometry.Point2D> points) The vessel starts it's travel and must be added to this collection together with its data.
TravellingVessel	getTravellingVessel(INavigableVessel vessel) Retrieve the meta date for a travelling vessel.
boolean	isTravelling(INavigableVessel vessel) Check if the vessel is currently travelling.
Iterator<INavigableVessel>	iterator()
void	remove(INavigableVessel vessel) The vessel is no longer travelling and should no longer be part of this collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

vessels

private final Map<INavigableVessel,TravellingVessel> vessels

Constructor Detail

TravellingVessels

public TravellingVessels()

Method Detail

addVessel

public void addVessel(INavigableVessel vessel,
                      Optional<javafx.scene.shape.Path> path,
                      List<javafx.geometry.Point2D> points)

The vessel starts it's travel and must be added to this collection together with its data.

Parameters:

vessel - that starts the travel

path - the Bezière path representing the route.

points - the list of points that make up the path along which the vessel is travelling.

remove

public void remove(INavigableVessel vessel)

The vessel is no longer travelling and should no longer be part of this collection.

Parameters:

vessel -

iterator

public Iterator<INavigableVessel> iterator()

Specified by:

iterator in interface ITravellingVessels

Specified by:

iterator in interface Iterable<INavigableVessel>

getTravellingVessel

public TravellingVessel getTravellingVessel(INavigableVessel vessel)

Retrieve the meta date for a travelling vessel.

Specified by:

getTravellingVessel in interface ITravellingVessels

Parameters:

vessel -

Returns:

isTravelling

public boolean isTravelling(INavigableVessel vessel)

Check if the vessel is currently travelling.

Specified by:

isTravelling in interface ITravellingVessels

Parameters:

vessel -

Returns: