com.nomagic.magicdraw.simulation

Class SimulationManager

java.lang.Object

com.nomagic.magicdraw.simulation.SimulationManager

@OpenApiAll
public final class SimulationManager
extends java.lang.Object

The manager class that manages all about the simulation framework.

Since:

SIM 1.0

Constructor Summary

Constructors

Constructor and Description
SimulationManager()

Method Summary

Modifier and Type	Method and Description
static SimulationSession	execute(Element element) The utility method for executing the specific element.
static SimulationSession	execute(Element element, java.lang.Boolean isMainSession, java.lang.Boolean start) The utility method for executing the specific element with additional flags.
static SimulationSession	execute(Element element, java.lang.Boolean isMainSession, java.lang.Boolean start, java.lang.Boolean isSilent) The utility method for executing the specific element with additional flags.
static SimulationSession	getRefSession(fUML.Semantics.Classes.Kernel.Object_ object) Get the referenced session of the specified object.
static fUML.Semantics.Classes.Kernel.Object_	getRootContext(SimulationSession session) Get the root context of the running session.
static boolean	isSilentSimulation(SimulationSession session) Check the simulation runt in silent mode or not.
static void	logConsoleDebug(Project project, java.lang.String message) Log the specified message to the simulation console with "DEBUG" log level.
static void	logConsoleError(Project project, java.lang.String message) Log the specified message to the simulation console with "ERROR" log level.
static void	logConsoleInfo(Project project, java.lang.String message) Log the specified message to the simulation console with "INFO" log level.
static void	logConsoleWarn(Project project, java.lang.String message) Log the specified message to the simulation console with "WARN" log level.
static void	registerEngine(ExecutionEngineDescriptor engineDescriptor) Registers an engine descriptor to the simulation framework.
static void	registerExecutionListener(ExecutionListener listener) Deprecated.
static void	registerSimulationExecutionListener(SimulationExecutionListener listener) Register the simulation execution listener.
static void	terminateSession(SimulationSession session) Terminate the running session.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimulationManager

public SimulationManager()

Method Detail

registerEngine

public static void registerEngine(ExecutionEngineDescriptor engineDescriptor)

Registers an engine descriptor to the simulation framework.

Parameters:

engineDescriptor - an engine descriptor.

execute

public static SimulationSession execute(Element element)

The utility method for executing the specific element.

Parameters:

element - the element

Returns:

SimulationSession

execute

public static SimulationSession execute(Element element,
                                        java.lang.Boolean isMainSession,
                                        java.lang.Boolean start)

The utility method for executing the specific element with additional flags.

Parameters:

element - the element that be executed

isMainSession - execute with fUMLEngine or not. if this flag is null, it will check from the element with the registered engine.

start - if this flag is true, it will auto start the session.

Returns:

the created simulation session.

execute

public static SimulationSession execute(Element element,
                                        java.lang.Boolean isMainSession,
                                        java.lang.Boolean start,
                                        java.lang.Boolean isSilent)

The utility method for executing the specific element with additional flags.

Parameters:

element - the element that be executed

isMainSession - execute with fUMLEngine or not. if this flag is null, it will check from the element with the registered engine.

start - if this flag is true, it will auto start the session.

isSilent - execute the element in silent mode or not

Returns:

the created simulation session.

isSilentSimulation

public static boolean isSilentSimulation(SimulationSession session)

Check the simulation runt in silent mode or not.

Parameters:

session - the simulation session.

Returns:

true if simulation run in silent mode

terminateSession

public static void terminateSession(SimulationSession session)

Terminate the running session.

Parameters:

session - the session being terminated

registerExecutionListener

@Deprecated
public static void registerExecutionListener(ExecutionListener listener)

Deprecated.

Register the execution listener.

Parameters:

listener - the registered execution listener

registerSimulationExecutionListener

public static void registerSimulationExecutionListener(SimulationExecutionListener listener)

Register the simulation execution listener.

Parameters:

listener - the registered simulation execution listener

logConsoleDebug

public static void logConsoleDebug(Project project,
                                   java.lang.String message)

Log the specified message to the simulation console with "DEBUG" log level.

Parameters:

project - a project of the running simulation

message - the specified message

logConsoleInfo

public static void logConsoleInfo(Project project,
                                  java.lang.String message)

Log the specified message to the simulation console with "INFO" log level.

Parameters:

project - a project of the running simulation

message - the specified message

logConsoleWarn

public static void logConsoleWarn(Project project,
                                  java.lang.String message)

Log the specified message to the simulation console with "WARN" log level.

Parameters:

project - a project of the running simulation

message - the specified message

logConsoleError

public static void logConsoleError(Project project,
                                   java.lang.String message)

Log the specified message to the simulation console with "ERROR" log level.

Parameters:

project - a project of the running simulation

message - the specified message

getRefSession

public static SimulationSession getRefSession(fUML.Semantics.Classes.Kernel.Object_ object)

Get the referenced session of the specified object. If object is typed by Object_, the referenced session is a session that object was created.

Parameters:

object - a specified Object_

Returns:

the referenced SimulationSession

getRootContext

public static fUML.Semantics.Classes.Kernel.Object_ getRootContext(SimulationSession session)

Get the root context of the running session.

Parameters:

session - the running session

Returns:

the root context