org.uob.braveapi.signaller.algorithms.bofan

Class PHDAlgorithmImpl

java.lang.Object

org.uob.braveapi.signaller.Analysis

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

All Implemented Interfaces:

APISignaller

Direct Known Subclasses:

BF, DEJRM, DP, DTBE, FCFS, FLFS, LocalSearch, PermutationLogger, RailMl, TOE

public abstract class PHDAlgorithmImpl
extends Analysis
implements APISignaller

Base class for Bo-Fan's PhD algorithm implementations. This class is a bridge between the API and the algorithms and holds data structures that are common to the algorithms.

Constructor Summary

Constructors

Constructor and Description
PHDAlgorithmImpl()

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	notifyArrival(java.lang.String arrivingTrain, java.util.Date time, java.lang.String stopId) Debug analysis of arrivals.
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	notifyTrain(java.lang.String trainId, double distance, double speed) Notify plugin of the exact location and speed of a train.
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.Analysis

initialise

Methods inherited from class java.lang.Object

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

Constructor Detail

PHDAlgorithmImpl

public PHDAlgorithmImpl()

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)

Initialise the junction, route descriptions and scenario.

Specified by:

initialise in interface APISignaller

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

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

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

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.

notifyTrain

public void notifyTrain(java.lang.String trainId,
                        double distance,
                        double speed)

Description copied from interface: APISignaller

Notify plugin of the exact location and speed of a train.

Specified by:

notifyTrain in interface APISignaller

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

notifyArrival

public void notifyArrival(java.lang.String arrivingTrain,
                          java.util.Date time,
                          java.lang.String stopId)

Debug analysis of arrivals.

Specified by:

notifyArrival in interface APISignaller

Overrides:

notifyArrival in class Analysis