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 Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canAnimate(PresentationElement element)` Returns `true` if the specified `element` can be animated (activated), otherwise `false`.
`boolean`	`canDebug()` Return `true` if the execution engine can debug.
`boolean`	`canExecute(Element element)` Return `true` if the specified `element` can be executed by an engine created from this descriptor, otherwise `false`.
`boolean`	`canUserTriggerEvents()` Return `true` if the execution engine can generate the events to be triggered by user.
`ExecutionEngine`	`createEngine()` Returns the newly created engine instance.
`javax.swing.ImageIcon`	`getEngineIcon()` Returns an engine's icon.
`java.lang.String`	`getEngineName()` Returns an engine's name.
`boolean`	`isAutoDiagramOpened()` Whether the diagram is opened automatically when showing animation.
`boolean`	`isDiagramPerSession()` Return `true` if the simulation session is created for running only one diagram.
`boolean`	`isFindEngine(Element element)` All executions mostly start with fUMLEngine.
`boolean`	`isHasIdle()` Return boolean value to indicate that the execution engine has the idle in the execution or not.

- 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.
  - getEngineIcon
```
@OpenApi
javax.swing.ImageIcon getEngineIcon()
```
    Returns an engine's icon. The icon of an engine that can be created by this descriptor.
    
    Returns:
    
    an engine's icon.
  - 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.
    
    Returns:
    
    the newly created engine instance.
  - canAnimate
```
@OpenApi
boolean canAnimate(PresentationElement element)
```
    Returns true if the specified element can be animated (activated), otherwise false.
    
    Parameters:
    
    element - the presentation element to be checked.
    
    Returns:
    
    true if the specified element can be animated (activated), otherwise false.
  - isAutoDiagramOpened
```
@OpenApi
boolean isAutoDiagramOpened()
```
    Whether the diagram is opened automatically when showing animation.
    
    Returns:
    
    true, if the diagram is opened automatically when showing animation.
  - canDebug
```
@OpenApi
boolean canDebug()
```
    Return true if the execution engine can debug. It's related with Goto Selection, Step Into, and Step Over.
    
    Returns:
    
    true if the execution engine can debug.
  - canUserTriggerEvents
```
@OpenApi
boolean canUserTriggerEvents()
```
    Return true if the execution engine can generate the events to be triggered by user. It allows to provide events in the simulation console.
    
    Returns:
    
    true if the execution engine can generate the events to be triggered by user.
  - isDiagramPerSession
```
@OpenApi
boolean isDiagramPerSession()
```
    Return true if the simulation session is created for running only one diagram.
    
    Returns:
    
    true if the simulation session is created for running only one diagram.
  - isHasIdle
```
@OpenApi
boolean isHasIdle()
```
    Return boolean value to indicate that the execution engine has the idle in the execution or not. Such as in Statemechine, it has no idle.
    
    Returns:
    
    true, if the execution engine has the idle in the execution
  - isFindEngine
```
@OpenApi
boolean isFindEngine(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

Interface ExecutionEngineDescriptor

Method Summary

Method Detail

getEngineName

getEngineIcon

canExecute

createEngine

canAnimate

isAutoDiagramOpened

canDebug

canUserTriggerEvents

isDiagramPerSession

isHasIdle

isFindEngine