Package com.nomagic.magicdraw.simulation.execution

Interface SimulationResult

@OpenApiAll
public interface SimulationResult

Contains information about running simulation execution.

Method Summary

Modifier and Type	Method	Description
Element	getElement()	Get the executed element.
Exception	getException()	Get first exception if it occurred starting or during execution.
SimulationSession	getMainSession()	Retrieve main simulation session.
Map<String,Object>	getOutputValues()	Gets simulation output values if simulation execution finished successfully.

Method Details

getMainSession

@CheckForNull
SimulationSession getMainSession()

Retrieve main simulation session. It will be null in cases then iterated execution (trade study, Monte Carlo or table diagram execution) has been started.

Returns:

the main session

getElement

Element getElement()

Get the executed element.

Returns:

element

getException

@CheckForNull
Exception getException()

Get first exception if it occurred starting or during execution.

Returns:

exception

getOutputValues

Map<String,Object> getOutputValues()
                            throws Exception

Gets simulation output values if simulation execution finished successfully. If simulation session is still running calling this method blocks until simulation execution terminates.

Returns:

Key value map of outputs

Throws:

Exception - if some exception occurred by running simulation.