simulator.scheduler

Class BlockScheduler

java.lang.Object

simulator.scheduler.BlockScheduler

public class BlockScheduler
extends java.lang.Object

BlockScheduler.

Field Summary

Fields

Modifier and Type	Field and Description
SimulationInstance	simulationInstance

Constructor Summary

Constructors

Constructor and Description
BlockScheduler(Block block, Train Train, SimulationInstance simulationInstance) blockSchedulingParameters

Method Summary

Methods

Modifier and Type	Method and Description
double	calculateFinalVelocity(Link link, int signal) Get the final velocity for the scheduling of the train.
double	calculateMaxSpeedOfTrain(Block block) Get the maximum speed of the train for the block it would overlap into while just exiting the currentBlock.
double	calculateTotalTimeTillEnd(RunTimeReturn runTimeReturn, Block nextBlock, double arrivalTime, Link nextLink, double profileStartingMilePost, OverlapParameters overlapParameters, boolean enteredOnYellow) Calculate the time since the head of the train leaves the currentBlock till the tail of the train leaves currentBlock.
double	calDepTimeForSchedTrainHalt(double arrivalTime) Determine the time when a scheduled train should leave a station of halt.
StatusTraverseBlock	computeEarliestFreeTimeSTP(Link previousLink, Link nextLink, int nFreeBlocksToBeTraversed, double arrivalTime, double departureTime, double totalTimeTillEnd, double startVelocity, boolean linkPriorityIsNotOne, double profileStartingMilePost, int nextReferenceLoopNumber)
simulator.scheduler.BlockScheduler.BlockSchedulingParameters	determineBlockSchedulingParameters(Link previousLink, Link nextLink, double arrivalTime, double startVelocity, boolean linkPriorityIsNotOne, double departureTime, double profileStartingMilePost, int maxSignalAspectsToBeConsidered)
boolean	determineEnteredOnYellow(Block block, Train train, double arrivalTime)
simulator.scheduler.BlockScheduler.LastOverlapBlock	getLastOverlapBlock(Block blockIter, OverlapParameters overlapParameters)
RunTimeReturn	getRunTimeReturnConsideringWarner(Link link, int signal, double arrivalTime, boolean linkPriorityIsNotOne, RunTimeReturn runTimeReturn, double warnerDistance, int maxSignalAspectsToBeConsidered) If there is a need to consider the warner distance, get the new RunTimeReturn for the modified block considering the warner distance
StatusTraverseBlock	handleDepTimeGreaterThanArrTime(double departureTime, double arrivalTime, double startVelocity, Link previousLink, Link nextFastestLink2, double profileStartingMilePost, int nextReferenceLoopNumber) Handle the cases in which departure time is greater than the arrival time
StatusTraverseBlock	handleRedSignal(double arrivalTime)
StatusTraverseBlock	handleSignalFailure(Link link, double departureTime)
boolean	hasNoNextBlockToTraverse()
boolean	hasReachedDestinationStation() Determine if currenTrain has reached its destination station
boolean	hasReachedOverlapEndDistance(Block block, OverlapParameters overlapParameters) Determine if the block depending upon the train's direction covers the Global.overlapEndDistance
boolean	isNextBlockLastBlock()
void	reserveBlocks(Link nextLink, Link previousLink, int nFreeBlocksToBeReserved, double arrivalTime, double departureTime, double totalTimeTillEnd, VelocityProfileArray blockVelocityProfileArray, VelocityProfileArray previousLinkVelocityProfileArray, int signal)
StatusTraverseBlock	reserveBlocksAndGetCurrentSTP(Link nextLink, Link previousLink, double tempDepartureTime, RunTimeReturn runtimereturn, int nFreeBlocksToBeTraversed, double arrivalTime, double totalTimeTillEnd, int signal, double profileStartingMilePost, int nextReferenceLoopNumber) Get the StatusTraverseBlock for the current block if the scheduling for the next block is successful.
boolean	sawRedSignal(double arrivalTime)
OverlapParameters	setOverlapParameters(Link nextLink, double profileStartingMilePost) Set the overlapStartDistance, overlapEndDistance and overlap boolean depending upon the block and the train.
StatusTraverseBlock	traverseBlock(double arrivalTime, double departureTime, double startVelocity, Link previousLink, Link nextFastestLink2, double profileStartingMilePost, int nextReferenceLoopNumber) BlockScheduler: StatusTraverseBlock traverseBlock(arrivalTime, deptTime, startVelocity) 1) if there is no next block it traverses the last block: traverseLastBlock(arrivalTime, startVelocity) 2) if got a redSignal it handles that with : handleRedSignal(arrivalTime); Then it calls the getSortedLinks.
StatusTraverseBlock	traverseLastBlock(double arrivalTime, double startVelocity, Link previousLink, double profileStartingMilePost)
StatusTraverseBlock	traversePath(Link previousLink, Link nextLink, double arrivalTime, double departureTime, double startVelocity, boolean linkPriorityIsNotOne, int maxSignalAspectsToBeConsidered, double profileStartingMilePost, int nextReferenceLoopNumber) 1) It first finds what is the signal of the block for the train and the arrival time by calling currentBlock.getSignal(currentTrain, noOfColor, arrivalTime,currentTrain.direction); 2) It first tries to find the running time required to traverse the path, by going to currentBlock.getRunTimeSignal(currentTrain, j, arrivalTime, startVelocity, !linkPriorityIsOne ? link.nextBlock.maximumPossibleSpeed : 0.0D); and setting that value in runTimeReturn 3) If the simulation is in the signalFailureMode or if the linkPriority is one it resets the runTimeReturn to a block whose starting milePost is the same but the endMilePost is the actual endMilePost minus the warnerDistance.

Methods inherited from class java.lang.Object

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

Field Detail

simulationInstance

public SimulationInstance simulationInstance

Constructor Detail

BlockScheduler

public BlockScheduler(Block block,
              Train Train,
              SimulationInstance simulationInstance)

blockSchedulingParameters

Method Detail

hasReachedDestinationStation

public boolean hasReachedDestinationStation()

Determine if currenTrain has reached its destination station

Returns:

true if the currentTrain has reached its destination station.

hasNoNextBlockToTraverse

public boolean hasNoNextBlockToTraverse()

Returns:

true if there is no next block to be considered. If the simulation is over or current block has no next block return true.

sawRedSignal

public boolean sawRedSignal(double arrivalTime)

Parameters:

arrivalTime -

Returns:

true if currentBlock has red signal at the arrival time

handleDepTimeGreaterThanArrTime

public StatusTraverseBlock handleDepTimeGreaterThanArrTime(double departureTime,
                                                  double arrivalTime,
                                                  double startVelocity,
                                                  Link previousLink,
                                                  Link nextFastestLink2,
                                                  double profileStartingMilePost,
                                                  int nextReferenceLoopNumber)

Handle the cases in which departure time is greater than the arrival time

Parameters:

departureTime -

arrivalTime -

startVelocity -

previousLink -

nextFastestLink2 -

nextReferenceLoopNumber -

Returns:

null in exceptional cases.

calDepTimeForSchedTrainHalt

public double calDepTimeForSchedTrainHalt(double arrivalTime)

Determine the time when a scheduled train should leave a station of halt. It follows basic rules like a train should not leave a scheduled halt before its departure time. Also, if a train arrives at a station late then it should wait at the station for the pre-specified duration of waiting time.

Parameters:

arrivalTime -

Returns:

departure time for a scheduled train at a halt. returns 0 if the train is not scheduled or the currentBlock is not a loop.

traverseBlock

public StatusTraverseBlock traverseBlock(double arrivalTime,
                                double departureTime,
                                double startVelocity,
                                Link previousLink,
                                Link nextFastestLink2,
                                double profileStartingMilePost,
                                int nextReferenceLoopNumber)

BlockScheduler: StatusTraverseBlock traverseBlock(arrivalTime, deptTime, startVelocity) 1) if there is no next block it traverses the last block: traverseLastBlock(arrivalTime, startVelocity) 2) if got a redSignal it handles that with : handleRedSignal(arrivalTime); Then it calls the getSortedLinks. 3) if the train is not supposed to wait, then it just zooms past the block. 4) Otherwise it waits for prescheduled waiting time obtained using ReferenceTimeTable. 5) Then if the scheduled departure time exceeds the 24hrs limit it returns a StatusTraverseBlock which says that the limit is reached. 6) if the link priority selected is 1 then it marks its flag as true. 7) then it goes to traversePath(link, arrivalTime, tempDepartureTime, startVelocity, flag2, GlobalVar.numberOfSignalAspects);

Parameters:

arrivalTime -

departureTime -

startVelocity -

nextFastestLink2 -

nextReferenceLoopNumber -

j -

link2 -

Returns:

StatusTraverseBlock

traverseLastBlock

public StatusTraverseBlock traverseLastBlock(double arrivalTime,
                                    double startVelocity,
                                    Link previousLink,
                                    double profileStartingMilePost)

Parameters:

arrivalTime -

startVelocity -

Train -

previousLink -

profileStartingMilePost -

Returns:

StatusTraverseBlock

determineEnteredOnYellow

public boolean determineEnteredOnYellow(Block block,
                               Train train,
                               double arrivalTime)

handleRedSignal

public StatusTraverseBlock handleRedSignal(double arrivalTime)

Parameters:

arrivalTime -

Returns:

StatusTraverseBlock with a false status and arrival and departureTimes to be the earliestArrivalTime possible for the currentBlock

getRunTimeReturnConsideringWarner

public RunTimeReturn getRunTimeReturnConsideringWarner(Link link,
                                              int signal,
                                              double arrivalTime,
                                              boolean linkPriorityIsNotOne,
                                              RunTimeReturn runTimeReturn,
                                              double warnerDistance,
                                              int maxSignalAspectsToBeConsidered)

If there is a need to consider the warner distance, get the new RunTimeReturn for the modified block considering the warner distance

Parameters:

link -

signal -

arrivalTime -

linkPriorityIsNotOne -

runTimeReturn -

Returns:

RunTimeReturn if the warner distance is considered. Else returns null.

calculateFinalVelocity

public double calculateFinalVelocity(Link link,
                            int signal)

Get the final velocity for the scheduling of the train. If the train can go with top priority link it may go at the fullest speed allowed.

Parameters:

link -

Returns:

finalVelocity of the profile of the train to be calculated.

determineBlockSchedulingParameters

public simulator.scheduler.BlockScheduler.BlockSchedulingParameters determineBlockSchedulingParameters(Link previousLink,
                                                                                              Link nextLink,
                                                                                              double arrivalTime,
                                                                                              double startVelocity,
                                                                                              boolean linkPriorityIsNotOne,
                                                                                              double departureTime,
                                                                                              double profileStartingMilePost,
                                                                                              int maxSignalAspectsToBeConsidered)

traversePath

public StatusTraverseBlock traversePath(Link previousLink,
                               Link nextLink,
                               double arrivalTime,
                               double departureTime,
                               double startVelocity,
                               boolean linkPriorityIsNotOne,
                               int maxSignalAspectsToBeConsidered,
                               double profileStartingMilePost,
                               int nextReferenceLoopNumber)

1) It first finds what is the signal of the block for the train and the arrival time by calling currentBlock.getSignal(currentTrain, noOfColor, arrivalTime,currentTrain.direction); 2) It first tries to find the running time required to traverse the path, by going to currentBlock.getRunTimeSignal(currentTrain, j, arrivalTime, startVelocity, !linkPriorityIsOne ? link.nextBlock.maximumPossibleSpeed : 0.0D); and setting that value in runTimeReturn 3) If the simulation is in the signalFailureMode or if the linkPriority is one it resets the runTimeReturn to a block whose starting milePost is the same but the endMilePost is the actual endMilePost minus the warnerDistance. This it does by runtimereturn = currentBlock.calculateRecurrenceVelocity( currentTrain, signal, arrivalTime, link.nextBlock, runtimereturn, 0.0D); Block: RunTimeReturn calculateRecurrenceVelocity(currentTrain, signal, arrivalTime, link.nextBlock, runtimereturn, 0.0D) 4) If the train is scheduled and the currentBlock is a loop, then it checks in the trainReferenceTable if the train has to halt at the station. It does so by checking against the entries of the train, the stationName of the loop. If the train has to halt, it signals a yellow so that the train will have to stop at the station. The departure time will be the startTime + runTimeReturn.totalTime, meaning that the departureTime is now set to the arrivalTime of the train in the block plus the time taken by the train to traverse the block which in this case is the loop. If the train does not have to halt, then it gives the train the required signal gotten from currentBlock.getSignal function. The departureTime is arrivalTime + runTimeReturn.totalTime + GlobalVar.minTime (which is the minimum time a train should take to traverse any block). If the train is not scheduled or the currentBlock is just a "block" is the same case as the case where the scheduled train does not have to halt. 5) It then marks the overlap region. The overlapStartDistance is the beginning of the block where the train hits first. The overlapEndDistance is the start of the block plus the length of the train plus some minimum distance. It sets the GlobalVar.overlap to be true. 6) Then it makes sure that the GlobalVar.overlapEndDistance fits between the distance of the last loop that the train will face. For scheduled trains it is the referenceTable's last station entry's preferredLoop and for the unscheduled train it is the train.endLoopNo. 7) Then it loops over block2 by updating it to the getNextBlock along the trainDirection and finds the last such block. If that lastBlock is a loop it checks the arrivalTime and departureTime of the train at the loop's station and accordingly sets the endVelocity of the train.

Parameters:

link -

tempLink -

arrivalTime -

departureTime -

startVelocity -

linkPriorityIsNotOne -

numberOfColour -

profileStartingMilePost -

nextReferenceLoopNumber -

Returns:

StatusTraverseBlock

calculateTotalTimeTillEnd

public double calculateTotalTimeTillEnd(RunTimeReturn runTimeReturn,
                               Block nextBlock,
                               double arrivalTime,
                               Link nextLink,
                               double profileStartingMilePost,
                               OverlapParameters overlapParameters,
                               boolean enteredOnYellow)

Calculate the time since the head of the train leaves the currentBlock till the tail of the train leaves currentBlock.

Parameters:

runTimeReturn -

nextBlock -

arrivalTime -

profileStartingMilePost -

enteredOnYellow -

Returns:

time between the exiting time instances of the head and tail of the currentTrain from currentBlock

isNextBlockLastBlock

public boolean isNextBlockLastBlock()

Returns:

true if the next block to be traversed is the last one. Else return false.

reserveBlocksAndGetCurrentSTP

public StatusTraverseBlock reserveBlocksAndGetCurrentSTP(Link nextLink,
                                                Link previousLink,
                                                double tempDepartureTime,
                                                RunTimeReturn runtimereturn,
                                                int nFreeBlocksToBeTraversed,
                                                double arrivalTime,
                                                double totalTimeTillEnd,
                                                int signal,
                                                double profileStartingMilePost,
                                                int nextReferenceLoopNumber)

Get the StatusTraverseBlock for the current block if the scheduling for the next block is successful. In that case, the corresponding blocks should also be reserved. If the scheduling for next block is unsuccessful, it should return a StatusTraverseBlock with false status.

Parameters:

link -

previousLink -

tempDepartureTime -

runtimereturn -

nFreeBlocksToBeTraversed -

arrivalTime -

totalTimeTillEnd -

signal -

profileStartingMilePost -

nextReferenceLoopNumber -

Returns:

StatusTraverseBlock with true or false status depending upon the successful scheduling of train on next block.

handleSignalFailure

public StatusTraverseBlock handleSignalFailure(Link link,
                                      double departureTime)

Parameters:

link -

departureTime -

Returns:

StatusTraverseBlock with signal -2, suggesting signal failure. returns null if there is no signal failure.

computeEarliestFreeTimeSTP

public StatusTraverseBlock computeEarliestFreeTimeSTP(Link previousLink,
                                             Link nextLink,
                                             int nFreeBlocksToBeTraversed,
                                             double arrivalTime,
                                             double departureTime,
                                             double totalTimeTillEnd,
                                             double startVelocity,
                                             boolean linkPriorityIsNotOne,
                                             double profileStartingMilePost,
                                             int nextReferenceLoopNumber)

Parameters:

link -

nFreeBlocksToBeTraversed -

arrivalTime -

departureTime -

totalTimeTillEnd -

startVelocity -

linkPriorityIsNotOne -

profileStartingMilePost -

nextReferenceLoopNumber -

Returns:

If any block till the lastOverlapping Block is not free then "traversePath" the train only until that particular block, else if the currentBlock is not free retry with the earliestArrivalTime of the currentBlock. If neither of the above situations is reached,return null.

getLastOverlapBlock

public simulator.scheduler.BlockScheduler.LastOverlapBlock getLastOverlapBlock(Block blockIter,
                                                                      OverlapParameters overlapParameters)

Parameters:

blockIter -

overlapParameters -

Returns:

LastOverlapBlock such that the last block from the currentBlock which the currentTrain will overlap while just exiting the currentBlock

calculateMaxSpeedOfTrain

public double calculateMaxSpeedOfTrain(Block block)

Get the maximum speed of the train for the block it would overlap into while just exiting the currentBlock.

Parameters:

block -

Returns:

calculate maximum speed of the train for the last block it would overlap onto while exiting the currentBlock.

hasReachedOverlapEndDistance

public boolean hasReachedOverlapEndDistance(Block block,
                                   OverlapParameters overlapParameters)

Determine if the block depending upon the train's direction covers the Global.overlapEndDistance

Parameters:

block -

Returns:

true if the block covers the Global overlapEndDistance

setOverlapParameters

public OverlapParameters setOverlapParameters(Link nextLink,
                                     double profileStartingMilePost)

Set the overlapStartDistance, overlapEndDistance and overlap boolean depending upon the block and the train.

Parameters:

nextLink -

profileStartingMilePost -

reserveBlocks

public void reserveBlocks(Link nextLink,
                 Link previousLink,
                 int nFreeBlocksToBeReserved,
                 double arrivalTime,
                 double departureTime,
                 double totalTimeTillEnd,
                 VelocityProfileArray blockVelocityProfileArray,
                 VelocityProfileArray previousLinkVelocityProfileArray,
                 int signal)

Parameters:

link -

i -

arrivalTime -

departureTime -

totalTimeForRestOfPath -

velocityProfileArray -

velocityProfileArray2 -

signal -