com.nomagic.magicdraw.simulation.engine

Class AbstractExecutionEngineDescriptor

java.lang.Object

com.nomagic.magicdraw.simulation.engine.AbstractExecutionEngineDescriptor

All Implemented Interfaces:

ExecutionEngineDescriptor

@OpenApi
public abstract class AbstractExecutionEngineDescriptor
extends java.lang.Object
implements ExecutionEngineDescriptor

The abstract implementation class of ExecutionEngineDescriptor. It provides some default value to the extended engine descriptor.

Method Summary

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	canUserTriggerEvents() Return true if the execution engine can generate the events to be triggered by user.
javax.swing.ImageIcon	getEngineIcon() Returns an engine's icon.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.nomagic.magicdraw.simulation.engine.ExecutionEngineDescriptor

canExecute, createEngine, getEngineName

Method Detail

getEngineIcon

@OpenApi
public javax.swing.ImageIcon getEngineIcon()

Description copied from interface: ExecutionEngineDescriptor

Returns an engine's icon. The icon of an engine that can be created by this descriptor.

Specified by:

getEngineIcon in interface ExecutionEngineDescriptor

Returns:

an engine's icon.

canAnimate

@OpenApi
public boolean canAnimate(PresentationElement element)

Description copied from interface: ExecutionEngineDescriptor

Returns true if the specified element can be animated (activated), otherwise false.

Specified by:

canAnimate in interface ExecutionEngineDescriptor

Parameters:

element - the presentation element to be checked.

Returns:

true if the specified element can be animated (activated), otherwise false.

isAutoDiagramOpened

@OpenApi
public boolean isAutoDiagramOpened()

Description copied from interface: ExecutionEngineDescriptor

Whether the diagram is opened automatically when showing animation.

Specified by:

isAutoDiagramOpened in interface ExecutionEngineDescriptor

Returns:

true, if the diagram is opened automatically when showing animation.

canDebug

@OpenApi
public boolean canDebug()

Description copied from interface: ExecutionEngineDescriptor

Return true if the execution engine can debug. It's related with Goto Selection, Step Into, and Step Over.

Specified by:

canDebug in interface ExecutionEngineDescriptor

Returns:

true if the execution engine can debug.

canUserTriggerEvents

@OpenApi
public boolean canUserTriggerEvents()

Description copied from interface: ExecutionEngineDescriptor

Return true if the execution engine can generate the events to be triggered by user. It allows to provide events in the simulation console.

Specified by:

canUserTriggerEvents in interface ExecutionEngineDescriptor

Returns:

true if the execution engine can generate the events to be triggered by user.

isDiagramPerSession

@OpenApi
public boolean isDiagramPerSession()

Description copied from interface: ExecutionEngineDescriptor

Return true if the simulation session is created for running only one diagram.

Specified by:

isDiagramPerSession in interface ExecutionEngineDescriptor

Returns:

true if the simulation session is created for running only one diagram.

isHasIdle

@OpenApi
public boolean isHasIdle()

Description copied from interface: ExecutionEngineDescriptor

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.

Specified by:

isHasIdle in interface ExecutionEngineDescriptor

Returns:

true, if the execution engine has the idle in the execution

isFindEngine

@OpenApi
public boolean isFindEngine(Element element)

Description copied from interface: ExecutionEngineDescriptor

All executions mostly start with fUMLEngine. If this method returns true, it doesn't use fUMLEngine, but search from engines list.

Specified by:

isFindEngine in interface ExecutionEngineDescriptor

Parameters:

element - the element being executed.

Returns:

boolean