Package org.opentcs.access.rmi.services
Interface RemoteVehicleService
- All Superinterfaces:
Remote,RemoteTCSObjectService
Declares the methods provided by the
VehicleService via RMI.
The majority of the methods declared here have signatures analogous to their counterparts in
VehicleService, with an additional ClientID parameter which serves the purpose
of identifying the calling client and determining its permissions.
To avoid redundancy, the semantics of methods that only pass through their arguments are not
explicitly documented here again. See the corresponding API documentation in
VehicleService for these, instead.
-
Method Summary
Modifier and TypeMethodDescriptionvoidattachCommAdapter(ClientID clientId, TCSObjectReference<Vehicle> ref, VehicleCommAdapterDescription description) voiddisableCommAdapter(ClientID clientId, TCSObjectReference<Vehicle> ref) voidenableCommAdapter(ClientID clientId, TCSObjectReference<Vehicle> ref) fetchAttachmentInformation(ClientID clientId, TCSObjectReference<Vehicle> ref) fetchProcessModel(ClientID clientId, TCSObjectReference<Vehicle> ref) voidsendCommAdapterCommand(ClientID clientId, TCSObjectReference<Vehicle> ref, AdapterCommand command) voidsendCommAdapterMessage(ClientID clientId, TCSObjectReference<Vehicle> vehicleRef, Object message) voidupdateVehicleAllowedOrderTypes(ClientID clientId, TCSObjectReference<Vehicle> ref, Set<String> allowedOrderTypes) voidupdateVehicleEnvelopeKey(ClientID clientId, TCSObjectReference<Vehicle> ref, String envelopeKey) voidupdateVehicleIntegrationLevel(ClientID clientId, TCSObjectReference<Vehicle> ref, Vehicle.IntegrationLevel integrationLevel) voidupdateVehiclePaused(ClientID clientId, TCSObjectReference<Vehicle> ref, boolean paused) Methods inherited from interface org.opentcs.access.rmi.services.RemoteTCSObjectService
appendObjectHistoryEntry, fetchObject, fetchObject, fetchObjects, fetchObjects, updateObjectProperty
-
Method Details
-
attachCommAdapter
void attachCommAdapter(ClientID clientId, TCSObjectReference<Vehicle> ref, VehicleCommAdapterDescription description) throws RemoteException - Throws:
RemoteException
-
disableCommAdapter
- Throws:
RemoteException
-
enableCommAdapter
- Throws:
RemoteException
-
fetchAttachmentInformation
VehicleAttachmentInformation fetchAttachmentInformation(ClientID clientId, TCSObjectReference<Vehicle> ref) throws RemoteException - Throws:
RemoteException
-
fetchProcessModel
VehicleProcessModelTO fetchProcessModel(ClientID clientId, TCSObjectReference<Vehicle> ref) throws RemoteException - Throws:
RemoteException
-
sendCommAdapterCommand
void sendCommAdapterCommand(ClientID clientId, TCSObjectReference<Vehicle> ref, AdapterCommand command) throws RemoteException - Throws:
RemoteException
-
sendCommAdapterMessage
void sendCommAdapterMessage(ClientID clientId, TCSObjectReference<Vehicle> vehicleRef, Object message) throws RemoteException - Throws:
RemoteException
-
updateVehicleIntegrationLevel
void updateVehicleIntegrationLevel(ClientID clientId, TCSObjectReference<Vehicle> ref, Vehicle.IntegrationLevel integrationLevel) throws RemoteException - Throws:
RemoteException
-
updateVehiclePaused
void updateVehiclePaused(ClientID clientId, TCSObjectReference<Vehicle> ref, boolean paused) throws RemoteException - Throws:
RemoteException
-
updateVehicleAllowedOrderTypes
void updateVehicleAllowedOrderTypes(ClientID clientId, TCSObjectReference<Vehicle> ref, Set<String> allowedOrderTypes) throws RemoteException - Throws:
RemoteException
-
updateVehicleEnvelopeKey
void updateVehicleEnvelopeKey(ClientID clientId, TCSObjectReference<Vehicle> ref, String envelopeKey) throws RemoteException - Throws:
RemoteException
-