Package org.opentcs.access

# Interface Kernel

All Known Subinterfaces:
  `LocalKernel`

    public interface Kernel

Declares the methods an openTCS kernel implements.

- ## Nested Class Summary

  Nested Classes
  Modifier and Type | Interface | Description
  --- | --- | ---
  `static class` | `Kernel.State` | The various states a kernel instance may be running in.

- ## Field Summary

  Fields
  Modifier and Type | Field | Description
  --- | --- | ---
  `static java.lang.String` | `DEFAULT_MODEL_NAME` | The default name used for the empty model created on startup.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `Kernel.State` | `getState()` | Returns the current state of the kernel.
  `void` | `setState​(Kernel.State newState)` | Sets the current state of the kernel.

- ## Field Details

  - ### DEFAULT_MODEL_NAME

    static final java.lang.String DEFAULT_MODEL_NAME
    The default name used for the empty model created on startup.
    See Also:
      Constant Field Values

- ## Method Details

  - ### getState

    Kernel.State getState() throws CredentialsException
    Returns the current state of the kernel.
    Returns:
      The current state of the kernel.
    Throws:
      `CredentialsException` - If the calling client is not allowed to execute this method.

  - ### setState

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

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

    Parameters:
      `newState` - The state the kernel is to be set to.
    Throws:
      `java.lang.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.