Package com.nomagic.magicdraw.simulation.execution

Class SimulationOptions

java.lang.Object
com.nomagic.magicdraw.simulation.execution.SimulationOptions
@OpenApiAll public class SimulationOptions extends Object
A class that maintains the option values being used during the execution simulation. Also provides out-of-the-box option key constants to retrieve the option values by.

  • Field Details

    • ACTIVE_COLOR

      public static final String ACTIVE_COLOR
      Active symbol color option key
      See Also:

    • VISITED_COLOR

      public static final String VISITED_COLOR
      Visited symbol color option key
      See Also:

    • BREAKPOINT_COLOR

      public static final String BREAKPOINT_COLOR
      Breakpoint symbol color option key
      See Also:

    • LAST_VISITED_COLOR

      public static final String LAST_VISITED_COLOR
      Last visited symbol color option key
      See Also:

    • AUTO_OPEN_DIAGRAMS

      public static final String AUTO_OPEN_DIAGRAMS
      Auto open diagrams option key
      See Also:

    • SILENT

      public static final String SILENT
      Silent execution option key
      See Also:

    • DEFAULT_LANGUAGE

      public static final String DEFAULT_LANGUAGE
      Default Evaluation Language option key
      See Also:

    • ENGINES_PRIORITY

      public static final String ENGINES_PRIORITY
      Registered execution engine priority option key
      See Also:

    • AUTO_START

      public static final String AUTO_START
      Auto start execution option key
      See Also:

    • AUTO_START_ACTIVE_OPTIONS

      public static final String AUTO_START_ACTIVE_OPTIONS
      Auto Start Active Objects option key
      See Also:

    • TREAT_ALL_CLASSIFIERS_AS_ACTIVE

      public static final String TREAT_ALL_CLASSIFIERS_AS_ACTIVE
      Treat All Objects as Active option key
      See Also:

    • TERMINATE_BEHAVIOR_ON_EXCEPTION_THROWN

      public static final String TERMINATE_BEHAVIOR_ON_EXCEPTION_THROWN
      Terminate Behavior on Exception Thrown option key
      See Also:

    • INITIALIZE_NUMERICAL_VALUE

      public static final String INITIALIZE_NUMERICAL_VALUE
      Initialize Empty Values to 0 option key
      See Also:

    • RECORD_STATE_CHANGE

      public static final String RECORD_STATE_CHANGE
      Record State Change option key
      See Also:

    • RECORD_VALUE_CHANGE

      public static final String RECORD_VALUE_CHANGE
      Record Value Change option key
      See Also:

    • RECORD_TIMESTAMP

      public static final String RECORD_TIMESTAMP
      Record Timestamp option key
      See Also:

    • USE_FUML_DECISION_SEMANTICS

      public static final String USE_FUML_DECISION_SEMANTICS
      Use fUML Decision Semantics option key
      See Also:

    • AUTO_CREATE_FUML_OBJECT_OF_OUTPUT_PIN

      public static final String AUTO_CREATE_FUML_OBJECT_OF_OUTPUT_PIN
      Auto Create fUML Object of Output Pin option key
      See Also:

    • SOLVE_AFTER_INITIALIZATION

      public static final String SOLVE_AFTER_INITIALIZATION
      Solve After Initialization option key
      See Also:

    • DEFAULT_PARAMETRIC_EVALUATOR

      public static final String DEFAULT_PARAMETRIC_EVALUATOR
      Default Parametric Evaluator option key
      See Also:

    • EXTERNAL_SOLVER_TIMEOUT

      public static final String EXTERNAL_SOLVER_TIMEOUT
      External Solver Timeout option key
      See Also:

    • EXTERNAL_LIBRARIES

      public static final String EXTERNAL_LIBRARIES
      External Libraries option key
      See Also:

    • CHECK_MODEL_BEFORE_EXECUTION

      public static final String CHECK_MODEL_BEFORE_EXECUTION
      Check Model Before Execution option key
      See Also:

    • SHOW_FLOWING_INFORMATION

      public static final String SHOW_FLOWING_INFORMATION
      Show Flowing Information option key
      See Also:

    • RUNTIME_VALUE_TEXT_COLOR_ON_PART_SHAPES

      public static final String RUNTIME_VALUE_TEXT_COLOR_ON_PART_SHAPES
      Runtime Value Text Color on Part Shapes option key
      See Also:

    • SHOW_ACTIVE_STATES_ON_PART_SHAPES

      public static final String SHOW_ACTIVE_STATES_ON_PART_SHAPES
      Show Active States on Part Shapes option key
      See Also:

    • SHOW_RUNTIME_VALUES_ON_PART_SHAPES

      public static final String SHOW_RUNTIME_VALUES_ON_PART_SHAPES
      Show Runtime Values on Part Shapes option key
      See Also:

    • SHOW_ACTIVE_STATE_IMAGES_ON_PART_SHAPES

      public static final String SHOW_ACTIVE_STATE_IMAGES_ON_PART_SHAPES
      Show Active State Images on Part Shapes option key
      See Also:

    • SHOW_ACTIVE_STATE_IMAGES

      public static final String SHOW_ACTIVE_STATE_IMAGES
      Show Active State Images option key
      See Also:

    • SHOW_HELD_TOKENS_IN_ACTIVITY_DIAGRAM

      public static final String SHOW_HELD_TOKENS_IN_ACTIVITY_DIAGRAM
      Show Held Tokens in Activity Diagram option key
      See Also:

    • PASS_CALLER_CONTEXT

      public static final String PASS_CALLER_CONTEXT
      Pass Caller Context option key
      See Also:

    • TERMINATE_NESTED_BEHAVIORS

      public static final String TERMINATE_NESTED_BEHAVIORS
      Terminate Nested Behaviors option key
      See Also:

    • TERMINATE_STREAMING_BEHAVIORS_BY_OUTPUT_PARAMETER_MULTIPLICITY

      public static final String TERMINATE_STREAMING_BEHAVIORS_BY_OUTPUT_PARAMETER_MULTIPLICITY
      Terminate Streaming Behaviors by Output Parameter Multiplicity option key
      See Also:

    • ALLOW_CONCURRENT_ALLOCATED_ACTIVITIES

      public static final String ALLOW_CONCURRENT_ALLOCATED_ACTIVITIES
      Allow Concurrent Allocated Activities option key
      See Also:

    • AUTO_CONVERT_UNITS

      public static final String AUTO_CONVERT_UNITS
      Turns on live unit conversion during simulation.
      See Also:

    • UI

      public static final String UI
      UI option key
      See Also:

    • ADD_CONTROL_PANEL

      public static final String ADD_CONTROL_PANEL
      Add Control Panel option key
      See Also:

    • ANIMATION_SPEED

      public static final String ANIMATION_SPEED
      Animation Speed option key
      See Also:

    • CLONE_REFERENCES

      public static final String CLONE_REFERENCES
      Clone References option key
      See Also:

    • CONSTRAINT_FAILURE_AS_BREAKPOINT

      public static final String CONSTRAINT_FAILURE_AS_BREAKPOINT
      Constraint Failure as Breakpoint option key
      See Also:

    • DECIMAL_PLACES

      public static final String DECIMAL_PLACES
      Decimal Places option key
      See Also:

    • DURATION_SIMULATION_MODE

      public static final String DURATION_SIMULATION_MODE
      Duration Simulation Mode option key
      See Also:

    • ENDTIME

      public static final String ENDTIME
      Endtime option key
      See Also:

    • EXCLUDED_ELEMENTS

      public static final String EXCLUDED_ELEMENTS
      Excluded Elements option key
      See Also:

    • EXECUTION_LISTENERS

      public static final String EXECUTION_LISTENERS
      Execution Listeners option key
      See Also:

    • EXECUTION_TARGET

      public static final String EXECUTION_TARGET
      Execution Target option key
      See Also:

    • AUTOMATIC_PARAMETRIC_RECALCULATION

      public static final String AUTOMATIC_PARAMETRIC_RECALCULATION
      Automatic Parametric Recalculation option key
      See Also:

    • INITIALIZE_REFERENCES

      public static final String INITIALIZE_REFERENCES
      Initialize References option key
      See Also:

    • LOG

      public static final String LOG
      Log option key
      See Also:

    • NUMBER_OF_RUNS

      public static final String NUMBER_OF_RUNS
      Number of Runs option key
      See Also:

    • NUMBER_OF_STEPS

      public static final String NUMBER_OF_STEPS
      Number of Steps option key
      See Also:

    • OPEN_SIMULATION_PANE

      public static final String OPEN_SIMULATION_PANE
      Display Simulation Dashboard Window option key
      See Also:

    • REMEMBER_FAILURE_STATUS

      public static final String REMEMBER_FAILURE_STATUS
      Remember Failure Status option key
      See Also:

    • RESULT_LOCATION

      public static final String RESULT_LOCATION
      Result Location option key
      See Also:

    • RUN_FORKS_IN_PARALLEL

      public static final String RUN_FORKS_IN_PARALLEL
      Run Forks in Parallel option key
      See Also:

    • START_TIME

      public static final String START_TIME
      Start Time option key
      See Also:

    • START_WEB_SERVER

      public static final String START_WEB_SERVER
      Start Web Server option key
      See Also:

    • STARTUP_DIAGRAM

      public static final String STARTUP_DIAGRAM
      Startup Diagram option key
      See Also:

    • STEP_DELAY

      public static final String STEP_DELAY
      Step Delay option key
      See Also:

    • STEP_SIZE

      public static final String STEP_SIZE
      Step Size option key
      See Also:

    • TIME_UNIT

      public static final String TIME_UNIT
      Time Unit option key
      See Also:

    • TIME_VALUE

      public static final String TIME_VALUE
      Time Value option key
      See Also:

    • TIME_VARIABLE_NAME

      public static final String TIME_VARIABLE_NAME
      Time Variable Name option key
      See Also:

    • CLOCK_RATIO

      public static final String CLOCK_RATIO
      Clock Ratio option key
      See Also:

    • AUTO_TERMINATE

      public static final String AUTO_TERMINATE
      Auto terminate execution option key
      See Also:

    • CAPTURE_TIMESTAMP

      public static final String CAPTURE_TIMESTAMP
      Capture timestamp of result instance option key
      See Also:

  • Constructor Details

    • SimulationOptions

      public SimulationOptions()

  • Method Details

    • set

      public void set(String optionName, @CheckForNull Object value)
      Add the option.
      Parameters:
      optionName - the option name
      value - the option value

    • setIfAbsent

      public void setIfAbsent(String optionName, @CheckForNull Object value)
      Sets without overwriting: the provided value is only set when no non-null value exists by this key yet
      Parameters:
      optionName - the option name
      value - the option value

    • get

      @CheckForNull public Object get(String optionName)
      Get the option value from the specified option name.
      Parameters:
      optionName - the option name
      Returns:
      the option value from the specified option name

    • is

      public boolean is(String optionName)
      Get the Boolean option value from the specified option name.
      Parameters:
      optionName - the option name
      Returns:
      true if value of given option value is equal to Boolean.TRUE

    • addOption

      @Deprecated public void addOption(String optionName, @CheckForNull Object optionValue)
      Deprecated.
      use set(String, Object) instead

    • getOption

      @Deprecated @CheckForNull public Object getOption(String optionName)
      Deprecated.
      use shorter and more convenient get(String)