org.cppftw.trains.model

Class Switch

java.lang.Object

org.cppftw.trains.model.Slot

org.cppftw.trains.model.Switch

public class Switch
extends Slot

The class Switch represents a railway switch. A Switch has a single fixed neighboring Slot, and a list of Slots the User can choose from while the Switch isn't occupied.

Constructor Summary

Constructors

Constructor and Description
Switch(int numberOfOptions) Creates a Switch with all options and its fixSlotset as the single instance of Ground.

Method Summary

Modifier and Type	Method and Description
Slot	getNextSlot(Slot previousSlot) Returns the Slot a Vehicle standing on this Switch must move to after its next step determined by previousSlot.
int	getNumberOfOptions() Returns the number of selectable options connected to this Rail.
int	getSelectedOption()
void	setFixSlot(Slot fixSlot) Sets the fixSlot of this Switch to the given Slot.
void	setOption(int index, Slot newOption) Adds a new Slot to the selectable list of options.
void	switchTo(int selectedOption) Selects the Slot that is the Nth element of options, where N=selectedOption+1 to be the active optional Slot of this Slot.
void	switchToNext()

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

Switch

public Switch(int numberOfOptions)

Creates a Switch with all options and its fixSlotset as the single instance of Ground. The number of its options is determined by the parameter numberOfOptions.

Parameters:

numberOfOptions - the number of options.

Method Detail

getNextSlot

public Slot getNextSlot(Slot previousSlot)

Returns the Slot a Vehicle standing on this Switch must move to after its next step determined by previousSlot. If the Vehicle came from the fixSlot it moves to the Slot that is the Nth element of options where N=selectedOption+1, otherwise it moves onto fixSlot.

Specified by:

getNextSlot in class Slot

Parameters:

previousSlot - Slot that determines the direction of movement

Returns:

the Slot to move to

getNumberOfOptions

public int getNumberOfOptions()

Returns the number of selectable options connected to this Rail.

Returns:

the length of the options array

setFixSlot

public void setFixSlot(Slot fixSlot)

Sets the fixSlot of this Switch to the given Slot.

Parameters:

fixSlot - the Slot to be set as this Switch's fixSlot

setOption

public void setOption(int index,
                      Slot newOption)

Adds a new Slot to the selectable list of options. If the Slot is already present in the list, it's not added.

Parameters:

index - which option is altered

newOption - the Slot to be added

Throws:

java.lang.IllegalArgumentException - if N is not in the specified domain, that is, there is no optional Slot identified by index in options

switchTo

public void switchTo(int selectedOption)
              throws java.lang.UnsupportedOperationException,
                     java.lang.IllegalArgumentException

Selects the Slot that is the Nth element of options, where N=selectedOption+1 to be the active optional Slot of this Slot. 1<=N1<=(size of options).

Parameters:

selectedOption - the number of the optional Slot to be selected

Throws:

java.lang.UnsupportedOperationException - if this Switch is currently occupied

java.lang.IllegalArgumentException - if N is not in the specified domain, that is, there is no optional Slot identified by selectedOption in options

getSelectedOption

public int getSelectedOption()

switchToNext

public void switchToNext()