Package com.nomagic.magicdraw.simulation.execution

Class SimulationOptions

  • @OpenApiAll
public class SimulationOptions
extends java.lang.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 Detail

      • ACTIVE_COLOR

        public static final java.lang.String ACTIVE_COLOR
        Active symbol color option key
        See Also:
        Constant Field Values

      • VISITED_COLOR

        public static final java.lang.String VISITED_COLOR
        Visited symbol color option key
        See Also:
        Constant Field Values

      • BREAKPOINT_COLOR

        public static final java.lang.String BREAKPOINT_COLOR
        Breakpoint symbol color option key
        See Also:
        Constant Field Values

      • LAST_VISITED_COLOR

        public static final java.lang.String LAST_VISITED_COLOR
        Last visited symbol color option key
        See Also:
        Constant Field Values

      • RUNTIME_VALUE_TEXT_COLOR

        public static final java.lang.String RUNTIME_VALUE_TEXT_COLOR
        Runtime Value Text Color on Part Shapes option key
        See Also:
        Constant Field Values

      • AUTO_OPEN_DIAGRAMS

        public static final java.lang.String AUTO_OPEN_DIAGRAMS
        Auto open diagrams option key
        See Also:
        Constant Field Values

      • SILENT

        public static final java.lang.String SILENT
        Silent execution option key
        See Also:
        Constant Field Values

      • DEFAULT_LANGUAGE

        public static final java.lang.String DEFAULT_LANGUAGE
        Default Evaluation Language option key
        See Also:
        Constant Field Values

      • ENGINES_PRIORITY

        public static final java.lang.String ENGINES_PRIORITY
        Registered execution engine priority option key
        See Also:
        Constant Field Values

      • AUTO_START

        public static final java.lang.String AUTO_START
        Auto start execution option key
        See Also:
        Constant Field Values

      • AUTO_START_ACTIVE_OPTIONS

        public static final java.lang.String AUTO_START_ACTIVE_OPTIONS
        Auto Start Active Objects option key
        See Also:
        Constant Field Values

      • TREAT_ALL_OBJECTS_AS_ACTIVE

        public static final java.lang.String TREAT_ALL_OBJECTS_AS_ACTIVE
        Treat All Objects as Active option key
        See Also:
        Constant Field Values

      • TERMINATE_BEHAVIOR_ON_EXCEPTION_THROWN

        public static final java.lang.String TERMINATE_BEHAVIOR_ON_EXCEPTION_THROWN
        Terminate Behavior on Exception Thrown option key
        See Also:
        Constant Field Values

      • INITIALIZE_NUMERICAL_VALUE

        public static final java.lang.String INITIALIZE_NUMERICAL_VALUE
        Initialize Empty Values to 0 option key
        See Also:
        Constant Field Values

      • RECORD_STATE_CHANGE

        public static final java.lang.String RECORD_STATE_CHANGE
        Record State Change option key
        See Also:
        Constant Field Values

      • RECORD_VALUE_CHANGE

        public static final java.lang.String RECORD_VALUE_CHANGE
        Record Value Change option key
        See Also:
        Constant Field Values

      • RECORD_TIMESTAMP

        public static final java.lang.String RECORD_TIMESTAMP
        Record Timestamp option key
        See Also:
        Constant Field Values

      • USE_FUML_DECISION_SEMANTICS

        public static final java.lang.String USE_FUML_DECISION_SEMANTICS
        Use fUML Decision Semantics option key
        See Also:
        Constant Field Values

      • AUTO_CREATE_FUML_OBJECT_OF_OUTPUT_PIN

        public static final java.lang.String AUTO_CREATE_FUML_OBJECT_OF_OUTPUT_PIN
        Auto Create fUML Object of Output Pin option key
        See Also:
        Constant Field Values

      • SOLVE_AFTER_INITIALIZATION

        public static final java.lang.String SOLVE_AFTER_INITIALIZATION
        Solve After Initialization option key
        See Also:
        Constant Field Values

      • DEFAULT_PARAMETRIC_EVALUATOR

        public static final java.lang.String DEFAULT_PARAMETRIC_EVALUATOR
        Default Parametric Evaluator option key
        See Also:
        Constant Field Values

      • EXTERNAL_SOLVER_TIMEOUT

        public static final java.lang.String EXTERNAL_SOLVER_TIMEOUT
        External Solver Timeout option key
        See Also:
        Constant Field Values

      • EXTERNAL_LIBRARIES

        public static final java.lang.String EXTERNAL_LIBRARIES
        External Libraries option key
        See Also:
        Constant Field Values

      • CHECK_MODEL_BEFORE_EXECUTION

        public static final java.lang.String CHECK_MODEL_BEFORE_EXECUTION
        Check Model Before Execution option key
        See Also:
        Constant Field Values

      • SHOW_FLOWING_INFORMATION

        public static final java.lang.String SHOW_FLOWING_INFORMATION
        Show Flowing Information option key
        See Also:
        Constant Field Values

      • RUNTIME_VALUE_TEXT_COLOR_ON_PART_SHAPES

        public static final java.lang.String RUNTIME_VALUE_TEXT_COLOR_ON_PART_SHAPES
        Runtime Value Text Color on Part Shapes option key
        See Also:
        Constant Field Values

      • SHOW_ACTIVE_STATES_ON_PART_SHAPES

        public static final java.lang.String SHOW_ACTIVE_STATES_ON_PART_SHAPES
        Show Active States on Part Shapes option key
        See Also:
        Constant Field Values

      • SHOW_RUNTIME_VALUES_ON_PART_SHAPES

        public static final java.lang.String SHOW_RUNTIME_VALUES_ON_PART_SHAPES
        Show Runtime Values on Part Shapes option key
        See Also:
        Constant Field Values

      • SHOW_ACTIVE_STATE_IMAGES_ON_PART_SHAPES

        public static final java.lang.String SHOW_ACTIVE_STATE_IMAGES_ON_PART_SHAPES
        Show Active State Images on Part Shapes option key
        See Also:
        Constant Field Values

      • SHOW_ACTIVE_STATE_IMAGES

        public static final java.lang.String SHOW_ACTIVE_STATE_IMAGES
        Show Active State Images option key
        See Also:
        Constant Field Values

      • SHOW_HELD_TOKENS_IN_ACTIVITY_DIAGRAM

        public static final java.lang.String SHOW_HELD_TOKENS_IN_ACTIVITY_DIAGRAM
        Show Held Tokens in Activity Diagram option key
        See Also:
        Constant Field Values

      • PASS_CALLER_CONTEXT

        public static final java.lang.String PASS_CALLER_CONTEXT
        Pass Caller Context option key
        See Also:
        Constant Field Values

      • TERMINATE_NESTED_BEHAVIORS

        public static final java.lang.String TERMINATE_NESTED_BEHAVIORS
        Terminate Nested Behaviors option key
        See Also:
        Constant Field Values

      • TERMINATE_STREAMING_BEHAVIORS_BY_OUTPUT_PARAMETER_MULTIPLICITY

        public static final java.lang.String TERMINATE_STREAMING_BEHAVIORS_BY_OUTPUT_PARAMETER_MULTIPLICITY
        Terminate Streaming Behaviors by Output Parameter Multiplicity option key
        See Also:
        Constant Field Values

      • ALLOW_CONCURRENT_ALLOCATED_ACTIVITIES

        public static final java.lang.String ALLOW_CONCURRENT_ALLOCATED_ACTIVITIES
        Allow Concurrent Allocated Activities option key
        See Also:
        Constant Field Values

      • ADD_CONTROL_PANEL

        public static final java.lang.String ADD_CONTROL_PANEL
        Add Control Panel option key
        See Also:
        Constant Field Values

      • ANIMATION_SPEED

        public static final java.lang.String ANIMATION_SPEED
        Animation Speed option key
        See Also:
        Constant Field Values

      • CLONE_REFERENCES

        public static final java.lang.String CLONE_REFERENCES
        Clone References option key
        See Also:
        Constant Field Values

      • CONSTRAINT_FAILURE_AS_BREAKPOINT

        public static final java.lang.String CONSTRAINT_FAILURE_AS_BREAKPOINT
        Constraint Failure as Breakpoint option key
        See Also:
        Constant Field Values

      • DECIMAL_PLACES

        public static final java.lang.String DECIMAL_PLACES
        Decimal Places option key
        See Also:
        Constant Field Values

      • DURATION_SIMULATION_MODE

        public static final java.lang.String DURATION_SIMULATION_MODE
        Duration Simulation Mode option key
        See Also:
        Constant Field Values

      • ENDTIME

        public static final java.lang.String ENDTIME
        Endtime option key
        See Also:
        Constant Field Values

      • EXCLUDED_ELEMENTS

        public static final java.lang.String EXCLUDED_ELEMENTS
        Excluded Elements option key
        See Also:
        Constant Field Values

      • EXECUTION_LISTENERS

        public static final java.lang.String EXECUTION_LISTENERS
        Execution Listeners option key
        See Also:
        Constant Field Values

      • EXECUTION_TARGET

        public static final java.lang.String EXECUTION_TARGET
        Execution Target option key
        See Also:
        Constant Field Values

      • FIRE_VALUE_CHANGE_EVENT

        public static final java.lang.String FIRE_VALUE_CHANGE_EVENT
        Fire Value Change Event option key
        See Also:
        Constant Field Values

      • INITIALIZE_REFERENCES

        public static final java.lang.String INITIALIZE_REFERENCES
        Initialize References option key
        See Also:
        Constant Field Values

      • NUMBER_OF_RUNS

        public static final java.lang.String NUMBER_OF_RUNS
        Number of Runs option key
        See Also:
        Constant Field Values

      • NUMBER_OF_STEPS

        public static final java.lang.String NUMBER_OF_STEPS
        Number of Steps option key
        See Also:
        Constant Field Values

      • REMEMBER_FAILURE_STATUS

        public static final java.lang.String REMEMBER_FAILURE_STATUS
        Remember Failure Status option key
        See Also:
        Constant Field Values

      • RESULT_LOCATION

        public static final java.lang.String RESULT_LOCATION
        Result Location option key
        See Also:
        Constant Field Values

      • RUN_FORKS_IN_PARALLEL

        public static final java.lang.String RUN_FORKS_IN_PARALLEL
        Run Forks in Parallel option key
        See Also:
        Constant Field Values

      • START_TIME

        public static final java.lang.String START_TIME
        Start Time option key
        See Also:
        Constant Field Values

      • START_WEB_SERVER

        public static final java.lang.String START_WEB_SERVER
        Start Web Server option key
        See Also:
        Constant Field Values

      • STEP_DELAY

        public static final java.lang.String STEP_DELAY
        Step Delay option key
        See Also:
        Constant Field Values

      • STEP_SIZE

        public static final java.lang.String STEP_SIZE
        Step Size option key
        See Also:
        Constant Field Values

      • TIME_UNIT

        public static final java.lang.String TIME_UNIT
        Time Unit option key
        See Also:
        Constant Field Values

      • TIME_VALUE

        public static final java.lang.String TIME_VALUE
        Time Value option key
        See Also:
        Constant Field Values

      • TIME_VARIABLE_NAME

        public static final java.lang.String TIME_VARIABLE_NAME
        Time Variable Name option key
        See Also:
        Constant Field Values

      • OPEN_SIMULATION_PANE

        public static final java.lang.String OPEN_SIMULATION_PANE
        Display Simulation Dashboard Window option key
        See Also:
        Constant Field Values

      • STARTUP_DIAGRAM

        public static final java.lang.String STARTUP_DIAGRAM
        Startup Diagram option key
        See Also:
        Constant Field Values

    • Constructor Detail

      • SimulationOptions

        public SimulationOptions()

    • Method Detail

      • set

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

      • setIfAbsent

        public void setIfAbsent​(java.lang.String optionName,
                        @CheckForNull
                        java.lang.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 java.lang.Object get​(java.lang.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​(java.lang.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​(java.lang.String optionName,
                      @CheckForNull
                      java.lang.Object optionValue)
        Deprecated.
        use set(String, Object) instead

      • getOption

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