Package org.opentcs.components.kernel.services

Schnittstelle TCSObjectService

Alle bekannten Unterschnittstellen:
InternalPeripheralJobService, InternalPeripheralService, InternalPlantModelService, InternalTransportOrderService, InternalVehicleService, PeripheralJobService, PeripheralService, PlantModelService, TransportOrderService, VehicleService
public interface TCSObjectService
Provides methods concerning TCSObjects.

  • Methodendetails

    • fetchObject

      <T extends TCSObject<T>> T fetchObject(Class<T> clazz, TCSObjectReference<T> ref) throws KernelRuntimeException
      Returns a single TCSObject of the given class.
      Typparameter:
      T - The TCSObject's actual type.
      Parameter:
      clazz - The class of the object to be returned.
      ref - A reference to the object to be returned.
      Gibt zurück:
      A copy of the referenced object, or null if no such object exists or if an object exists but is not an instance of the given class.
      Löst aus:
      KernelRuntimeException - In case there is an exception executing this method.

    • fetchObject

      <T extends TCSObject<T>> T fetchObject(Class<T> clazz, String name) throws KernelRuntimeException
      Returns a single TCSObject of the given class.
      Typparameter:
      T - The TCSObject's actual type.
      Parameter:
      clazz - The class of the object to be returned.
      name - The name of the object to be returned.
      Gibt zurück:
      A copy of the named object, or null if no such object exists or if an object exists but is not an instance of the given class.
      Löst aus:
      KernelRuntimeException - In case there is an exception executing this method.

    • fetchObjects

      <T extends TCSObject<T>> Set<T> fetchObjects(Class<T> clazz) throws KernelRuntimeException
      Returns all existing TCSObjects of the given class.
      Typparameter:
      T - The TCSObjects' actual type.
      Parameter:
      clazz - The class of the objects to be returned.
      Gibt zurück:
      Copies of all existing objects of the given class.
      Löst aus:
      KernelRuntimeException - In case there is an exception executing this method.

    • fetchObjects

      <T extends TCSObject<T>> Set<T> fetchObjects(@Nonnull Class<T> clazz, @Nonnull Predicate<? super T> predicate) throws KernelRuntimeException
      Returns all existing TCSObjects of the given class for which the given predicate is true.
      Typparameter:
      T - The TCSObjects' actual type.
      Parameter:
      clazz - The class of the objects to be returned.
      predicate - The predicate that must be true for returned objects.
      Gibt zurück:
      Copies of all existing objects of the given class for which the given predicate is true. If no such objects exist, the returned set will be empty.
      Löst aus:
      KernelRuntimeException - In case there is an exception executing this method.

    • updateObjectProperty

      void updateObjectProperty(TCSObjectReference<?> ref, String key, @Nullable String value) throws ObjectUnknownException, KernelRuntimeException
      Updates a TCSObject's property.
      Parameter:
      ref - A reference to the TCSObject to be modified.
      key - The property's key.
      value - The property's (new) value. If null, removes the property from the object.
      Löst aus:
      ObjectUnknownException - If the referenced object does not exist.
      KernelRuntimeException - In case there is an exception executing this method.

    • appendObjectHistoryEntry

      void appendObjectHistoryEntry(TCSObjectReference<?> ref, ObjectHistory.Entry entry) throws ObjectUnknownException, KernelRuntimeException
      Appends a history entry to a TCSObject.
      Parameter:
      ref - A reference to the TCSObject to be modified.
      entry - The history entry to be appended.
      Löst aus:
      ObjectUnknownException - If the referenced object does not exist.
      KernelRuntimeException - In case there is an exception executing this method.