Class SimulationAction<T extends Help>

Object
Action
SimulationAction<T>
All Implemented Interfaces:
Help

public class SimulationAction<T extends Help> extends Action
This action starts calculation of selected simulation. It's a programmatic version of the same action available in UI. As such it allows user to schedule the action in calculation flow formula.
  • Constructor Details

    • SimulationAction

      public SimulationAction(T backLink, Invocations<MethodInvocationRecord> invocations, String simulationLabel)
  • Method Details

    • setCalculate

      public SimulationAction<T> setCalculate(Boolean calculate)
      Whether the action is valid and should be triggered or not.
      Parameters:
      calculate -
      • true - calculation of the simulation is started as background process
      • false - calculation of the simulation is NOT started at all
    • setPriority

      public SimulationAction<T> setPriority(int priority)
      Sets the prority of this job.
      Parameters:
      priority - Default is 0 (lowest user-definable priority). Max value is 9.
      Returns:
    • setDistributedCalculationThreshold

      public SimulationAction<T> setDistributedCalculationThreshold(int threshold)
      Sets a job-individual threshold to start a distributed calculation. Please note: Any values below 1000 may very well be counter-productive and make the job slower!
      Parameters:
      threshold - The number of items that need to be part of the job in order to execute it in distributed mode.
      Returns:
    • back

      public T back()
    • setNextJobs

      public SimulationAction<T> setNextJobs(List<ChainedJobInfo> jobs)
      Defines subsequent follow-on jobs
      Parameters:
      jobs - List of ChainedJobInfo objects
      Returns:
    • getObjectName

      public String getObjectName()
    • getSimulationLabel

      public String getSimulationLabel()
    • getCalculate

      public Boolean getCalculate()
    • getPriority

      public int getPriority()
    • getDistributedCalculationThreshold

      public int getDistributedCalculationThreshold()
    • getNextJobs

      public List<ChainedJobInfo> getNextJobs()
    • toString

      public String toString()
      Overrides:
      toString in class Object