Package com.agi.moxie.api.stereotypes

Class MoxieSimulation

java.lang.Object
com.agi.moxie.api.stereotypes.MoxieSimulation
public final class MoxieSimulation extends Object

This stereotype defines an instance as an executable simulation for Behavior Execution Engine. The tag data in any other Moxie-Base::Configuration stereotypes applied to the same instance will be available to any analysis tools prior to starting the simulation. This also indicates to Behavior Execution Engine the time at which the simulation starts and the time after which events will no longer be processed.

In order to apply this interval to a particular simulation, ensure that the stereotype (Moxie-Base::Configuration::MoxieSimulation) is applied to the InstanceSpecification used as the execution target for the simulation. This is often an instance of Moxie-Base::Simulation::SimulationSpecification but can be any instance so long as Moxie-Base::Configuration::MoxieSimulation is applied.

See StereotypeImplementationFor for more details.

  • Field Details

    • FullyQualifiedSysMlName

      public static final String FullyQualifiedSysMlName
      The fully-qualified SysML name for this element
      See Also:

    • XmiId

      public static final String XmiId
      The XMI ID generated in MOXIE-Base for this element.
      See Also:

  • Constructor Details

    • MoxieSimulation

      public MoxieSimulation(String simulationStart, String simulationStop, Boolean keepStateMachinesActive)
      Create a new instance based on the input from the applied stereotype tags.
      Parameters:
      simulationStart - The start of the simulation interval used as the initial time of the simulation execution prior to processing events.
      simulationStop - The stop of the simulation interval after which the execution engine will not process any further events.
      keepStateMachinesActive - Indicates whether to leave highlighting of state machines active rather than terminating the simulation after exhausting all events prior to and including the simulationStop. Note that if this is not specified, the simulation will use whatever settings have been configured in the environment settings in Magic Draw under Options > Environment > Moxie.

  • Method Details

    • Default

      public static MoxieSimulation Default()
      The default value to use for the Behavior Execution Engine simulation settings if no stereotype is applied. These settings were chosen to provide a useful default for simulations that aren't concerned with a specific analysis start time.
      Returns:
      The default instance.

    • getSimulationStart

      public MoxieTime getSimulationStart()
      The start of the simulation interval used as the initial time of the simulation execution prior to processing events.
      Returns:
      The time in the simulation when event detection starts.

    • getSimulationStop

      public MoxieTime getSimulationStop()
      The stop of the simulation interval after which the execution engine will not process any further events.
      Returns:
      The time in the simulation at which event detection will stop.

    • getSimulationInterval

      public Interval<MoxieTime> getSimulationInterval()
      Returns an interval spanning from the start to the stop time.
      Returns:
      The simulation interval for the simulation.

    • getKeepStateMachinesActive

      @Nullable public @Nullable Boolean getKeepStateMachinesActive()
      Returns the setting indicating whether the simulation will maintain the highlighting in the state machines after there are no further events. Otherwise, the simulation will complete and clear all of the highlighting before terminating the simulation. If this property is null, it indicates that the system will look for the default values provided by the environment settings. Note that if this is not specified, the simulation will use whatever settings have been configured in the environment settings in Magic Draw under Options > Environment > Moxie.
      Returns:
      True if the state highlighting will remain active. False if the simulation will terminate after exhausting all events. Otherwise, null indicates that no setting was specified.