Train (test API)

java.lang.Object
- trainmodel.Train

public class Train
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected TrackModel`	`_tm`
`protected double`	`acceleration`
`protected int`	`authority`
`protected boolean`	`brakeFailure`
`protected boolean`	`emergencyBrake`
`protected double`	`emergencyBrakeRate`
`protected boolean`	`engineFailure`
`protected java.text.NumberFormat`	`formatter`
`protected double`	`friction`
`protected double`	`grade`
`protected double`	`gravity`
`protected TrainModelGUI`	`gui`
`protected double`	`height`
`protected int`	`leftDoor`
`protected double`	`length`
`protected boolean`	`lights`
`protected double`	`mass`
`protected double`	`maxAcceleration`
`protected int`	`maxPassengers`
`protected double`	`maxPower`
`protected double`	`maxVelocity`
`protected int`	`numCars`
`protected int`	`numCrew`
`protected int`	`numPassengers`
`protected double`	`passengerWeight`
`protected double`	`power`
`protected int`	`rightDoor`
`protected boolean`	`serviceBrake`
`protected double`	`serviceBrakeRate`
`protected boolean`	`signalFailure`
`protected double`	`temperature`
`protected int`	`time`
`protected double`	`totalForce`
`protected double`	`totalMass`
`protected TrainController`	`trainController`
`protected double`	`velocity`
`protected double`	`width`

Constructor Summary

Constructors
Constructor and Description
`Train(int newTrainId, int newblockId)`
`Train(int newTrainId, int newblockId, TrackModel _tm)`
`Train(int newTrainId, int newblockId, TrackModel _tm, int test)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`blockChange()` Method for the train controller to see if the train has changed blocks
`void`	`brakeFailureMode(boolean status)` Turn brake failure on/off
`void`	`engineFailureMode(boolean status)` Turn engine failure on/off
`boolean`	`getAuthority()` Method for the Train Controller to see the authority
`int`	`getBeacon()` Method for the Train Controller to get the beacon information
`double`	`getCurrentTemperature()`
`double`	`getCurrentVelocity()`
`double`	`getDisplacement()` Calculates the distances traveled from the last time it was called
`double`	`getEmergencyBrakeRate()` Method for the Train Controller to get the emergency brake rates of the train
`boolean`	`getEmergencyBrakes()`
`double`	`getGrade()` Helper method to get the grade from the Track Model
`TrainModelGUI`	`getGUI()`
`int`	`getLeftDoor()`
`double`	`getLength()` Method for the Track Model to get the length of the train
`boolean`	`getLights()`
`int`	`getMaxPassengers()`
`double`	`getMaxPower()` Helper method when setting the power
`int`	`getPassengers()`
`double`	`getPower()` Method for the Train Controller to get the current power
`int`	`getRightDoor()`
`double`	`getServiceBrakeRate()` Method for the Train Controller to get the service brake rates of the train
`boolean`	`getServiceBrakes()`
`double`	`getSuggestedSpeed()` Method for the Train Controller to receive the suggested speed
`int`	`getTime()` Helper method to calculate displacement
`int`	`getTrainId()`
`double`	`getVelocity()`
`void`	`setDisplay(java.lang.String message)` Method for the Train Controller to set the display when approaching stops.
`void`	`setEmergencyBrakes(boolean status)` Turn emergency brakes on or off
`int`	`setLeftDoor(int newStatus)` Change the status of the left door
`boolean`	`setLights(boolean status)` Change the status of the lights
`int`	`setPassengers(int passengers)` Method for the Track Model to set the number of passengers in the train
`void`	`setPower(double powerInput, int test)` Method for the Train Controller to set the power for the train
`int`	`setRightDoor(int newStatus)` Change the status of the right door
`void`	`setServiceBrakes(boolean status)` Turn service brakes on or off
`void`	`setTemperature(double newTemp)`
`void`	`signalFailureMode(boolean status)` Turn signal failure on/off
`double`	`sine(double gradePercentage)` Calculates the sin of an angle
`void`	`updateSpeed(double forceApplied)` Helper method to update the velocity after given a power.

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

- Field Detail
  - trainController
```
protected TrainController trainController
```
  - _tm
```
protected TrackModel _tm
```
  - authority
```
protected int authority
```
  - power
```
protected double power
```
  - maxPower
```
protected double maxPower
```
  - temperature
```
protected double temperature
```
  - velocity
```
protected double velocity
```
  - maxVelocity
```
protected double maxVelocity
```
  - mass
```
protected double mass
```
  - numCrew
```
protected int numCrew
```
  - numCars
```
protected int numCars
```
  - numPassengers
```
protected int numPassengers
```
  - maxPassengers
```
protected int maxPassengers
```
  - passengerWeight
```
protected double passengerWeight
```
  - totalMass
```
protected double totalMass
```
  - friction
```
protected double friction
```
  - grade
```
protected double grade
```
  - time
```
protected int time
```
  - serviceBrake
```
protected boolean serviceBrake
```
  - serviceBrakeRate
```
protected double serviceBrakeRate
```
  - emergencyBrake
```
protected boolean emergencyBrake
```
  - emergencyBrakeRate
```
protected double emergencyBrakeRate
```
  - gravity
```
protected double gravity
```
  - totalForce
```
protected double totalForce
```
  - acceleration
```
protected double acceleration
```
  - maxAcceleration
```
protected double maxAcceleration
```
  - lights
```
protected boolean lights
```
  - leftDoor
```
protected int leftDoor
```
  - rightDoor
```
protected int rightDoor
```
  - brakeFailure
```
protected boolean brakeFailure
```
  - engineFailure
```
protected boolean engineFailure
```
  - signalFailure
```
protected boolean signalFailure
```
  - length
```
protected double length
```
  - height
```
protected double height
```
  - width
```
protected double width
```
  - gui
```
protected TrainModelGUI gui
```
  - formatter
```
protected java.text.NumberFormat formatter
```
- Constructor Detail
  - Train
```
public Train(int newTrainId,
             int newblockId)
```
  - Train
```
public Train(int newTrainId,
             int newblockId,
             TrackModel _tm)
```
  - Train
```
public Train(int newTrainId,
             int newblockId,
             TrackModel _tm,
             int test)
```
- Method Detail
  - getGUI
```
public TrainModelGUI getGUI()
```
  - getTrainId
```
public int getTrainId()
```
    Returns:
    
    The train id of the object.
  - getPower
```
public double getPower()
```
    Method for the Train Controller to get the current power
    
    Returns:
    
    The current power
  - getCurrentVelocity
```
public double getCurrentVelocity()
```
    Returns:
    
    current velocity of the train
  - getVelocity
```
public double getVelocity()
```
  - setPassengers
```
public int setPassengers(int passengers)
```
    Method for the Track Model to set the number of passengers in the train
    
    Parameters:
    
    passengers - The number of passengers that will be boarding
    
    Returns:
    
    Number of passengers
  - getPassengers
```
public int getPassengers()
```
    Returns:
    
    The number of passengers on the train currently
  - setDisplay
```
public void setDisplay(java.lang.String message)
```
    Method for the Train Controller to set the display when approaching stops.
    
    Parameters:
    
    message - The message to be displayed
  - getMaxPassengers
```
public int getMaxPassengers()
```
    Returns:
    
    The max number of passengers allowed on the train.
  - getLength
```
public double getLength()
```
    Method for the Track Model to get the length of the train
    
    Returns:
    
    The length of the train
  - getMaxPower
```
public double getMaxPower()
```
    Helper method when setting the power
    
    Returns:
    
    The max power the train can handle
  - blockChange
```
public boolean blockChange()
```
    Method for the train controller to see if the train has changed blocks
    
    Returns:
    
    true if changed else false
  - getAuthority
```
public boolean getAuthority()
```
    Method for the Train Controller to see the authority
    
    Returns:
    
    a boolean from the Track Model
  - getSuggestedSpeed
```
public double getSuggestedSpeed()
```
    Method for the Train Controller to receive the suggested speed
    
    Returns:
    
    suggested speed from Track Models
  - getBeacon
```
public int getBeacon()
```
    Method for the Train Controller to get the beacon information
    
    Returns:
    
    an integer from the Track Model
  - getGrade
```
public double getGrade()
```
    Helper method to get the grade from the Track Model
    
    Returns:
    
    the grade from the Track Model
  - setPower
```
public void setPower(double powerInput,
                     int test)
```
    Method for the Train Controller to set the power for the train
    
    Parameters:
    
    powerInput - the power to be set
  - sine
```
public double sine(double gradePercentage)
```
    Calculates the sin of an angle
    
    Parameters:
    
    gradePercentage - the percent of grade of the current block
    
    Returns:
    
    the sin of an angle after converting it from a percentage
  - getServiceBrakes
```
public boolean getServiceBrakes()
```
    Returns:
    
    boolean returns the current status of the service brakes
  - setServiceBrakes
```
public void setServiceBrakes(boolean status)
```
    Turn service brakes on or off
    
    Parameters:
    
    status - the new status to be set
  - getEmergencyBrakes
```
public boolean getEmergencyBrakes()
```
    Returns:
    
    boolean returns the current status of the emergency brakes
  - setEmergencyBrakes
```
public void setEmergencyBrakes(boolean status)
```
    Turn emergency brakes on or off
    
    Parameters:
    
    status - the new status to be set
  - getEmergencyBrakeRate
```
public double getEmergencyBrakeRate()
```
    Method for the Train Controller to get the emergency brake rates of the train
    
    Returns:
    
    The rate of declaration when emergency brakes are applied
  - getServiceBrakeRate
```
public double getServiceBrakeRate()
```
    Method for the Train Controller to get the service brake rates of the train
    
    Returns:
    
    The rate of declaration when service brakes are applied
  - updateSpeed
```
public void updateSpeed(double forceApplied)
```
    Helper method to update the velocity after given a power.
    
    Parameters:
    
    forceApplied - the force after a new power is set.
  - getCurrentTemperature
```
public double getCurrentTemperature()
```
    Returns:
    
    The current temperature of the train.
  - setTemperature
```
public void setTemperature(double newTemp)
```
    Parameters:
    
    newTemp - desired new inside temperature
  - getLights
```
public boolean getLights()
```
    Returns:
    
    true if on and false if off
  - setLights
```
public boolean setLights(boolean status)
```
    Change the status of the lights
    
    Parameters:
    
    status - The new status of the lights
    
    Returns:
    
    true if on and false if off
  - getLeftDoor
```
public int getLeftDoor()
```
    Returns:
    
    0 if closed else 1 if open
  - setLeftDoor
```
public int setLeftDoor(int newStatus)
```
    Change the status of the left door
    
    Parameters:
    
    newStatus - The new status that the left door should be set to
    
    Returns:
    
    0 if close else 1 if open
  - getRightDoor
```
public int getRightDoor()
```
    Returns:
    
    0 if closed else 1 if open
  - setRightDoor
```
public int setRightDoor(int newStatus)
```
    Change the status of the right door
    
    Parameters:
    
    newStatus - The new status that the right door should be set to
    
    Returns:
    
    0 if closed else 1 if open
  - getTime
```
public int getTime()
```
    Helper method to calculate displacement
    
    Returns:
    
    The last updated time
  - signalFailureMode
```
public void signalFailureMode(boolean status)
```
    Turn signal failure on/off
    
    Parameters:
    
    status - new status of the signal failure mode
  - brakeFailureMode
```
public void brakeFailureMode(boolean status)
```
    Turn brake failure on/off
    
    Parameters:
    
    status - new status of the brake failure mode
  - engineFailureMode
```
public void engineFailureMode(boolean status)
```
    Turn engine failure on/off
    
    Parameters:
    
    status - new status of the engine failure mode
  - getDisplacement
```
public double getDisplacement()
```
    Calculates the distances traveled from the last time it was called
    
    Returns:
    
    The distance traveled returned to the Track Model

Class Train

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

trainController

_tm

authority

power

maxPower

temperature

velocity

maxVelocity

mass

numCrew

numCars

numPassengers

maxPassengers

passengerWeight

totalMass

friction

grade

time

serviceBrake

serviceBrakeRate

emergencyBrake

emergencyBrakeRate

gravity

totalForce

acceleration

maxAcceleration

lights

leftDoor

rightDoor

brakeFailure

engineFailure

signalFailure

length

height

width

gui

formatter

Constructor Detail

Train

Train

Train

Method Detail

getGUI

getTrainId

getPower

getCurrentVelocity

getVelocity

setPassengers

getPassengers

setDisplay

getMaxPassengers

getLength

getMaxPower

blockChange

getAuthority

getSuggestedSpeed

getBeacon

getGrade

setPower

sine

getServiceBrakes

setServiceBrakes

getEmergencyBrakes

setEmergencyBrakes

getEmergencyBrakeRate

getServiceBrakeRate

updateSpeed

getCurrentTemperature

setTemperature

getLights

setLights

getLeftDoor

setLeftDoor

getRightDoor