org.transitime.ipc.interfaces

Interface VehiclesInterface

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

VehiclesServer

public interface VehiclesInterface
extends java.rmi.Remote

Defines the RMI interface used for obtaining vehicle information.

Author:

SkiBu Smith

Method Summary

Modifier and Type	Method and Description
java.util.Collection<IpcVehicle>	get() Gets from server IpcVehicle info for all vehicles.
java.util.Collection<IpcVehicle>	get(java.util.Collection<java.lang.String> vehicleIds) Gets from server IpcVehicle info for vehicles specified by vehicles parameter.
IpcVehicle	get(java.lang.String vehicleId) Gets from server IpcVehicle info for specified vehicle.
java.util.Collection<IpcActiveBlock>	getActiveBlocks(java.util.Collection<java.lang.String> routeIds, int allowableBeforeTimeSecs) Gets from the server IpcActiveBlocks for blocks that are currently active.
java.util.Collection<IpcVehicleComplete>	getComplete() Gets from server IpcCompleteVehicle info for all vehicles.
java.util.Collection<IpcVehicleComplete>	getComplete(java.util.Collection<java.lang.String> vehicleIds) Gets from server IpcCompleteVehicle info for vehicles specified by vehicles parameter.
IpcVehicleComplete	getComplete(java.lang.String vehicleId) Gets from server IpcCompleteVehicle info for specified vehicle.
java.util.Collection<IpcVehicleComplete>	getCompleteForRoute(java.util.Collection<java.lang.String> routeIdsOrShortNames) Gets from server IpcCompleteVehicle info for all vehicles currently.
java.util.Collection<IpcVehicleComplete>	getCompleteForRoute(java.lang.String routeIdOrShortName) Gets from server IpcCompleteVehicle info for all vehicles currently.
java.util.Collection<IpcVehicle>	getForRoute(java.util.Collection<java.lang.String> routeIdsOrShortNames) Gets from server IpcVehicle info for all vehicles currently.
java.util.Collection<IpcVehicle>	getForRoute(java.lang.String routeIdOrShortName) Gets from server IpcVehicle info for all vehicles currently.
java.util.Collection<IpcVehicleGtfsRealtime>	getGtfsRealtime() Gets from server IpcCompleteVehicle info for all vehicles.
java.util.Collection<IpcVehicleConfig>	getVehicleConfigs() For getting configuration information for all vehicles.

Method Detail

getVehicleConfigs

java.util.Collection<IpcVehicleConfig> getVehicleConfigs()
                                                  throws java.rmi.RemoteException

For getting configuration information for all vehicles. Useful for determining IDs of all vehicles in system

Returns:

Collection of IpcVehicleConfig objects

Throws:

java.rmi.RemoteException

get

java.util.Collection<IpcVehicle> get()
                              throws java.rmi.RemoteException

Gets from server IpcVehicle info for all vehicles.

Returns:

Collection of IpcVehicle objects

Throws:

java.rmi.RemoteException

getComplete

java.util.Collection<IpcVehicleComplete> getComplete()
                                              throws java.rmi.RemoteException

Gets from server IpcCompleteVehicle info for all vehicles.

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getGtfsRealtime

java.util.Collection<IpcVehicleGtfsRealtime> getGtfsRealtime()
                                                      throws java.rmi.RemoteException

Gets from server IpcCompleteVehicle info for all vehicles.

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

get

IpcVehicle get(java.lang.String vehicleId)
        throws java.rmi.RemoteException

Gets from server IpcVehicle info for specified vehicle.

Parameters:

vehicleId - ID of vehicle to get data for

Returns:

info for specified vehicle

Throws:

java.rmi.RemoteException

getComplete

IpcVehicleComplete getComplete(java.lang.String vehicleId)
                        throws java.rmi.RemoteException

Gets from server IpcCompleteVehicle info for specified vehicle.

Parameters:

vehicleId - ID of vehicle to get data for

Returns:

info for specified vehicle

Throws:

java.rmi.RemoteException

get

java.util.Collection<IpcVehicle> get(java.util.Collection<java.lang.String> vehicleIds)
                              throws java.rmi.RemoteException

Gets from server IpcVehicle info for vehicles specified by vehicles parameter.

Parameters:

vehicleIds - Collection of vehicle IDs to get Vehicle data for.

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getComplete

java.util.Collection<IpcVehicleComplete> getComplete(java.util.Collection<java.lang.String> vehicleIds)
                                              throws java.rmi.RemoteException

Gets from server IpcCompleteVehicle info for vehicles specified by vehicles parameter.

Parameters:

vehicleIds - Collection of vehicle IDs to get Vehicle data for.

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getForRoute

java.util.Collection<IpcVehicle> getForRoute(java.lang.String routeIdOrShortName)
                                      throws java.rmi.RemoteException

Gets from server IpcVehicle info for all vehicles currently. associated with route.

Parameters:

routeIdOrShortName - Specifies which route to get Vehicle data for

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getCompleteForRoute

java.util.Collection<IpcVehicleComplete> getCompleteForRoute(java.lang.String routeIdOrShortName)
                                                      throws java.rmi.RemoteException

Gets from server IpcCompleteVehicle info for all vehicles currently. associated with route.

Parameters:

routeIdOrShortName - Specifies which route to get Vehicle data for

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getForRoute

java.util.Collection<IpcVehicle> getForRoute(java.util.Collection<java.lang.String> routeIdsOrShortNames)
                                      throws java.rmi.RemoteException

Gets from server IpcVehicle info for all vehicles currently. associated with route.

Parameters:

routeIdsOrShortNames - Specifies which routes to get Vehicle data for

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getCompleteForRoute

java.util.Collection<IpcVehicleComplete> getCompleteForRoute(java.util.Collection<java.lang.String> routeIdsOrShortNames)
                                                      throws java.rmi.RemoteException

Gets from server IpcCompleteVehicle info for all vehicles currently. associated with route.

Parameters:

routeIdsOrShortNames - Specifies which routes to get Vehicle data for

Returns:

Collection of Vehicle objects

Throws:

java.rmi.RemoteException

getActiveBlocks

java.util.Collection<IpcActiveBlock> getActiveBlocks(java.util.Collection<java.lang.String> routeIds,
                                                     int allowableBeforeTimeSecs)
                                              throws java.rmi.RemoteException

Gets from the server IpcActiveBlocks for blocks that are currently active.

Parameters:

routeIds - List of routes that want data for. Can also be null or empty.

allowableBeforeTimeSecs - How much before the block time the block is considered to be active

Returns:

Collection of blocks that are active

Throws:

java.rmi.RemoteException