Module OneMTA

Package dev.katsute.onemta.subway

Class Subway.Vehicle

java.lang.Object

dev.katsute.onemta.types.TransitVehicle<String,Subway.Route,String,Subway.Stop,String,Subway.Trip>

dev.katsute.onemta.subway.Subway.Vehicle

All Implemented Interfaces:

Reference.Route<Subway.Route>, Reference.Stop<Subway.Stop>, Reference.Trip<Subway.Trip>, Updatable

Enclosing class:

Subway

public abstract static class Subway.Vehicle
extends TransitVehicle<String,Subway.Route,String,Subway.Stop,String,Subway.Trip>

Represents a subway vehicle.

Since:

1.0.0

Version:

2.0.0

Author:

Katsute

Constructor Summary

Constructors

Constructor	Description
Vehicle()

Method Summary

Modifier and Type	Method	Description
abstract String	getStatus()	Returns the current vehicle status.
abstract Integer	getStopSequence()	Returns the stop sequence.
abstract Boolean	isAssigned()	Returns if the trip is assigned to an actual train.
abstract Boolean	isExpress()	Returns if the train is running express.
abstract Boolean	isRerouted()	Returns if the train is rerouted.
abstract Boolean	isSkipStop()	Returns if the train is following a skip stop pattern.
abstract Boolean	isTurnTrain()	Returns if the train is a turn train (shortly lined service)

Methods inherited from class dev.katsute.onemta.types.TransitVehicle

getRouteID, getStopID, getVehicleID

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.katsute.onemta.attribute.Reference.Route

getRoute

Methods inherited from interface dev.katsute.onemta.attribute.Reference.Stop

getStop

Methods inherited from interface dev.katsute.onemta.attribute.Reference.Trip

getTrip

Methods inherited from interface dev.katsute.onemta.attribute.Updatable

refresh

Constructor Details

Vehicle

public Vehicle()

Method Details

isAssigned

public abstract Boolean isAssigned()

Returns if the trip is assigned to an actual train.
If true, the vehicle is on a trip or is about to depart.
If false, the vehicle has not yet been assigned a trip or is being taken out of service.

Returns:

assigned

Since:

2.0.0

isRerouted

public abstract Boolean isRerouted()

Returns if the train is rerouted.

Returns:

rerouted train

Since:

2.0.0

isSkipStop

public abstract Boolean isSkipStop()

Returns if the train is following a skip stop pattern.

Returns:

skip stop train

Since:

2.0.0

isTurnTrain

public abstract Boolean isTurnTrain()

Returns if the train is a turn train (shortly lined service)

Returns:

turn train

Since:

2.0.0

getStatus

public abstract String getStatus()

Returns the current vehicle status.

Returns:

vehicle status

Since:

1.0.0

getStopSequence

public abstract Integer getStopSequence()

Returns the stop sequence.

Returns:

stop sequence

Since:

2.0.0

isExpress

public abstract Boolean isExpress()

Returns if the train is running express.

Returns:

express train

Since:

1.0.3