org.cppftw.trains.model

Class Portal

java.lang.Object

org.cppftw.trains.model.Slot

org.cppftw.trains.model.Portal

public class Portal
extends Slot

The class Portal represents the places, also known as Slots where entrances of Tunnels can be opened. It has a Slot connected to it that is always active, another one that is active if the Portal isn't open, and a Rail that is active if it is open, which leads into the Tunnel.

Constructor Summary

Constructors

Constructor and Description
Portal() Creates a Portal without any Slots connected to it.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the Portal by setting the reference to the first Rail in the Tunnel to null.
Slot	getFixSlot() Returns the reference to the attribute fixSlot.
Slot	getNextSlot(Slot previousSlot) Returns the Slot a Vehicle standing on this Portal must move to after its next step determined by previousSlot.
boolean	hasOptionalRoute()
boolean	isOpen()
void	open(Rail startRailInTunnel) Opens the Portal by setting the reference to the first Rail in the Tunnel to the Rail given by startRailInTunnel.
void	setFixSlot(Slot fixSlot) Sets the fixSlot of this Portal to the given Slot.
void	setOptionalRoute(Slot optionalRoute) Sets the optionalRoute of this Portal to the given Slot.

Methods inherited from class org.cppftw.trains.model.Slot

acquire, addStation, arrive, checkCollision, depart, getStation, getVehicle, isAcquired, release

Methods inherited from class java.lang.Object

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

Constructor Detail

Portal

public Portal()

Creates a Portal without any Slots connected to it.

Method Detail

getNextSlot

public Slot getNextSlot(Slot previousSlot)

Returns the Slot a Vehicle standing on this Portal must move to after its next step determined by previousSlot. If the Vehicle came from the fixSlot and there is a startRailInTunnel, it moves onto it, otherwise it moves onto the optionalRoute. If the Vehicle came from any other direction, it moves onto the fixSlot.

Specified by:

getNextSlot in class Slot

Parameters:

previousSlot - Slot that determines the direction of movement

Returns:

the Slot to move to

getFixSlot

public Slot getFixSlot()

Returns the reference to the attribute fixSlot.

Returns:

reference to fixSlot of this Portal

setFixSlot

public void setFixSlot(Slot fixSlot)

Sets the fixSlot of this Portal to the given Slot.

Parameters:

fixSlot - the Slot to be set as this Portal's fixRoute

setOptionalRoute

public void setOptionalRoute(Slot optionalRoute)

Sets the optionalRoute of this Portal to the given Slot.

Parameters:

optionalRoute - the Slot to be set as this Portal's optionalRoute

open

public void open(Rail startRailInTunnel)

Opens the Portal by setting the reference to the first Rail in the Tunnel to the Rail given by startRailInTunnel.

Parameters:

startRailInTunnel - the Rail of the Tunnel to be opened

close

public void close()

Closes the Portal by setting the reference to the first Rail in the Tunnel to null.

isOpen

public boolean isOpen()

hasOptionalRoute

public boolean hasOptionalRoute()