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:
    ExecutionEngine, SimulationManager

    • Method Detail

      • getEngineName

        @OpenApi
java.lang.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​(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.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.

      • getValidationSuite

        @Deprecated
java.util.List<? extends com.nomagic.magicdraw.simulation.validation.ValidationSuite> getValidationSuite()
        Deprecated.
        Return the ValidationSuite of the implementing execution engine.
        Returns:
        the ValidationSuite of the implementing execution engine

      • isFindEngine

        @OpenApi
boolean isFindEngine​(com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element element)
        All executions mostly start with fUMLEngine. If this method returns true, it doesn't use fUMLEngine, but search from engines list.
        Parameters:
        element - the element being executed.
        Returns:
        boolean

      • createDurationListener

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