org.cppftw.trains.model

Class Slot

java.lang.Object

org.cppftw.trains.model.Slot

Direct Known Subclasses:

Ground, Portal, Rail, Switch

public abstract class Slot
extends java.lang.Object

Represents a general element on the game field. Stations might be next to it and Vehicles can occupy it.

Constructor Summary

Constructors

Constructor and Description
Slot()

Method Summary

Modifier and Type	Method and Description
void	acquire(Vehicle thisVehicle) Sets the Slot to be occupied by the Vehicle given by thisVehicle by adding it to the set attribute content, which contains all vehicles occupying this Slot.
void	addStation(Station station) Adds a Station to the list of stations, which are next to the Slot.
void	arrive(Vehicle vehicle) Tries to make the passengers get off the Vehicle given by the parameter vehicle at the Stations next to this Slot.
boolean	checkCollision() Returns if there are more than one occupants on this Slot.
void	depart(Vehicle vehicle) Tries to make the waiting passengers at the Stations next to this Slot get on the Vehicle given by the parameter vehicle.
abstract Slot	getNextSlot(Slot previousSlot) Returns the Slot an object must move to after its next step determined by previousSlot.
Station	getStation() Returns "the" station which stands next to this slot, null there are no stations next to it.
Vehicle	getVehicle() Returns "the" vehicle which stands on this slot, null if empty.
protected boolean	isAcquired() Returns if this Slot has any occupants.
void	release(Vehicle thisVehicle) Removes the Vehicle given by thisVehicle from the set attribute content thus making it no longer occupy this Slot.

Methods inherited from class java.lang.Object

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

Constructor Detail

Slot

public Slot()

Method Detail

getNextSlot

public abstract Slot getNextSlot(Slot previousSlot)

Returns the Slot an object must move to after its next step determined by previousSlot.

Parameters:

previousSlot - Slot that determines the direction of movement

Returns:

the Slot to move to

addStation

public void addStation(Station station)

Adds a Station to the list of stations, which are next to the Slot.

Parameters:

station - the Station to be added

arrive

public void arrive(Vehicle vehicle)

Tries to make the passengers get off the Vehicle given by the parameter vehicle at the Stations next to this Slot.

Parameters:

vehicle - the vehicle which arrived.

depart

public void depart(Vehicle vehicle)

Tries to make the waiting passengers at the Stations next to this Slot get on the Vehicle given by the parameter vehicle.

Parameters:

vehicle - the vehicle which departed.

acquire

public void acquire(Vehicle thisVehicle)

Sets the Slot to be occupied by the Vehicle given by thisVehicle by adding it to the set attribute content, which contains all vehicles occupying this Slot.

Parameters:

thisVehicle - Vehicle to be added to the set content representing the occupants of this Slot

release

public void release(Vehicle thisVehicle)

Removes the Vehicle given by thisVehicle from the set attribute content thus making it no longer occupy this Slot.

Parameters:

thisVehicle - Vehicle to removed from the set content representing the occupants of this Slot

isAcquired

protected boolean isAcquired()

Returns if this Slot has any occupants. Checks for this information by inspecting the set attribute content's size.

Returns:

true if the set attribute content has any occupants, false if it doesn't

checkCollision

public boolean checkCollision()

Returns if there are more than one occupants on this Slot. Checks for this information by inspecting the set attribute content's size.

Returns:

true if the set attribute content has at least 2 occupants, false if it doesn't

getVehicle

public Vehicle getVehicle()

Returns "the" vehicle which stands on this slot, null if empty. If there are more than one vehicles, then it is unspecified which one is returned. So practical precondition: check collision.

Returns:

the vehicle

getStation

public Station getStation()

Returns "the" station which stands next to this slot, null there are no stations next to it.

Returns:

the station