Package org.opentcs.access.rmi.services

Schnittstelle RemoteVehicleService

Alle Superschnittstellen:

Remote, RemoteTCSObjectService

public interface RemoteVehicleService
extends RemoteTCSObjectService, Remote

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.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	attachCommAdapter(ClientID clientId, TCSObjectReference<Vehicle> ref, VehicleCommAdapterDescription description)
void	disableCommAdapter(ClientID clientId, TCSObjectReference<Vehicle> ref)
void	enableCommAdapter(ClientID clientId, TCSObjectReference<Vehicle> ref)
VehicleAttachmentInformation	fetchAttachmentInformation(ClientID clientId, TCSObjectReference<Vehicle> ref)
VehicleProcessModelTO	fetchProcessModel(ClientID clientId, TCSObjectReference<Vehicle> ref)
void	sendCommAdapterCommand(ClientID clientId, TCSObjectReference<Vehicle> ref, AdapterCommand command)
void	sendCommAdapterMessage(ClientID clientId, TCSObjectReference<Vehicle> vehicleRef, Object message)
void	updateVehicleAllowedOrderTypes(ClientID clientId, TCSObjectReference<Vehicle> ref, Set<String> allowedOrderTypes)
default void	updateVehicleEnergyLevelThresholdSet(ClientID clientId, TCSObjectReference<Vehicle> ref, Vehicle.EnergyLevelThresholdSet energyLevelThresholdSet)
void	updateVehicleEnvelopeKey(ClientID clientId, TCSObjectReference<Vehicle> ref, String envelopeKey)
void	updateVehicleIntegrationLevel(ClientID clientId, TCSObjectReference<Vehicle> ref, Vehicle.IntegrationLevel integrationLevel)
void	updateVehiclePaused(ClientID clientId, TCSObjectReference<Vehicle> ref, boolean paused)

Von Schnittstelle geerbte Methoden org.opentcs.access.rmi.services.RemoteTCSObjectService

appendObjectHistoryEntry, fetchObject, fetchObject, fetchObjects, fetchObjects, updateObjectProperty

Methodendetails

attachCommAdapter

void attachCommAdapter(ClientID clientId,
 TCSObjectReference<Vehicle> ref,
 VehicleCommAdapterDescription description)
                throws RemoteException

Löst aus:

RemoteException

disableCommAdapter

void disableCommAdapter(ClientID clientId,
 TCSObjectReference<Vehicle> ref)
                 throws RemoteException

Löst aus:

RemoteException

enableCommAdapter

void enableCommAdapter(ClientID clientId,
 TCSObjectReference<Vehicle> ref)
                throws RemoteException

Löst aus:

RemoteException

fetchAttachmentInformation

VehicleAttachmentInformation fetchAttachmentInformation(ClientID clientId,
 TCSObjectReference<Vehicle> ref)
                                                 throws RemoteException

Löst aus:

RemoteException

fetchProcessModel

VehicleProcessModelTO fetchProcessModel(ClientID clientId,
 TCSObjectReference<Vehicle> ref)
                                 throws RemoteException

Löst aus:

RemoteException

sendCommAdapterCommand

void sendCommAdapterCommand(ClientID clientId,
 TCSObjectReference<Vehicle> ref,
 AdapterCommand command)
                     throws RemoteException

Löst aus:

RemoteException

sendCommAdapterMessage

void sendCommAdapterMessage(ClientID clientId,
 TCSObjectReference<Vehicle> vehicleRef,
 Object message)
                     throws RemoteException

Löst aus:

RemoteException

updateVehicleIntegrationLevel

void updateVehicleIntegrationLevel(ClientID clientId,
 TCSObjectReference<Vehicle> ref,
 Vehicle.IntegrationLevel integrationLevel)
                            throws RemoteException

Löst aus:

RemoteException

updateVehiclePaused

void updateVehiclePaused(ClientID clientId,
 TCSObjectReference<Vehicle> ref,
 boolean paused)
                  throws RemoteException

Löst aus:

RemoteException

updateVehicleEnergyLevelThresholdSet

@ScheduledApiChange(when="7.0",
                    details="Default implementation will be removed.")
default void updateVehicleEnergyLevelThresholdSet(ClientID clientId,
 TCSObjectReference<Vehicle> ref,
 Vehicle.EnergyLevelThresholdSet energyLevelThresholdSet)
                                           throws RemoteException

Löst aus:

RemoteException

updateVehicleAllowedOrderTypes

void updateVehicleAllowedOrderTypes(ClientID clientId,
 TCSObjectReference<Vehicle> ref,
 Set<String> allowedOrderTypes)
                             throws RemoteException

Löst aus:

RemoteException

updateVehicleEnvelopeKey

void updateVehicleEnvelopeKey(ClientID clientId,
 TCSObjectReference<Vehicle> ref,
 String envelopeKey)
                       throws RemoteException

Löst aus:

RemoteException