Package org.opentcs.access.rmi.services
Interface RemotePlantModelService
- All Superinterfaces:
java.rmi.Remote,RemoteTCSObjectService
public interface RemotePlantModelService extends RemoteTCSObjectService, java.rmi.Remote
Declares the methods provided by the
PlantModelService via RMI.
The majority of the methods declared here have signatures analogous to their counterparts in
PlantModelService, 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
PlantModelService for these, instead.
-
Method Summary
Modifier and Type Method Description voidcreatePlantModel(ClientID clientId, PlantModelCreationTO to)java.lang.StringgetModelName(ClientID clientId)java.util.Map<java.lang.String,java.lang.String>getModelProperties(ClientID clientId)PlantModelgetPlantModel(ClientID clientId)voidupdateLocationLock(ClientID clientId, TCSObjectReference<Location> ref, boolean locked)default voidupdatePathLock(ClientID clientId, TCSObjectReference<Path> ref, boolean locked)Methods inherited from interface org.opentcs.access.rmi.services.RemoteTCSObjectService
appendObjectHistoryEntry, fetchObject, fetchObject, fetchObjects, fetchObjects, updateObjectProperty
-
Method Details
-
getPlantModel
- Throws:
java.rmi.RemoteException
-
createPlantModel
- Throws:
java.rmi.RemoteException
-
getModelName
- Throws:
java.rmi.RemoteException
-
getModelProperties
java.util.Map<java.lang.String,java.lang.String> getModelProperties(ClientID clientId) throws java.rmi.RemoteException- Throws:
java.rmi.RemoteException
-
updateLocationLock
void updateLocationLock(ClientID clientId, TCSObjectReference<Location> ref, boolean locked) throws java.rmi.RemoteException- Throws:
java.rmi.RemoteException
-
updatePathLock
@ScheduledApiChange(when="6.0", details="Default implementation will be removed.") default void updatePathLock(ClientID clientId, TCSObjectReference<Path> ref, boolean locked) throws java.rmi.RemoteException- Throws:
java.rmi.RemoteException
-