Package xal.extension.solver

Class TrialVeto

java.lang.Object
xal.extension.solver.TrialVeto
public final class TrialVeto extends Object
Trial veto turns down a trial based on a particular trial point.
Author:
ky6, t6p

  • Field Details

    • reason

      protected final String reason

    • userInfo

      protected final Object userInfo

    • trial

      protected final Trial trial

    • constraint

      protected final Constraint constraint

  • Constructor Details

    • TrialVeto

      public TrialVeto(Trial trial, Constraint constraint, String reason, Object userInfo)
      Primary Constructor.
      Parameters:
      trial - The trial to veto.
      constraint - The constraint to base the veto on.
      reason - describing why the veto was made
      userInfo - supplying additional user information to associate with the veto

    • TrialVeto

      public TrialVeto(Trial trial, Constraint constraint, String reason)
      Primary Constructor.
      Parameters:
      trial - The trial to veto.
      constraint - The constraint to base the veto on.
      reason - describing why the veto was made

    • TrialVeto

      public TrialVeto(Trial trial, Constraint constraint)
      Constructor.
      Parameters:
      trial - The trial to veto.
      constraint - The constraint to base the veto on.

  • Method Details

    • getTrialPoint

      public TrialPoint getTrialPoint()
      Get the trial point to be tested.
      Returns:
      trialPoint.

    • getTrial

      public Trial getTrial()
      Get the trial.
      Returns:
      trial.

    • getConstraint

      public Constraint getConstraint()
      Get the constraint.
      Returns:
      constraint.

    • getReason

      public String getReason()
      Get the reason for the veto
      Returns:
      the reason for the veto

    • getUserInfo

      public Object getUserInfo()
      Get the user info
      Returns:
      the user info