wayside

Class WaysideController

java.lang.Object

wayside.WaysideController

public class WaysideController
extends java.lang.Object

The public interface of all wayside controllers. Since there are multiple WCs all around the track, we represent each of them with an object, adressable by region.

Key Use Case

[Given that PLC has been uploaded]

• Accept Suggested speed and authority per train.
• Validate that this suggested input is safe (the primary job), pass it along to the TrackModel if it is. default to 0 otherwise.
• Determine switches, signals, and crossing to excecute this plan.

Constructor Summary

Constructors

Constructor and Description
WaysideController()

Method Summary

Modifier and Type	Method and Description
static boolean	getAuthority(int blockId) Checks the TrackModel to determine if a block has authority.
static boolean	getCrossing(int blockId) Checks the TrackModel to determine if a block is occupied.
static boolean	getSignal(int blockId) Checks the TrackModel to determine if a switch is active.
static int	getSpeed(int blockId)
static boolean	getSwitch(int blockId) Checks the TrackModel to determine if a switch is active.
static void	init() Initiallizes the WaysideController.
static boolean	isOccupied(int blockId) Checks the TrackModel to determine if a block is occupied.
static void	openWindow() Displays the WC UI.
static boolean	setSwitch(int blockId, boolean value) Accepts a switch position suggestion from CTC.
static void	suggest(Suggestion[] suggestion) How CTC presents a suggestion of speed and authority for each train.

Methods inherited from class java.lang.Object

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

Constructor Detail

WaysideController

public WaysideController()

Method Detail

init

public static void init()

Initiallizes the WaysideController. What is called for the application. Creates a GUI, gets a handle to the real TrackModel, and initializes my map to the Green Line.

openWindow

public static void openWindow()

Displays the WC UI.

suggest

public static void suggest(Suggestion[] suggestion)

How CTC presents a suggestion of speed and authority for each train. The form of this suggestion can be found in the Suggestion class. IMPLEMENTATION SUBJECT TO CHANGE. TODO: throw custom Exception if the WC does not does not have PLC uploaded.

Parameters:

suggestion - an array of Suggestion objects, one for each train.

isOccupied

public static boolean isOccupied(int blockId)

Checks the TrackModel to determine if a block is occupied.

Parameters:

blockId - the line-specific number of the block in question.

Returns:

the occupancy of the block, true if it is occupied, false otherwise.

getSignal

public static boolean getSignal(int blockId)

Checks the TrackModel to determine if a switch is active.

Parameters:

blockId - the line-specific number of the block of the signal in question.

Returns:

the state of the signal, true if it is active, false otherwise.

setSwitch

public static boolean setSwitch(int blockId,
                                boolean value)

Accepts a switch position suggestion from CTC. Will only preserve this suggestion if authority is not requested over it.

Parameters:

blockId - the line-specific number of the block in question.

value - the position which is being requested.

Returns:

the given value.

getSwitch

public static boolean getSwitch(int blockId)

Checks the TrackModel to determine if a switch is active.

Parameters:

blockId - the line-specific number of the block of the switch in question.

Returns:

the state of the swtich, true if it is active, false otherwise.

getCrossing

public static boolean getCrossing(int blockId)

Checks the TrackModel to determine if a block is occupied.

Parameters:

blockId - the line-specific number of the block in question.

Returns:

the occupancy of the block, true if it is occupied, false otherwise.

getAuthority

public static boolean getAuthority(int blockId)

Checks the TrackModel to determine if a block has authority.

Parameters:

blockId - the line-specific number of the block in question.

Returns:

the authority of the block, true if it has authority, false otherwise.

getSpeed

public static int getSpeed(int blockId)