TrainController (test API)

java.lang.Object
- traincontroller.TrainController

All Implemented Interfaces:: TrainControllerInterface

public class TrainController
extends java.lang.Object
implements TrainControllerInterface

Field Summary

Fields
Modifier and Type	Field and Description
`protected static TrainController[]`	`allTrainControllers`
`protected boolean`	`applyBrakes`
`protected boolean`	`applyEBrakes`
`protected boolean`	`coast`
`protected double`	`distanceTraveled`
`protected boolean`	`estop`
`protected int`	`ID`
`protected boolean`	`leftShouldBeOpen`
`protected boolean`	`lightsShouldBeOn`
`protected static int`	`numTrains`
`protected boolean`	`onSwitch`
`protected double`	`Pcmd`
`protected boolean`	`rightShouldBeOpen`
`protected java.lang.String`	`station`
`protected boolean`	`stop`
`protected double`	`t`
`protected MapTracker`	`theMap`
`protected Train`	`theTrain`

Constructor Summary

Constructors
Constructor and Description
`TrainController()`
`TrainController(boolean showUI, Train newTrain, int trainID)`
`TrainController(int trainID)`
`TrainController(Train newTrain, int trackID)`
`TrainController(Train newTrain, int trainID, StaticTrack track, StaticBlock startBlock)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`addTrain(Train newTrain, int trainID)`
`protected void`	`addTrainController(TrainController newTrainController)`
`protected boolean`	`checkBeacon()`
`protected boolean`	`checkForTrain()`
`protected double`	`computeSafeBrake()` Computes the minimum safe braking distance for a train, given its Speed.
`protected double`	`computeSafeSpeed()` Computes the maximum safe speed for a train, given an authority.
`protected void`	`displayStation(java.lang.String name)` Displays Station and the distance to that station.
`protected void`	`doAllUpdates()`
`protected boolean`	`emergencyStop()` Bring the train to a complete stop regardless of circumstances using the ebrake.
`protected int`	`getID()`
`protected int`	`getNumTrains()`
`double`	`getPower()` Computes the necessary power at which to set a train, given an authority.
`double`	`getPower2()`
`protected TrainController`	`getTrainControllerByID(int traincontrollerID)`
`static void`	`initUI()`
`protected boolean`	`justStop()` Bring the train to a complete stop regardless of circumstances as quickly as safely possible.
`static void`	`main(java.lang.String[] args)` Main does nothing.
`protected boolean`	`sendForService()` Does the necessary work to send a train in for maintenance.
`protected byte`	`setDoors(boolean leftOpen, boolean rightOpen)` Commands the Train in question to open their right or left doors.
`protected byte`	`setDoors(int status)`
`protected void`	`setKiKp(double newKi, double newKp)`
`protected void`	`setKu(double newVal)`
`protected boolean`	`setLights(boolean on)` Commands the Train in question to turn their lights on or off.
`protected void`	`setT(double newT)`
`protected double`	`setTemp(double temperature)`
`protected void`	`setTrack(StaticTrack newTrack)`
`static void`	`show()`
`void`	`signalFailure(boolean isFailed)`
`java.lang.String`	`toString()`
`protected void`	`updateDistTraveled()`
`protected void`	`updateStation()`
`protected void`	`updateTime()`
`protected boolean`	`youCanGoNow()` Allow train to start up again.

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

- Field Detail
  - numTrains
```
protected static int numTrains
```
  - allTrainControllers
```
protected static TrainController[] allTrainControllers
```
  - theMap
```
protected MapTracker theMap
```
  - theTrain
```
protected Train theTrain
```
  - onSwitch
```
protected boolean onSwitch
```
  - t
```
protected double t
```
  - Pcmd
```
protected double Pcmd
```
  - distanceTraveled
```
protected double distanceTraveled
```
  - leftShouldBeOpen
```
protected boolean leftShouldBeOpen
```
  - rightShouldBeOpen
```
protected boolean rightShouldBeOpen
```
  - lightsShouldBeOn
```
protected boolean lightsShouldBeOn
```
  - applyBrakes
```
protected boolean applyBrakes
```
  - applyEBrakes
```
protected boolean applyEBrakes
```
  - stop
```
protected boolean stop
```
  - estop
```
protected boolean estop
```
  - coast
```
protected boolean coast
```
  - station
```
protected java.lang.String station
```
  - ID
```
protected int ID
```
- Constructor Detail
  - TrainController
```
public TrainController()
```
  - TrainController
```
public TrainController(int trainID)
```
  - TrainController
```
public TrainController(Train newTrain,
                       int trackID)
```
  - TrainController
```
public TrainController(boolean showUI,
                       Train newTrain,
                       int trainID)
```
  - TrainController
```
public TrainController(Train newTrain,
                       int trainID,
                       StaticTrack track,
                       StaticBlock startBlock)
```
- Method Detail
  - initUI
```
public static void initUI()
```
  - main
```
public static void main(java.lang.String[] args)
```
    Main does nothing.
    
    Parameters:
    
    args - the command line arguments
  - show
```
public static void show()
```
  - setTrack
```
protected void setTrack(StaticTrack newTrack)
```
  - doAllUpdates
```
protected void doAllUpdates()
```
  - updateDistTraveled
```
protected void updateDistTraveled()
```
  - updateTime
```
protected void updateTime()
```
  - checkBeacon
```
protected boolean checkBeacon()
```
  - updateStation
```
protected void updateStation()
```
  - computeSafeBrake
```
protected double computeSafeBrake()
```
    Computes the minimum safe braking distance for a train, given its Speed.
    
    Returns:
    
    is the minimum safe braking distance for the train in question, or -1 if the train is null; NOTE: Could also simply return void and update the train.
  - computeSafeSpeed
```
protected double computeSafeSpeed()
```
    Computes the maximum safe speed for a train, given an authority.
    
    Returns:
    
    is the maximum safe speed for the train in question, or -1 if the train is null; NOTE: Could also simply return void and update the train.
  - getPower
```
public double getPower()
```
    Computes the necessary power at which to set a train, given an authority.
    
    Specified by:
    
    getPower in interface TrainControllerInterface
    
    Returns:
    
    is the power to which the train should be set. If negative, represents number of seconds brake should be applied. NOTE: Could also simply return void and update the train.
  - getPower2
```
public double getPower2()
```
  - setKu
```
protected void setKu(double newVal)
```
  - setKiKp
```
protected void setKiKp(double newKi,
                       double newKp)
```
  - setLights
```
protected boolean setLights(boolean on)
```
    Commands the Train in question to turn their lights on or off.
    
    Parameters:
    
    on - is true if the lights should be on, and false if the lights should be off.
    
    Returns:
    
    true if the lights are on, false if not.
  - setDoors
```
protected byte setDoors(boolean leftOpen,
                        boolean rightOpen)
```
    Commands the Train in question to open their right or left doors.
    
    Parameters:
    
    leftOpen - is true if the left doors should be opened (or remain open); false if the doors should be closed (or remain closed).
    
    rightOpen - is true if the right doors should be opened (or remain open); false if the doors should be closed (or remain closed).
    
    Returns:
    
    status; 0 if both are closed; 1 if only right is open; 2 if only left is open; 3 if both are open.
  - setDoors
```
protected byte setDoors(int status)
```
  - justStop
```
protected boolean justStop()
```
    Bring the train to a complete stop regardless of circumstances as quickly as safely possible.
    
    Returns:
    
    status of variable stop
  - emergencyStop
```
protected boolean emergencyStop()
```
    Bring the train to a complete stop regardless of circumstances using the ebrake.
    
    Returns:
    
    status of variable stop
  - youCanGoNow
```
protected boolean youCanGoNow()
```
    Allow train to start up again.
    
    Returns:
    
    value of stop
  - sendForService
```
protected boolean sendForService()
```
    Does the necessary work to send a train in for maintenance.
    
    Returns:
    
    true if the train is successfully sent for service; false if not.
  - signalFailure
```
public void signalFailure(boolean isFailed)
```
  - displayStation
```
protected void displayStation(java.lang.String name)
```
    Displays Station and the distance to that station.
    
    Parameters:
    
    name - is the name of the station
  - addTrainController
```
protected void addTrainController(TrainController newTrainController)
```
  - getNumTrains
```
protected int getNumTrains()
```
  - getTrainControllerByID
```
protected TrainController getTrainControllerByID(int traincontrollerID)
```
  - getID
```
protected int getID()
```
  - setTemp
```
protected double setTemp(double temperature)
```
  - addTrain
```
protected boolean addTrain(Train newTrain,
                           int trainID)
```
  - checkForTrain
```
protected boolean checkForTrain()
```
  - setT
```
protected void setT(double newT)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TrainController

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

numTrains

allTrainControllers

theMap

theTrain

onSwitch

t

Pcmd

distanceTraveled

leftShouldBeOpen

rightShouldBeOpen

lightsShouldBeOn

applyBrakes

applyEBrakes

stop

estop

coast

station

ID

Constructor Detail

TrainController

TrainController

TrainController

TrainController

TrainController

Method Detail

initUI

main

show

setTrack

doAllUpdates

updateDistTraveled

updateTime

checkBeacon

updateStation

computeSafeBrake

computeSafeSpeed

getPower

getPower2

setKu

setKiKp

setLights

setDoors

setDoors

justStop

emergencyStop

youCanGoNow

sendForService

signalFailure

displayStation

addTrainController

getNumTrains

getTrainControllerByID

getID

setTemp

addTrain

checkForTrain

setT

toString