Train

java.lang.Object
- gui.entities.sectionEntities.Entity
- - gui.entities.trainEntities.Train

All Implemented Interfaces:

java.util.Comparator<SimulatorTimeTableEntry>

Direct Known Subclasses:

ScheduledTrain, UnscheduledTrain
```
public abstract class Train
extends Entity
implements java.util.Comparator<SimulatorTimeTableEntry>
```

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`accParam` acceleration in (unit ?)
`double`	`bookedSpeed` BS
`double`	`deceParam` deceleration in (unit ?)
`double`	`departTime` departTime in (unit ?)
`int`	`direction`
`int`	`endLoopNo` endLoopNo
`double`	`length`
`double`	`maximumPossibleSpeed` maximumPossibleSpeed
`int`	`numberofhalts`
`java.lang.String`	`operatingDays`
`int`	`priority`
`java.util.ArrayList<ReferenceTableEntry>`	`refTables` refTables
`boolean`	`scheduled`
`int`	`startLoopNo` startLoopNo
`double`	`startTime` startTime in (unit ?)
`int`	`startTimeInput`
`java.util.Stack<StationToStationScheduler>`	`stationToStationSchedulerStack`
`static java.util.Comparator<Train>`	`trainComparator`
`java.lang.String`	`trainId`
`int`	`trainNo` trainNo stores train number

Fields inherited from class gui.entities.sectionEntities.Entity
BLOCK_ENTITY, LINK_ENTITY, LOOP_ENTITY

Constructor Summary

Constructors
Constructor and Description
`Train()`
`Train(int priority, double startTime, double length, double acceleration, double deceleration)`
`Train(int a, double b, double c, double d, double e, int prior)`
`Train(int dir, int prior, double len)`
`Train(int f, int a, double c, double d, double e)`
`Train(Train simulatorTrain)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compare(SimulatorTimeTableEntry a, SimulatorTimeTableEntry b)`
`void`	`copyTimeTablesFromTrain(Train simulatorTrain, int simulationTimeInstance, SimulationInstance simulationInstance)`
`double`	`getAcceleration()`
`double`	`getAccParam()`
`double`	`getActionableTime()`
`java.util.ArrayList<Block>`	`getBlocksByMaxTimeTaken(SimulationInstance simulationInstance)`
`BlockList`	`getBlocksTraversedByTrain(SimulationInstance simulationInstance)`
`double`	`getBookedSpeed()`
`Loop`	`getCurrentLoop()`
`double`	`getDeceleration()`
`double`	`getDeceParam()`
`double`	`getDepartTime()`
`int`	`getDestinationLoopNumber()`
`int`	`getDirection()`
`java.lang.String`	`getDirectionString()`
`java.awt.Color`	`getDrawColour()`
`int`	`getEndLoopNo()`
`java.lang.String`	`getEndStation()`
`int`	`getLastLoopNo()` Get the loop number of the last loop to be traversed by the train.
`double`	`getLength()`
`double`	`getMaximumPossibleSpeed()`
`Loop`	`getNextReferenceLoop()`
`Loop`	`getOriginLoop()`
`int`	`getPreviousRakeLinkNo()`
`Train`	`getPreviousRakeLinkTrain()`
`int`	`getPriority()`
`int`	`getRakeLinkNo()`
`Train`	`getRakeLinkTrain()`
`ReferenceTableEntry`	`getRefTabEntryFromStationName(java.lang.String stationName)` Get reference table entry from the station name.
`java.util.ArrayList<ReferenceTableEntry>`	`getRefTables()`
`int`	`getSignalFailCounter()`
`int[]`	`getSignalFailedBlocks()`
`int`	`getStartLoopNo()`
`double`	`getStartTime()`
`java.util.ArrayList<SimulatorTimeTableEntry>`	`getTimeTables()`
`java.util.ArrayList<SimulatorTimeTableEntry>`	`getTimeTablesHaltsOnly(SimulationInstance simulationInstance)`
`int`	`getTrainNo()`
`int`	`getVelocity()`
`VelocityProfile`	`getVelocityProfileFromMilepost(double milePost)`
`java.util.ArrayList<VelocityProfile>`	`getVelocityProfileList()`
`boolean`	`hasError()`
`boolean`	`hasReachedDestination()`
`boolean`	`hasScheduledHalt(Loop loop, SimulationInstance simulationInstance)` Determine if the train has a scheduled halt at the loop
`boolean`	`isScheduled()`
`boolean`	`isScheduledTillEnd()`
`boolean`	`isStartLoop(Block block)`
`boolean`	`isSuburban()`
`void`	`printAttributes()`
`void`	`printDiscontinuity()`
`void`	`printPathBlockOccupancies()`
`void`	`printTimeTable()`
`void`	`printVelocityProfileForTrain()`
`static TrainList`	`readTrain(SimulationInstance simulationInstance, boolean hasNoGUI)`
`void`	`setAcceleration(double acceleration)`
`void`	`setAccParam(double accParam)`
`void`	`setBookedSpeed(double bookedSpeed)`
`void`	`setDeceleration(double deceleration)`
`void`	`setDeceParam(double deceParam)`
`void`	`setDepartTime(double departTime)`
`void`	`setDirection(int direction)`
`void`	`setDrawColour(java.awt.Color drawColour)`
`void`	`setEndLoopNo(int endLoopNo)`
`void`	`setEndStation(java.lang.String endStation)`
`void`	`setLength(double length)`
`void`	`setMaximumPossibleSpeed(double maximumPossibleSpeed)`
`void`	`setPreviousRakeLinkNo(int trainNo2)`
`void`	`setPreviousRakeLinkTrain(Train previousRakeLinkTrain)`
`void`	`setPriority(int priority)`
`void`	`setRakeId(java.lang.String rakeId)`
`void`	`setRakeLinkNo(int rakeLinkNo)`
`void`	`setRakeLinkTrain(Train rakeLinkTrain)`
`void`	`setRefTables(java.util.ArrayList<ReferenceTableEntry> refTables)`
`void`	`setScheduled(boolean scheduled)`
`void`	`setScheduledTillEnd(boolean scheduledTillEnd)`
`void`	`setSignalFailCounter(int signalFailCounter)`
`void`	`setSignalFailedBlocks(int[] signalFailedBlocks)`
`void`	`setStartLoopNo(int startLoopNo)`
`void`	`setStartTime(double startTime)`
`void`	`setTimesForVelocityProfiles()`
`void`	`setTimeTables(java.util.ArrayList<SimulatorTimeTableEntry> timeTables)`
`void`	`setTrainNo(int trainNo)`
`abstract void`	`setTrainProperties(java.io.StreamTokenizer trainStreamTokenizer, int nTimeTableEntries)`
`void`	`setVelocity(int velocity)`
`double`	`totalTime()`
`double`	`travelTime()`

Methods inherited from class gui.entities.sectionEntities.Entity
getEntityType, isBlock, isLink, isLoop, setEntityType

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator
equals

Field Detail

startTimeInput
```
public int startTimeInput
```

operatingDays
```
public java.lang.String operatingDays
```

trainId
```
public java.lang.String trainId
```

direction
```
public int direction
```

numberofhalts
```
public int numberofhalts
```

length
```
public double length
```

priority
```
public int priority
```

scheduled
```
public boolean scheduled
```

maximumPossibleSpeed
```
public double maximumPossibleSpeed
```
maximumPossibleSpeed

bookedSpeed
```
public double bookedSpeed
```
BS

accParam
```
public double accParam
```
acceleration in (unit ?)

deceParam
```
public double deceParam
```
deceleration in (unit ?)

trainNo
```
public int trainNo
```
trainNo stores train number

startTime
```
public double startTime
```
startTime in (unit ?)

departTime
```
public double departTime
```
departTime in (unit ?)

startLoopNo
```
public int startLoopNo
```
startLoopNo

endLoopNo
```
public int endLoopNo
```
endLoopNo

refTables

public java.util.ArrayList<ReferenceTableEntry> refTables

refTables

stationToStationSchedulerStack

public java.util.Stack<StationToStationScheduler> stationToStationSchedulerStack

trainComparator

public static java.util.Comparator<Train> trainComparator

Constructor Detail
- Train
```
public Train(int dir,
     int prior,
     double len)
```
  Parameters:
  prior - : priority details
  len - : stores length in (unit ?)
- Train
```
public Train(int a,
     double b,
     double c,
     double d,
     double e,
     int prior)
```
  Parameters:
  a - : stores direction
  b - : start time in (unit ?)
  c - : Length in (unit ?)
  d - : stores acceleration in (unit ?)
  e - : stores decelaration in (unit ?)
  prior - : priority details
- Train
```
public Train(int priority,
     double startTime,
     double length,
     double acceleration,
     double deceleration)
```
- Train
```
public Train(int f,
     int a,
     double c,
     double d,
     double e)
```
  Parameters:
  f - : stores direction
  a - : priority details
  c - : length in (unit ?)
  d - : Acceleration in (unit ?)
  e - : Decelaration in (unit ?)
- Train
```
public Train()
```
- Train
```
public Train(Train simulatorTrain)
```

Method Detail

setLength
```
public void setLength(double length)
```

getLength
```
public double getLength()
```

setAcceleration

public void setAcceleration(double acceleration)

getAcceleration
```
public double getAcceleration()
```

setDeceleration

public void setDeceleration(double deceleration)

getDeceleration
```
public double getDeceleration()
```

setVelocity

public void setVelocity(int velocity)

getVelocity
```
public int getVelocity()
```

setDirection

public void setDirection(int direction)

getDirection
```
public int getDirection()
```

setPriority

public void setPriority(int priority)

getPriority
```
public int getPriority()
```

printAttributes
```
public void printAttributes()
```

getDirectionString

public java.lang.String getDirectionString()

setScheduled

public void setScheduled(boolean scheduled)

isScheduled
```
public boolean isScheduled()
```

setTrainProperties

public abstract void setTrainProperties(java.io.StreamTokenizer trainStreamTokenizer,
                      int nTimeTableEntries)
                                 throws java.io.IOException

Throws:: java.io.IOException

totalTime
```
public double totalTime()
```
Returns:
totalTime

travelTime
```
public double travelTime()
```
Returns:
travelTime

printTimeTable
```
public void printTimeTable()
```

getVelocityProfileFromMilepost

public VelocityProfile getVelocityProfileFromMilepost(double milePost)

readTrain

public static TrainList readTrain(SimulationInstance simulationInstance,
                  boolean hasNoGUI)
                           throws java.io.IOException,
                                  SimulatorException

Parameters:: simulationInstance -; hasNoGUI -
Returns:: list of trains
Throws:: java.io.IOException; SimulatorException

setRakeId

public void setRakeId(java.lang.String rakeId)

setRakeLinkNo

public void setRakeLinkNo(int rakeLinkNo)

getDestinationLoopNumber
```
public int getDestinationLoopNumber()
```
Returns:
the designated loop number of the destination station of the train.

getRefTabEntryFromStationName
```
public ReferenceTableEntry getRefTabEntryFromStationName(java.lang.String stationName)
```
Get reference table entry from the station name.

Parameters:
stationName -

Returns:
the reference entry corresponding to the station name. If there is no such entry return null.

getLastLoopNo
```
public int getLastLoopNo()
```
Get the loop number of the last loop to be traversed by the train.

Returns:
loop number of the destination loop of the train

hasScheduledHalt
```
public boolean hasScheduledHalt(Loop loop,
                       SimulationInstance simulationInstance)
```
Determine if the train has a scheduled halt at the loop

Parameters:
loop -
simulationInstance -

Returns:
true if the train has a scheduled halt else returns false.

printVelocityProfileForTrain

public void printVelocityProfileForTrain()

getVelocityProfileList
```
public java.util.ArrayList<VelocityProfile> getVelocityProfileList()
```
Returns:
ArrayList of VelocityProfile in the order which the train traverses.

printDiscontinuity
```
public void printDiscontinuity()
```

isSuburban
```
public boolean isSuburban()
```

getMaximumPossibleSpeed

public double getMaximumPossibleSpeed()

setMaximumPossibleSpeed

public void setMaximumPossibleSpeed(double maximumPossibleSpeed)

getBookedSpeed
```
public double getBookedSpeed()
```

setBookedSpeed

public void setBookedSpeed(double bookedSpeed)

getAccParam
```
public double getAccParam()
```

setAccParam

public void setAccParam(double accParam)

getDeceParam
```
public double getDeceParam()
```

setDeceParam

public void setDeceParam(double deceParam)

getTrainNo
```
public int getTrainNo()
```

setTrainNo
```
public void setTrainNo(int trainNo)
```

getStartTime
```
public double getStartTime()
```

setStartTime

public void setStartTime(double startTime)

getDepartTime
```
public double getDepartTime()
```

setDepartTime

public void setDepartTime(double departTime)

getStartLoopNo
```
public int getStartLoopNo()
```

setStartLoopNo

public void setStartLoopNo(int startLoopNo)

getEndLoopNo
```
public int getEndLoopNo()
```

setEndLoopNo

public void setEndLoopNo(int endLoopNo)

getEndStation

public java.lang.String getEndStation()

setEndStation

public void setEndStation(java.lang.String endStation)

getDrawColour
```
public java.awt.Color getDrawColour()
```

setDrawColour

public void setDrawColour(java.awt.Color drawColour)

getTimeTables

public java.util.ArrayList<SimulatorTimeTableEntry> getTimeTables()

setTimeTables

public void setTimeTables(java.util.ArrayList<SimulatorTimeTableEntry> timeTables)

getRefTables

public java.util.ArrayList<ReferenceTableEntry> getRefTables()

setRefTables

public void setRefTables(java.util.ArrayList<ReferenceTableEntry> refTables)

getSignalFailedBlocks
```
public int[] getSignalFailedBlocks()
```

setSignalFailedBlocks

public void setSignalFailedBlocks(int[] signalFailedBlocks)

getSignalFailCounter
```
public int getSignalFailCounter()
```

setSignalFailCounter

public void setSignalFailCounter(int signalFailCounter)

printPathBlockOccupancies

public void printPathBlockOccupancies()

copyTimeTablesFromTrain

public void copyTimeTablesFromTrain(Train simulatorTrain,
                           int simulationTimeInstance,
                           SimulationInstance simulationInstance)

hasError
```
public boolean hasError()
```
Specified by:

hasError in class Entity

setTimesForVelocityProfiles

public void setTimesForVelocityProfiles()

getBlocksTraversedByTrain

public BlockList getBlocksTraversedByTrain(SimulationInstance simulationInstance)

getBlocksByMaxTimeTaken

public java.util.ArrayList<Block> getBlocksByMaxTimeTaken(SimulationInstance simulationInstance)

getTimeTablesHaltsOnly

public java.util.ArrayList<SimulatorTimeTableEntry> getTimeTablesHaltsOnly(SimulationInstance simulationInstance)

isStartLoop

public boolean isStartLoop(Block block)

compare

public int compare(SimulatorTimeTableEntry a,
          SimulatorTimeTableEntry b)

Specified by:: compare in interface java.util.Comparator<SimulatorTimeTableEntry>

isScheduledTillEnd
```
public boolean isScheduledTillEnd()
```

setScheduledTillEnd

public void setScheduledTillEnd(boolean scheduledTillEnd)

getActionableTime
```
public double getActionableTime()
```

getNextReferenceLoop
```
public Loop getNextReferenceLoop()
```

getOriginLoop
```
public Loop getOriginLoop()
```

hasReachedDestination

public boolean hasReachedDestination()

getRakeLinkNo
```
public int getRakeLinkNo()
```

getPreviousRakeLinkNo
```
public int getPreviousRakeLinkNo()
```

setPreviousRakeLinkNo

public void setPreviousRakeLinkNo(int trainNo2)

getRakeLinkTrain
```
public Train getRakeLinkTrain()
```

setRakeLinkTrain

public void setRakeLinkTrain(Train rakeLinkTrain)

getPreviousRakeLinkTrain

public Train getPreviousRakeLinkTrain()

setPreviousRakeLinkTrain

public void setPreviousRakeLinkTrain(Train previousRakeLinkTrain)

getCurrentLoop
```
public Loop getCurrentLoop()
```

Class Train

Field Summary

Fields inherited from class gui.entities.sectionEntities.Entity

Constructor Summary

Method Summary

Methods inherited from class gui.entities.sectionEntities.Entity

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Comparator

Field Detail

startTimeInput

operatingDays

trainId

direction

numberofhalts

length

priority

scheduled

maximumPossibleSpeed

bookedSpeed

accParam

deceParam

trainNo

startTime

departTime

startLoopNo

endLoopNo

refTables

stationToStationSchedulerStack

trainComparator

Constructor Detail

Train

Train

Train

Train

Train

Train

Method Detail

setLength

getLength

setAcceleration

getAcceleration

setDeceleration

getDeceleration

setVelocity

getVelocity

setDirection

getDirection

setPriority

getPriority

printAttributes

getDirectionString

setScheduled

isScheduled

setTrainProperties

totalTime

travelTime

printTimeTable

getVelocityProfileFromMilepost

readTrain

setRakeId

setRakeLinkNo

getDestinationLoopNumber

getRefTabEntryFromStationName

getLastLoopNo

hasScheduledHalt

printVelocityProfileForTrain

getVelocityProfileList

printDiscontinuity

isSuburban

getMaximumPossibleSpeed

setMaximumPossibleSpeed

getBookedSpeed

setBookedSpeed

getAccParam

setAccParam

getDeceParam

setDeceParam

getTrainNo

setTrainNo

getStartTime