Interface ISimulationService


  • public interface ISimulationService
    Interface for the time simulation service.
    • Field Detail

      • MODE_NORMAL

        static final java.lang.String MODE_NORMAL
        The execution mode normal.
        See Also:
        Constant Field Values
      • MODE_TIME_STEP

        static final java.lang.String MODE_TIME_STEP
        The execution mode time step.
        See Also:
        Constant Field Values
      • MODE_ACTION_STEP

        static final java.lang.String MODE_ACTION_STEP
        The execution mode action step.
        See Also:
        Constant Field Values
    • Method Detail

      • pause

        IFuture<java.lang.Void> pause()
        Pause the execution (can be resumed via start or step).
      • start

        IFuture<java.lang.Void> start()
        Restart the execution after pause.
      • stepEvent

        IFuture<java.lang.Void> stepEvent()
        Perform one event.
      • stepTime

        IFuture<java.lang.Void> stepTime()
        Perform all actions belonging to one time point.
      • setClockType

        IFuture<java.lang.Void> setClockType​(java.lang.String type)
        Set the clock type.
        Parameters:
        type - The clock type.
      • getMode

        IFuture<java.lang.String> getMode()
        Get the execution mode.
        Returns:
        The mode.
      • isExecuting

        IFuture<java.lang.Boolean> isExecuting()
        Test if context is executing.
      • getClockService

        IClockService getClockService()
        Get the platform clock.
        Returns:
        The clock.
      • getExecutorService

        IExecutionService getExecutorService()
        Get the executor service.
        Returns:
        The executor service.
      • addAdvanceBlocker

        IFuture<java.lang.Void> addAdvanceBlocker​(IFuture<?> blocker)
        Adds a blocker to the clock that prevents the clock from advancing until the future is triggered either by result or exception.
        Parameters:
        blocker - The blocking future.
        Returns:
        Null, when added.
      • addChangeListener

        void addChangeListener​(IChangeListener listener)
        Add a change listener.
        Parameters:
        listener - The change listener.
      • removeChangeListener

        void removeChangeListener​(IChangeListener listener)
        Remove a change listener.
        Parameters:
        listener - The change listener.