Package com.nomagic.magicdraw.simulation.engine

Interface ExecutionEngineDescriptor

All Known Implementing Classes:
AbstractExecutionEngineDescriptor
@OpenApi public interface ExecutionEngineDescriptor
The descriptor which provides such information as engine's name, engine's icon also can check whether an element can be executed by an engine which is created from this descriptor and can create an engine instance. All execution engines must provide this descriptor and register it to SimulationManager.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canExecute(Element element)
    Return true if the specified element can be executed by an engine created from this descriptor, otherwise false.
    com.nomagic.magicdraw.simulation.listener.DurationListener
    createDurationListener(SimulationSession session)
    Return specific DurationListener of an engine created from this descriptor.
    ExecutionEngine
    createEngine()
    Returns the newly created engine instance.
    String
    getEngineName()
    Returns an engine's name.

  • Method Details

    • getEngineName

      @OpenApi String getEngineName()
      Returns an engine's name. The name of an engine that can be created by this descriptor.
      Returns:
      an engine's name.

    • canExecute

      @OpenApi boolean canExecute(Element element)
      Return true if the specified element can be executed by an engine created from this descriptor, otherwise false.
      Parameters:
      element - an element to be checked.
      Returns:
      true if the specified element can be executed by an engine created from this descriptor, otherwise false.

    • createEngine

      @OpenApi ExecutionEngine createEngine()
      Returns the newly created engine instance. Do not call this method directly, as created engine needs to be initialized.
      Returns:
      the newly created engine instance.

    • createDurationListener

      com.nomagic.magicdraw.simulation.listener.DurationListener createDurationListener(SimulationSession session)
      Return specific DurationListener of an engine created from this descriptor.
      Parameters:
      session - SimulationSession that this duration listener registered to its engine
      Returns:
      durationListener DurationListener