Package org.opentcs.access

Schnittstelle Kernel

Alle bekannten Unterschnittstellen:
LocalKernel
public interface Kernel
Declares the methods an openTCS kernel implements.

  • Verschachtelte Klassen - Übersicht

    Verschachtelte Klassen
    Modifizierer und Typ
    Schnittstelle
    Beschreibung
    static enum 
    Kernel.State
    The various states a kernel instance may be running in.

  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    static final String
    DEFAULT_MODEL_NAME
    The default name used for the empty model created on startup.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    Kernel.State
    getState()
    Returns the current state of the kernel.
    void
    setState(Kernel.State newState)
    Sets the current state of the kernel.

  • Felddetails

    • DEFAULT_MODEL_NAME

      static final String DEFAULT_MODEL_NAME
      The default name used for the empty model created on startup.
      Siehe auch:

  • Methodendetails

    • getState

      Kernel.State getState() throws CredentialsException
      Returns the current state of the kernel.
      Gibt zurück:
      The current state of the kernel.
      Löst aus:
      CredentialsException - If the calling client is not allowed to execute this method.

    • setState

      void setState(Kernel.State newState) throws IllegalArgumentException, CredentialsException
      Sets the current state of the kernel.

      Note: This method should only be used internally by the Kernel application.

      Parameter:
      newState - The state the kernel is to be set to.
      Löst aus:
      IllegalArgumentException - If setting the new state is not possible, e.g. because a transition from the current to the new state is not allowed.
      CredentialsException - If the calling client is not allowed to execute this method.