org.uob.braveapi.signaller

Class SignalFailExample

java.lang.Object

org.uob.braveapi.signaller.SignalFailExample

All Implemented Interfaces:

APISignaller

public class SignalFailExample
extends java.lang.Object
implements APISignaller

This is an example of a signal failure. It should be assigned to a network with a junction that contains no signals, because the plugin is not controlling signals. Rather it is just calling the disrupt method on the interlocking at the required time.

Constructor Summary

Constructors

Constructor and Description
SignalFailExample()

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)
void	notifyArrival(java.lang.String arrivingTrain, java.util.Date time, java.lang.String stopId) Notify that the specified train arrives at the specified stopId
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) Notify the algorithm that the specified TDSection has been occupied by the specified train
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 java.lang.Object

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

Constructor Detail

SignalFailExample

public SignalFailExample()

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)

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)

Description copied from interface: APISignaller

Notify the algorithm that the specified TDSection has been occupied by the specified train

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.

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)

Description copied from interface: APISignaller

Notify that the specified train arrives at the specified stopId

Specified by:

notifyArrival in interface APISignaller

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