org.cppftw.trains.controller

Class Controller

java.lang.Object

org.cppftw.trains.controller.Controller

public class Controller
extends java.lang.Object

The Controller class represents the Controller in the MVC model. It keeps track of the open Portals, the existing Locomotives, a single Tunnel, and the length of it, which the Controller can change.

Constructor Summary

Constructors

Constructor and Description
Controller() Constructs a controller with empty content.

Method Summary

Modifier and Type	Method and Description
void	addLocomotive(Locomotive locomotive) Adds a locomotive to the game board.
void	addOpenedPortal(Portal portal) Stores the reference of a newly opened Portal.
void	buildMap1(Field field) Builds an example map layout to field.
void	buildMap2(Field field) Builds an example map layout to field.
void	finishTrain(Locomotive locomotive) Removes a train identified by its Locomotive.
void	removeOpenedPortal(Portal portal) Removes a portal which is already opened.
void	setTunnelLength(int length) Sets length as the value to the attribute tunnelLength, which determines the length of the Tunnels, that is, the number of rails in Tunnels to be opened.
boolean	step() Performs a game step.
void	unFinishTrain(Locomotive locomotive) Removes locomotive from the set of finished trains, in case of it was reported as finished by mistake.

Methods inherited from class java.lang.Object

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

Constructor Detail

Controller

public Controller()

Constructs a controller with empty content. Call buildMap1 or buildMap2 to get an example layout.

Method Detail

addOpenedPortal

public void addOpenedPortal(Portal portal)

Stores the reference of a newly opened Portal. If there's another one already open, it also creates a Tunnel between the two.

Parameters:

portal - the Portal to be kept track of

setTunnelLength

public void setTunnelLength(int length)

Sets length as the value to the attribute tunnelLength, which determines the length of the Tunnels, that is, the number of rails in Tunnels to be opened.

Parameters:

length - the length to be set as the length of future Tunnels

finishTrain

public void finishTrain(Locomotive locomotive)

Removes a train identified by its Locomotive. If there are no trains left after the removal, it tells the Player that they won.

Parameters:

locomotive - the Locomotive to be removed

unFinishTrain

public void unFinishTrain(Locomotive locomotive)

Removes locomotive from the set of finished trains, in case of it was reported as finished by mistake.

Parameters:

locomotive - the locomotive to unfinish

step

public boolean step()

Performs a game step.

Returns:

if the game is finished.

removeOpenedPortal

public void removeOpenedPortal(Portal portal)

Removes a portal which is already opened.

Parameters:

portal - the item to remove.

addLocomotive

public void addLocomotive(Locomotive locomotive)

Adds a locomotive to the game board.

Parameters:

locomotive - the item to add.

buildMap1

public void buildMap1(Field field)

Builds an example map layout to field.

Parameters:

field - the map will be placed on field.

buildMap2

public void buildMap2(Field field)

Builds an example map layout to field.

Parameters:

field - the map will be placed on field.