org.uob.braveapi.signaller

Class FCFS

java.lang.Object

org.uob.braveapi.signaller.Analysis

org.uob.braveapi.signaller.algorithms.bofan.PHDAlgorithmImpl

org.uob.braveapi.signaller.FCFS

All Implemented Interfaces:

APISignaller

Direct Known Subclasses:

FCFS2

public class FCFS
extends PHDAlgorithmImpl
implements APISignaller

First-come first-served algorithm.

Constructor Summary

Constructors

Constructor and Description
FCFS()

Method Summary

Modifier and Type	Method and Description
void	initialise(BraveSignallerContext context, java.lang.String simId, java.lang.String scenarioId, java.util.List<java.lang.String> tdSections, java.util.List<java.lang.String> signals, java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> routeDescriptions, java.util.HashMap<java.lang.String,java.lang.String> trainTypes) Initialise the junction, route descriptions and scenario.
void	notifyRouteInfo(java.lang.String serviceName, java.util.HashMap<java.lang.String,java.lang.String> signalRouteMap, java.util.HashMap<java.lang.String,java.lang.Double> tdSectionDistances, java.util.HashMap<java.lang.String,java.lang.Double> signalDistances, java.util.HashMap<java.lang.Integer,java.lang.Double> stopTimes, java.util.HashMap<java.lang.Double,java.lang.String> stopNames, java.util.ArrayList<SpeedLimit> speedLimits, java.util.ArrayList<Gradient> gradients) Notifies route info.
void	notifyTDSectionOccupation(java.lang.String tdSection, java.lang.String occupyingTrain) Response to the events that we registered for in initialise.
void	notifyTrainServices(java.lang.String trainName, java.lang.String serviceName) Notify that the train has started to operate the specified service
void	update(double elapsedTime, java.util.Date simTime) Update method called once per time step

Methods inherited from class org.uob.braveapi.signaller.algorithms.bofan.PHDAlgorithmImpl

notifyArrival, notifyTrain

Methods inherited from class org.uob.braveapi.signaller.Analysis

initialise

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.uob.braveapi.signaller.api.APISignaller

notifyArrival, notifyTrain

Constructor Detail

FCFS

public FCFS()

Method Detail

initialise

public void initialise(BraveSignallerContext context,
                       java.lang.String simId,
                       java.lang.String scenarioId,
                       java.util.List<java.lang.String> tdSections,
                       java.util.List<java.lang.String> signals,
                       java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> routeDescriptions,
                       java.util.HashMap<java.lang.String,java.lang.String> trainTypes)

Description copied from class: PHDAlgorithmImpl

Initialise the junction, route descriptions and scenario.

Specified by:

initialise in interface APISignaller

Overrides:

initialise in class PHDAlgorithmImpl

tdSections - TDSections in this junction

signals - Signals in this junction

routeDescriptions - HashMap of RouteName and ArrayList of in the route for this junction.

notifyTDSectionOccupation

public void notifyTDSectionOccupation(java.lang.String tdSection,
                                      java.lang.String occupyingTrain)

Response to the events that we registered for in initialise.

Specified by:

notifyTDSectionOccupation in interface APISignaller

Overrides:

notifyTDSectionOccupation in class PHDAlgorithmImpl

notifyTrainServices

public void notifyTrainServices(java.lang.String trainName,
                                java.lang.String serviceName)

Description copied from interface: APISignaller

Notify that the train has started to operate the specified service

Specified by:

notifyTrainServices in interface APISignaller

Overrides:

notifyTrainServices in class PHDAlgorithmImpl

notifyRouteInfo

public void notifyRouteInfo(java.lang.String serviceName,
                            java.util.HashMap<java.lang.String,java.lang.String> signalRouteMap,
                            java.util.HashMap<java.lang.String,java.lang.Double> tdSectionDistances,
                            java.util.HashMap<java.lang.String,java.lang.Double> signalDistances,
                            java.util.HashMap<java.lang.Integer,java.lang.Double> stopTimes,
                            java.util.HashMap<java.lang.Double,java.lang.String> stopNames,
                            java.util.ArrayList<SpeedLimit> speedLimits,
                            java.util.ArrayList<Gradient> gradients)

Description copied from interface: APISignaller

Notifies route info.

Specified by:

notifyRouteInfo in interface APISignaller

Overrides:

notifyRouteInfo in class PHDAlgorithmImpl

Parameters:

serviceName - The name of the train

signalRouteMap - A signal and the corresponding route the train requires.

tdSectionDistances - A list of TDSections on the train's journey, with distances along the journey.

signalDistances - A list of Signals on the train's journey, with distances along the journey.

stopNames - A list of stop IDs indexed by distance.

update

public void update(double elapsedTime,
                   java.util.Date simTime)

Description copied from interface: APISignaller

Update method called once per time step

Specified by:

update in interface APISignaller

Overrides:

update in class PHDAlgorithmImpl