Package org.opentcs.components.plantoverview

Interface PlantModelImporter

public interface PlantModelImporter
Implementations provide a way to import plant model data that is read from some external source or generated.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDescription()
    Returns a (localized) short textual description of this importer.
    java.util.Optional<PlantModelCreationTO> importPlantModel()
    Imports (or generates) plant model data.

  • Method Details

    • importPlantModel

      @Nonnull java.util.Optional<PlantModelCreationTO> importPlantModel() throws java.io.IOException
      Imports (or generates) plant model data.
      Returns:
      The imported plant model data. May be empty if the user aborted the import.
      Throws:
      java.io.IOException - If there was a problem importing plant model data.

    • getDescription

      @Nonnull java.lang.String getDescription()
      Returns a (localized) short textual description of this importer.
      Returns:
      A (localized) short textual description of this importer.