Package org.opentcs.components.kernel.services

Interface InternalPlantModelService

All Superinterfaces:
PlantModelService, TCSObjectService
public interface InternalPlantModelService
extends PlantModelService
Declares the methods the plant model service must provide which are not accessible to remote peers.

  • Method Details

    • expandResources

      java.util.Set<TCSResource<?>> expandResources​(java.util.Set<TCSResourceReference<?>> resources) throws ObjectUnknownException
      Expands a set of resources A to a set of resources B. B contains the resources in A with blocks expanded to their actual members. The given set is not modified.
      Parameters:
      resources - The set of resources to be expanded.
      Returns:
      The given set with resources expanded.
      Throws:
      ObjectUnknownException - If any of the referenced objects does not exist.

    • loadPlantModel

      void loadPlantModel() throws java.lang.IllegalStateException
      Loads the saved model into the kernel. If there is no saved model, a new empty model will be loaded.
      Throws:
      java.lang.IllegalStateException - If the model cannot be loaded.

    • savePlantModel

      void savePlantModel() throws java.lang.IllegalStateException
      Saves the current model under the given name. If there is a saved model, it will be overwritten.
      Throws:
      java.lang.IllegalStateException - If the model could not be persisted for some reason.

    • updateLocationReservationToken

      @Deprecated @ScheduledApiChange(details="Will be removed.", when="6.0") void updateLocationReservationToken​(TCSObjectReference<Location> ref, @Nullable java.lang.String token) throws ObjectUnknownException, KernelRuntimeException
      Deprecated.
      Use InternalPeripheralService.updatePeripheralReservationToken() instead.
      Updates a location's reservation token.
      Parameters:
      ref - A reference to the location to be updated.
      token - The location's new reservation token.
      Throws:
      ObjectUnknownException - If the referenced location does not exist.
      KernelRuntimeException - In case there is an exception executing this method.