Package org.opentcs.guing.persistence

Interface ModelManagerModeling

All Superinterfaces:
org.opentcs.guing.persistence.ModelManager
All Known Implementing Classes:
OpenTCSModelManagerModeling
public interface ModelManagerModeling
extends org.opentcs.guing.persistence.ModelManager
Manages (loads, saves and keeps) the driving course model.

  • Method Summary

    Modifier and Type Method Description
    boolean exportModel​(org.opentcs.components.plantoverview.PlantModelExporter exporter)
    Exports a model using the given exporter.
    boolean importModel​(org.opentcs.components.plantoverview.PlantModelImporter importer)
    Imports a model using the given importer.
    boolean loadModel​(java.io.File modelFile)
    Shows a dialog to select a model and loads it.
    boolean loadModel​(java.io.File modelFile, org.opentcs.guing.persistence.ModelFileReader reader)
    Shows a dialog to select a model and loads it.
    boolean uploadModel​(org.opentcs.access.KernelServicePortal portal)
    Uploads the given system model to the kernel.

    Methods inherited from interface org.opentcs.guing.persistence.ModelManager

    createEmptyModel, getModel, restoreModel, restoreModel, saveModelToFile

  • Method Details

    • loadModel

      boolean loadModel​(@Nullable java.io.File modelFile)
      Shows a dialog to select a model and loads it.
      Parameters:
      modelFile - The nullable model file to be loaded. If it is not present a dialog to select a file will be shown.
      Returns:
      true if, and only if, a model was successfully loaded.

    • loadModel

      boolean loadModel​(@Nullable java.io.File modelFile, org.opentcs.guing.persistence.ModelFileReader reader)
      Shows a dialog to select a model and loads it.
      Parameters:
      modelFile - The nullable model file to be loaded. If it is not present a dialog to select a file will be shown.
      reader - The reader which reads and parses the file.
      Returns:
      true if, and only if, a model was successfully loaded.

    • importModel

      boolean importModel​(@Nonnull org.opentcs.components.plantoverview.PlantModelImporter importer)
      Imports a model using the given importer.
      Parameters:
      importer - The importer to be used.
      Returns:
      true if, and only if, a model was successfully imported.

    • uploadModel

      boolean uploadModel​(org.opentcs.access.KernelServicePortal portal)
      Uploads the given system model to the kernel.
      Parameters:
      portal - The kernel client portal to upload the model to.
      Returns:
      Whether the model was actually uploaded.

    • exportModel

      boolean exportModel​(@Nonnull org.opentcs.components.plantoverview.PlantModelExporter exporter)
      Exports a model using the given exporter.
      Parameters:
      exporter - The exporter to be used.
      Returns:
      true if, and only if, the model was successfully exported.