org.uob.braveapi.signaller

Class SimpleExample

java.lang.Object

org.uob.braveapi.signaller.SimpleExample

All Implemented Interfaces:

APISignaller

public class SimpleExample
extends java.lang.Object
implements APISignaller

This is a simple example of a Brave signalling plugin. It is used in the RoutingExample scenario. Three trains enter the scenario. Trains are called S1, S2 and S3. Train S1 is sent forwards on route R1 when it occupies the first track circuit. Train S2 is sent in the reverse direction on route R2 when it occupies the first track circuit. Train S3 is ignored. No route is set for it and the train is forced to stop at the signal.

Constructor Summary

Constructors

Constructor and Description
SimpleExample()

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) Ths initialise method is called when the instance of the APISignaller is first set up.
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) This is an event listener, that will listen for changes to the state of the track circuits (occupations by trains).
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) This method is called each time the simulation clock updates.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleExample

public SimpleExample()

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)

Ths initialise method is called when the instance of the APISignaller is first set up. There is one APISignaller for each junction defined in the 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)

This is an event listener, that will listen for changes to the state of the track circuits (occupations by trains). In this listener, we are checking the name of the track circuit and the train and then setting routes, by calling the setRoute method.

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)

This method is called each time the simulation clock updates. In this simple example, we are printing the elapsed time to the console.

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