org.transitime.ipc.data

Class IpcVehicle

java.lang.Object

org.transitime.ipc.data.IpcVehicle

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

IpcVehicleGtfsRealtime

@Immutable
public class IpcVehicle
extends java.lang.Object
implements java.io.Serializable

Contains information on a single vehicle. For providing info to client. This class is Immutable so that it is threadsafe.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IpcVehicle(VehicleState vs) Constructs a new Vehicle object from data in a VehicleState object.

Method Summary

Modifier and Type	Method and Description
IpcAvl	getAvl()
BlockAssignmentMethod	getBlockAssignmentMethod()
java.lang.String	getBlockId()
java.lang.String	getDirectionId()
long	getGpsTime() GPS epoch time in msec.
float	getHeading() Returns number of degrees clockwise from due North.
java.lang.String	getHeadsign()
java.lang.String	getId()
float	getLatitude()
long	getLayoverDepartureTime() Epoch time of scheduled departure.
java.lang.String	getLicensePlate()
float	getLongitude()
java.lang.String	getNextStopId()
java.lang.String	getNextStopName()
TemporalDifference	getRealTimeSchedAdh()
java.lang.String	getRouteId()
java.lang.String	getRouteShortName()
float	getSpeed()
java.lang.String	getTripId()
java.lang.String	getTripPatternId()
java.lang.String	getVehicleType()
boolean	isDelayed()
boolean	isForSchedBasedPred()
boolean	isLayover()
boolean	isPredictable()
static void	main(java.lang.String[] args)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IpcVehicle

public IpcVehicle(VehicleState vs)

Constructs a new Vehicle object from data in a VehicleState object.

Parameters:

vs -

Method Detail

getId

public java.lang.String getId()

getBlockId

public java.lang.String getBlockId()

getBlockAssignmentMethod

public BlockAssignmentMethod getBlockAssignmentMethod()

getAvl

public IpcAvl getAvl()

getHeading

public float getHeading()

Returns number of degrees clockwise from due North. Note that this is very different from angle(). The path heading that the vehicle matched to is used when it is available. When path heading not available then uses the AVL heading. That can be NaN as well though.

Returns:

Heading of vehicle, or Float.NaN if heading not defined.

getSpeed

public float getSpeed()

Returns:

Speed of vehicle, or Float.NaN if speed not defined.

getLatitude

public float getLatitude()

getLongitude

public float getLongitude()

getLicensePlate

public java.lang.String getLicensePlate()

getGpsTime

public long getGpsTime()

GPS epoch time in msec.

Returns:

getRouteId

public java.lang.String getRouteId()

getRouteShortName

public java.lang.String getRouteShortName()

getTripId

public java.lang.String getTripId()

getTripPatternId

public java.lang.String getTripPatternId()

getDirectionId

public java.lang.String getDirectionId()

getHeadsign

public java.lang.String getHeadsign()

isPredictable

public boolean isPredictable()

isForSchedBasedPred

public boolean isForSchedBasedPred()

getRealTimeSchedAdh

public TemporalDifference getRealTimeSchedAdh()

Returns:

The real-time schedule adherence for the vehicle, or null if vehicle no predictable.

isDelayed

public boolean isDelayed()

isLayover

public boolean isLayover()

getLayoverDepartureTime

public long getLayoverDepartureTime()

Epoch time of scheduled departure. Only valid if vehicle at layover.

Returns:

getNextStopId

public java.lang.String getNextStopId()

getNextStopName

public java.lang.String getNextStopName()

getVehicleType

public java.lang.String getVehicleType()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

main

public static void main(java.lang.String[] args)