gui.entities.sectionEntities.trackEntities

Class Block

java.lang.Object

gui.entities.sectionEntities.Entity

gui.entities.sectionEntities.trackEntities.TrackSegment

gui.entities.sectionEntities.trackEntities.Block

Direct Known Subclasses:

Loop, WarnerBlock

public class Block
extends TrackSegment

Field Summary

Fields

Modifier and Type	Field and Description
int	blockNo blockNo Stores the block number, which is by default -1
int	direction direction Direction of the block.
java.util.ArrayList<Link>	downLinks
static double	minimumBlockLength
SpeedRestrictionList	speedRestrictionList speedRestrictionList
java.util.ArrayList<Link>	upLinks

Fields inherited from class gui.entities.sectionEntities.trackEntities.TrackSegment

endMilePost, maximumPossibleSpeed, startMilePost

Fields inherited from class gui.entities.sectionEntities.Entity

BLOCK_ENTITY, LINK_ENTITY, LOOP_ENTITY

Constructor Summary

Constructors

Constructor and Description
Block()
Block(Block block)
Block(double startMilepost, double endMilepost)
Block(int i)

Method Summary

Methods

Modifier and Type	Method and Description
double	addTinyBlocksToEmptyBlock(Link previousLink, Block iterBlock, Train train, Link nextIterLink, double milepost, boolean enteredOnYellow)
boolean	allowsTrain(Train currTrain, double arrivalTime, java.lang.String TRAIN_TYPE_ALLOWED_ON_THIRD_LINE)
RunTimeReturn	calculateWarnerVelocityProfile(Train train, int signal, double arrivalTime, Block nextBlock, RunTimeReturn runtimereturn, double finalVelocity, double warnerDistance, SimulationInstance simulationInstance, int maxSignalAspectsToBeConsidered)
boolean	checkLastBlock(int i, int j)
BlockDirectionInInterval	getBlockDirectionInInterval()
java.lang.String	getBlockName()
int	getBlockNo()
Signal	getBlockSignal(int direction)
double	getDepartureTimeFromTrainNo(int trainNo)
double	getEarliestArrivalTime(double d, double d1, int i)
double	getEarliestArrivalTime(double arrivalTime, int trainDirection)
Block	getEmptyBlockWithTinyBlocksAdded(Train train, int signal, Link previousLink, Link nextLink, double profileStartingMilePost, boolean enteredOnYellow, boolean enteringNextBlockOnYellow) Add the tiny blocks of the blocks from the startBlock till the signal value number of the blocks into the emptyBlock.
double	getEndMilePost(int direction)
GradientList	getGradientList()
java.lang.String	getGradientsString()
java.util.HashMap<java.lang.Integer,java.lang.Boolean>	getHasPathToBlockMap(int direction)
Interval	getLastIntervalByTrain(Train train)
java.lang.String	getLinkCrossoversString(int direction)
java.lang.String	getLinkLengthsString(int direction)
java.lang.String	getLinkListString(int direction)
java.lang.String	getLinkPrioritiesString(int direction)
static java.util.logging.Logger	getLogger()
double	getMilePostsByNextLink(Link nextLink, Train train, double profileStartingMilePost)
double	getMilePostsByPreviousLink(Link previousLink, Train train, double profileStartingMilePost)
Block	getNextBlock(Train train) 1) It finds a preferred loop or a block as per whether the currentblock has next block as a loop or block.
Block	getNextBlockByDirection(int direction)
Link	getNextLink(Train train)
LinkList	getNextLinks()
LinkList	getNextLinks(int trainDirection)
TinyBlockList	getNightsfsr()
RunTimeReturn	getNonOverlappingRunTimeReturn(Train train, VelocityProfileArray velocityProfileArray, double startMilePost, double endMilePost, double linkMilePost, Link previousLink)
RunTimeReturn	getNonOverlappingRunTimeSignal(Train train, int signal, double startVelocity, double endVelocity, Link previousLink, Link nextLink, double profileStartingMilePost, boolean enteredOnYellow) 1) It does some signal handling.
double	getOccupancyTimeByTrain(Train train)
IntervalArray	getOnlyActualOccupancies()
double	getOverlapDistance(int trainDirection)
RunTimeReturn	getOverlappingRunTimeReturn(Train train, VelocityProfileArray velocityprofilearray, OverlapParameters overlapParameters) Get the RunTimeReturn for the block and the overlapping part of the train after it just exits the block.
Block	getPath(Block block, Train Train, int numberOfSignalAspects)
LinkList	getPreviousLinks()
RunTimeReturn	getRunTimeVelocity(Train Train, double d, double d1)
TinyBlockList	getSfsr()
int	getSignal(Train train, double arrivalTime, boolean consideringHalts, int maxSignalAspectsToBeConsidered, SimulationInstance simulationInstance)
int	getSignalFailFlag()
SignalFailure	getSignalFailure()
java.lang.String	getSpeedLimitEndMilePostsString()
java.lang.String	getSpeedLimitsString()
java.lang.String	getSpeedLimitStartMilePostsString()
SpeedRestrictionList	getSpeedRestrictionList()
java.lang.String	getSpeedRestrictionsString()
double	getStartMilePost(int direction)
java.util.ArrayList<java.lang.Integer>	getTrainNoFromOccupancy(double time, double timeInterval)
VelocityProfileArray	getVelocityProfileArray(Train train, int signal, double startVelocity, double endVelocity, Link nextLink, Link previousLink, double profileStartingMilePost, boolean enteredOnYellow, boolean enteringNextBlockOnYellow)
boolean	hasError()
boolean	hasPath(int trainEndLoopNo, int trainDirection)
boolean	hasPathTo(Block nextBlock, int direction)
boolean	isDirectionOk(Train Train, double arrivalTime)
int	isFree(double d, double d1, double d2, double d3, int i)
boolean	isLoop()
boolean	isSignalFailed(double time)
boolean	isSignalRed(double d)
boolean	isWarner()
void	printOccupancies(int trainNo)
void	readCommonBlockLoopProperties(java.io.StreamTokenizer streamTokenizer)
SpeedRestriction	readSpeedRes(java.io.StreamTokenizer streamtokenizer)
void	reserve(Train train, double arrivalTime, double departureTime, boolean actualOccupancy)
Gradient	returnGradientFormat(double startMilePost, double endMilePost)
double	returnMaxSpeedBetweenMilePosts(double start, double end)
void	setBlockDirectionInInterval(BlockDirectionInInterval blockDirectionInInterval)
void	setBlockName(java.lang.String blockName)
void	setBlockNo(int blockNo)
void	setBlockSignal(int direction, Signal signal)
void	setEndMilePost(double endMilePost)
void	setEndMilePost(int trainDirection, double milepost)
void	setEndMilePostDirectly(double endMilePost)
void	setGradientList(GradientList gradientList)
static void	setLogger(java.util.logging.Logger logger)
void	setNextLinks(LinkList nextBlocks)
void	setNightsfsr(TinyBlockList nightsfsr)
void	setPreviousLinks(LinkList previousBlocks)
void	setSfsr(TinyBlockList sfsr)
void	setSignalFailFlag(int signalFailFlag)
void	setSignalFailure(SignalFailure signalFailure)
void	setSpeedRestrictionList(SpeedRestrictionList speedRestrictionList)
void	setStartMilePost(int trainDirection, double milepost)
void	setWarner(boolean warner)
java.util.ArrayList<Block>	splitBlock(double newMilepost)
SplitProfileForWarner	splitProfileForWarnerDistance(Train train, VelocityProfileArray originalProfile, Block largeBlock, double warnerDistance) Split the profile of the block into two profiles one for the warner distance and other for the rest of the block.
StatusTraverseBlock	traverseBlock(Train train, double arrivalTime, double departureTime, double startVelocity, Link previousLink, Link nextFastestLink, double profileStartingMilePost, SimulationInstance simulationInstance, int nextReferenceLoopNumber)
boolean	waitingPermitted()
double	whenFree(double startTime, double endTime) Consider the block occupancies and determine if the block is free during the interval specified by the startTime and endTime.

Methods inherited from class gui.entities.sectionEntities.trackEntities.TrackSegment

getDirection, getEndMilePost, getLength, getMaximumPossibleSpeed, getOccupanciesToDisplay, getOccupy, getStartMilePost, getTinyBlockList, isFree, isFree, setDirection, setLength, setMaximumPossibleSpeed, setOccupied, setOccupied, setOccupy, setStartMilePost, setTinyBlockList

Methods inherited from class gui.entities.sectionEntities.Entity

getEntityType, isBlock, isLink, setEntityType

Methods inherited from class java.lang.Object

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

Field Detail

minimumBlockLength

public static final double minimumBlockLength

See Also:

Constant Field Values

blockNo

public int blockNo

blockNo Stores the block number, which is by default -1

direction

public int direction

direction Direction of the block. Either up or down or bidirectional.

speedRestrictionList

public SpeedRestrictionList speedRestrictionList

speedRestrictionList

upLinks

public java.util.ArrayList<Link> upLinks

downLinks

public java.util.ArrayList<Link> downLinks

Constructor Detail

Block

public Block(double startMilepost,
     double endMilepost)

Block

public Block()

Block

public Block(int i)

Parameters:

i - loop controller

Block

public Block(Block block)

Method Detail

getHasPathToBlockMap

public java.util.HashMap<java.lang.Integer,java.lang.Boolean> getHasPathToBlockMap(int direction)

setEndMilePost

public void setEndMilePost(double endMilePost)

Overrides:

setEndMilePost in class TrackSegment

setSpeedRestrictionList

public void setSpeedRestrictionList(SpeedRestrictionList speedRestrictionList)

getSpeedRestrictionList

public SpeedRestrictionList getSpeedRestrictionList()

getSpeedRestrictionsString

public java.lang.String getSpeedRestrictionsString()

getGradientsString

public java.lang.String getGradientsString()

readSpeedRes

public SpeedRestriction readSpeedRes(java.io.StreamTokenizer streamtokenizer)
                              throws java.io.IOException,
                                     SimulatorException

Parameters:

streamtokenizer -

Returns:

SpeedRestriction

Throws:

java.io.IOException - : deals with input/output errors

SimulatorException - : deals with Simulation errors

getTrainNoFromOccupancy

public java.util.ArrayList<java.lang.Integer> getTrainNoFromOccupancy(double time,
                                                             double timeInterval)

Parameters:

timeInterval - : stores the time interval

Returns:

get Train number

isFree

public int isFree(double d,
         double d1,
         double d2,
         double d3,
         int i)

Returns:

true if block is free.

whenFree

public double whenFree(double startTime,
              double endTime)

Consider the block occupancies and determine if the block is free during the interval specified by the startTime and endTime. If it is not free, return the ending time of the interval in which "startTime" lies. If the block is free, then check if the direction of the block, if specified by BlockdDirectionInInterval file does not change during the same interval. If it does change then return the ending time of the blockInterval in which startTime lies. If the direction of the block does not change during this interval then return -1.

Parameters:

startTime -

endTime -

Returns:

time when the block is free.

reserve

public void reserve(Train train,
           double arrivalTime,
           double departureTime,
           boolean actualOccupancy)

Parameters:

trainNo - : stores the train number

arrivalTime - : stores the arrival time

departureTime - : stores the departure time

actualOccupancy - : details about the actual occupancy of the train

getStartMilePost

public double getStartMilePost(int direction)

Parameters:

direction -

Returns:

startMilePost depending upon the direction of the block.

getEndMilePost

public double getEndMilePost(int direction)

Parameters:

direction -

Returns:

the endMilePost of the block depending upon its direction.

getDepartureTimeFromTrainNo

public double getDepartureTimeFromTrainNo(int trainNo)

Parameters:

i -

Returns:

endTime of interval

getNextLinks

public LinkList getNextLinks(int trainDirection)

Parameters:

trainDirection -

Returns:

the nextBlocks or previousBlocks depending upon the direction of the block

waitingPermitted

public boolean waitingPermitted()

Returns:

true if waiting is permitted on the block. returns false as of now.

getNextBlock

public Block getNextBlock(Train train)

1) It finds a preferred loop or a block as per whether the currentblock has next block as a loop or block. 2) If the train is scheduled and if the currentBlock is a "block" it calls to see what is the type of next Block by calling getNextBlock(int trainDirection) Block getNextBlock(int trainDirection): 1) Take the nextBlockArray and find the block amongst that for which the link Priority is one. 3) If the nextBlock is indeed a "block" it returns the block corresponding to the link which has priority one. 4) If the nextBlock is a "loop" infact then it finds the preferredLoop from the referenceTable since the train is scheduled. and returns that loop. 5) If the train is not scheduled or the currentBlock is a loop then it returns the nextMainBlock by calling the function getNextMainBlock(trainDirection).

Parameters:

trainDirection -

Train -

Returns:

get next block

getNextBlockByDirection

public Block getNextBlockByDirection(int direction)

Parameters:

i -

Returns:

get the nextMainBlock of the nextBlocks depending upon the direction of the block.

checkLastBlock

public boolean checkLastBlock(int i,
                     int j)

Parameters:

i -

j -

Returns:

?

isSignalRed

public boolean isSignalRed(double d)

Parameters:

d -

Returns:

true if block is not free.

hasPathTo

public boolean hasPathTo(Block nextBlock,
                int direction)

hasPath

public boolean hasPath(int trainEndLoopNo,
              int trainDirection)

Parameters:

block -

trainEndLoopNo -

trainDirection -

Returns:

true if hasPath

getEarliestArrivalTime

public double getEarliestArrivalTime(double arrivalTime,
                            int trainDirection)

Parameters:

arrivalTime -

trainDirection -

Returns:

earliest possible arrival time.

getEarliestArrivalTime

public double getEarliestArrivalTime(double d,
                            double d1,
                            int i)

Parameters:

d -

d1 -

i -

Returns:

get the earliest possible arrival time.

getSignal

public int getSignal(Train train,
            double arrivalTime,
            boolean consideringHalts,
            int maxSignalAspectsToBeConsidered,
            SimulationInstance simulationInstance)

Parameters:

Train -

noOfColor -

arrivalTime -

maxSignalAspectsToBeConsidered -

direction -

Returns:

signal.

getPath

public Block getPath(Block block,
            Train Train,
            int numberOfSignalAspects)

Parameters:

block -

Train -

numberOfSignalAspects -

Returns:

path

getEmptyBlockWithTinyBlocksAdded

public Block getEmptyBlockWithTinyBlocksAdded(Train train,
                                     int signal,
                                     Link previousLink,
                                     Link nextLink,
                                     double profileStartingMilePost,
                                     boolean enteredOnYellow,
                                     boolean enteringNextBlockOnYellow)

Add the tiny blocks of the blocks from the startBlock till the signal value number of the blocks into the emptyBlock.

Parameters:

emptyBlock -

startBlock -

Train -

signal -

previousLink -

nextLink -

profileStartingMilePost -

enteredOnYellow -

enteringNextBlockOnYellow -

afterSighting -

setStartMilePost

public void setStartMilePost(int trainDirection,
                    double milepost)

setEndMilePost

public void setEndMilePost(int trainDirection,
                  double milepost)

getMilePostsByNextLink

public double getMilePostsByNextLink(Link nextLink,
                            Train train,
                            double profileStartingMilePost)

getMilePostsByPreviousLink

public double getMilePostsByPreviousLink(Link previousLink,
                                Train train,
                                double profileStartingMilePost)

getNextLink

public Link getNextLink(Train train)

getNonOverlappingRunTimeSignal

public RunTimeReturn getNonOverlappingRunTimeSignal(Train train,
                                           int signal,
                                           double startVelocity,
                                           double endVelocity,
                                           Link previousLink,
                                           Link nextLink,
                                           double profileStartingMilePost,
                                           boolean enteredOnYellow)

1) It does some signal handling. with signalFailFlag = 0 , 1, 2 which respectively means that the signal has not failed, that the signal has failed in a daytime and that the signal has failed in the night time. So, it respectively adds the tinyblocks of the SpeedRestrictions or SignalFailedSpeedRestrictions or NightSignalFailedSpeedRestrictions 2) It does that for all the blocks that it can find till the signal (i.e. the number of blocks that are free to go at once) by updating the block to getNextBlock(train.direction,train) 3) It then creates an instance of velocityProfileArray for the tinyBlockArrays obtained by calling to the constructor VelocityProfileArray(train, block, startVelocity1, endVelocity1) 4) After having constructed the velocityProfileArray, it creates another instance of VelocityProfileArray namely velocityProfileArray1 which is a velocityProfileArray for the specific block that we are considering. If the GlobalVar.overlap is false: velocityProfileArray1 = velocityprofilearray.returnInterval( startMilePost, endMilePost); 5) The blockVelocityProfileArray, thus returned is given to a RunTimeReturn constructor which notes the time for the block and the velocity with the train enters the block and the velocityProfileArray1 (i.e. the blockVelocityProfileArray), which can be used for further use.

Parameters:

Train -

signal -

d -

startVelocity1 -

endVelocity1 -

previousLink -

nextLink -

profileStartingMilePost -

enteredOnYellow -

Returns:

runTimeSignal... totalTime is -1 if the velocityProfileArray has no velocity profile in it. Its an exceptional case.

getNonOverlappingRunTimeReturn

public RunTimeReturn getNonOverlappingRunTimeReturn(Train train,
                                           VelocityProfileArray velocityProfileArray,
                                           double startMilePost,
                                           double endMilePost,
                                           double linkMilePost,
                                           Link previousLink)

Parameters:

Train -

velocityProfileArray -

linkMilePost -

Returns:

RunTimeReturn from the beginning of the block till only the end of the block and not the overlapping part of the train when the train just exits the block.

getOverlappingRunTimeReturn

public RunTimeReturn getOverlappingRunTimeReturn(Train train,
                                        VelocityProfileArray velocityprofilearray,
                                        OverlapParameters overlapParameters)

Get the RunTimeReturn for the block and the overlapping part of the train after it just exits the block.

Parameters:

Train -

velocityprofilearray -

Returns:

RunTimeReturn from the beginning of the block till the overlapping part of the train

calculateWarnerVelocityProfile

public RunTimeReturn calculateWarnerVelocityProfile(Train train,
                                           int signal,
                                           double arrivalTime,
                                           Block nextBlock,
                                           RunTimeReturn runtimereturn,
                                           double finalVelocity,
                                           double warnerDistance,
                                           SimulationInstance simulationInstance,
                                           int maxSignalAspectsToBeConsidered)

Parameters:

Train -

signal -

arrivalTime -

nextBlock -

runtimereturn -

finalVelocity -

numberOfSignalAspects -

warnerDistance -

maxSignalAspectsToBeConsidered -

Returns:

calculateRecurrenceVelocity

splitProfileForWarnerDistance

public SplitProfileForWarner splitProfileForWarnerDistance(Train train,
                                                  VelocityProfileArray originalProfile,
                                                  Block largeBlock,
                                                  double warnerDistance)

Split the profile of the block into two profiles one for the warner distance and other for the rest of the block. In the end return the startVelocity of the warner profile.

Parameters:

Train -

originalProfile -

largeBlock -

warnerDistance -

Returns:

the start velocity of the warner profile.

getRunTimeVelocity

public RunTimeReturn getRunTimeVelocity(Train Train,
                               double d,
                               double d1)

Parameters:

Train -

d -

d1 -

Returns:

getRunTimeVelocity

traverseBlock

public StatusTraverseBlock traverseBlock(Train train,
                                double arrivalTime,
                                double departureTime,
                                double startVelocity,
                                Link previousLink,
                                Link nextFastestLink,
                                double profileStartingMilePost,
                                SimulationInstance simulationInstance,
                                int nextReferenceLoopNumber)

Parameters:

Train -

arrivalTime -

departureTime -

startVelocity -

nextFastestLink -

nextReferenceLoopNumber -

simulationType -

numberOfSignalAspects -

link -

Returns:

StatusTraverseBlock

isLoop

public boolean isLoop()

Overrides:

isLoop in class Entity

Returns:

true if the block is a loop

isSignalFailed

public boolean isSignalFailed(double time)

Parameters:

time -

Returns:

false if no signal failure is found. Else return true.

isDirectionOk

public boolean isDirectionOk(Train Train,
                    double arrivalTime)

Parameters:

Train -

arrivalTime -

Returns:

true if the block direction is same as the train direction at the given arrival time

addTinyBlocksToEmptyBlock

public double addTinyBlocksToEmptyBlock(Link previousLink,
                               Block iterBlock,
                               Train train,
                               Link nextIterLink,
                               double milepost,
                               boolean enteredOnYellow)

Parameters:

iterLink -

tinyBlockArray -

Train -

iterBlock -

nextIterLink -

milepost -

enteredOnYellow -

allowsTrain

public boolean allowsTrain(Train currTrain,
                  double arrivalTime,
                  java.lang.String TRAIN_TYPE_ALLOWED_ON_THIRD_LINE)

getBlockNo

public int getBlockNo()

setBlockNo

public void setBlockNo(int blockNo)

getBlockName

public java.lang.String getBlockName()

setBlockName

public void setBlockName(java.lang.String blockName)

getBlockSignal

public Signal getBlockSignal(int direction)

setBlockSignal

public void setBlockSignal(int direction,
                  Signal signal)

isWarner

public boolean isWarner()

setWarner

public void setWarner(boolean warner)

getSfsr

public TinyBlockList getSfsr()

setSfsr

public void setSfsr(TinyBlockList sfsr)

getNightsfsr

public TinyBlockList getNightsfsr()

setNightsfsr

public void setNightsfsr(TinyBlockList nightsfsr)

getNextLinks

public LinkList getNextLinks()

setNextLinks

public void setNextLinks(LinkList nextBlocks)

getPreviousLinks

public LinkList getPreviousLinks()

setPreviousLinks

public void setPreviousLinks(LinkList previousBlocks)

getSignalFailFlag

public int getSignalFailFlag()

setSignalFailFlag

public void setSignalFailFlag(int signalFailFlag)

getBlockDirectionInInterval

public BlockDirectionInInterval getBlockDirectionInInterval()

setBlockDirectionInInterval

public void setBlockDirectionInInterval(BlockDirectionInInterval blockDirectionInInterval)

getLogger

public static java.util.logging.Logger getLogger()

setLogger

public static void setLogger(java.util.logging.Logger logger)

getSignalFailure

public SignalFailure getSignalFailure()

setSignalFailure

public void setSignalFailure(SignalFailure signalFailure)

printOccupancies

public void printOccupancies(int trainNo)

returnMaxSpeedBetweenMilePosts

public double returnMaxSpeedBetweenMilePosts(double start,
                                    double end)

returnGradientFormat

public Gradient returnGradientFormat(double startMilePost,
                            double endMilePost)

getGradientList

public GradientList getGradientList()

setGradientList

public void setGradientList(GradientList gradientList)

splitBlock

public java.util.ArrayList<Block> splitBlock(double newMilepost)

hasError

public boolean hasError()

Specified by:

hasError in class Entity

getOverlapDistance

public double getOverlapDistance(int trainDirection)

getOccupancyTimeByTrain

public double getOccupancyTimeByTrain(Train train)

getLastIntervalByTrain

public Interval getLastIntervalByTrain(Train train)

getOnlyActualOccupancies

public IntervalArray getOnlyActualOccupancies()

getVelocityProfileArray

public VelocityProfileArray getVelocityProfileArray(Train train,
                                           int signal,
                                           double startVelocity,
                                           double endVelocity,
                                           Link nextLink,
                                           Link previousLink,
                                           double profileStartingMilePost,
                                           boolean enteredOnYellow,
                                           boolean enteringNextBlockOnYellow)

setEndMilePostDirectly

public void setEndMilePostDirectly(double endMilePost)

readCommonBlockLoopProperties

public void readCommonBlockLoopProperties(java.io.StreamTokenizer streamTokenizer)
                                   throws java.io.IOException

Throws:

java.io.IOException

getLinkListString

public java.lang.String getLinkListString(int direction)

getLinkPrioritiesString

public java.lang.String getLinkPrioritiesString(int direction)

getLinkCrossoversString

public java.lang.String getLinkCrossoversString(int direction)

getLinkLengthsString

public java.lang.String getLinkLengthsString(int direction)

getSpeedLimitsString

public java.lang.String getSpeedLimitsString()

getSpeedLimitStartMilePostsString

public java.lang.String getSpeedLimitStartMilePostsString()

getSpeedLimitEndMilePostsString

public java.lang.String getSpeedLimitEndMilePostsString()