Class TypeConstraint

java.lang.Object
com.dna.jopt.member.unit.condition.type.TypeConstraint
All Implemented Interfaces:
IConstraint, Serializable

public class TypeConstraint extends Object implements IConstraint
This class allows setting IConstraint on INode. A IResource needs to have the matching TypeQualification in order to give service to said Node.

Implementation example:


 //Defining a Node
 CapacityResource jack = new CapacityResource(
             "JackEssenQualified",
             51.45,
             7.01667,
             Duration.ofHours(10),
             Quantities.getQuantity(1200, KILO(METRE)),
             workingHours);
     rep1.setCost(100, 1, 1);

 // Defining a qualification and giving it to the Node
     TypeQualification typeQualification1 = new TypeQualification();
     typeQualification1.addType("plumbing");
     jack.addQualification(typeQualification1);

     opti.addElement(jack);

 // Defining a Constraint
 IConstraint typeConstraint = new TypeConstraint();
 ((TypeConstraint) typeConstraint).addType("plumbing");
 typeConstraint.setIsHard(true);

 Duration visitDuration = Duration.ofMinutes(20);

 // Defining a Node and giving it the Constraint
 TimeWindowGeoNode aachen =
 new TimeWindowGeoNode("Aachen", 50.775346, 6.083887, weeklyOpeningHours, visitDuration, 1);
 aachen.addConstraint(typeConstraint);
 this.addElement(aachen);
 
Since:
13/08/2019
Version:
09/09/2019
Author:
DNA
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    com.dna.jopt.assessment.costassessorrestriction.restrictionresult.IEntityRestrictionResult
    assessConstraint(IEntity en, ILogicEntityRoute route, INode node, com.dna.jopt.assessment.costadjustment.IEntityCostAdjuster cad, com.dna.jopt.assessment.costassessor.IEntityCostAssessor ca, com.dna.jopt.framework.inputplausibility.properties.IPropertyProvider propertyProvider, boolean resultRequested)
    Assesses the route, checking if the appropriate qualifications for the constraints are present.
    Gets the title of the constraint.
     
    boolean
     
    boolean
    Checks the parameter or directly returns true where this must be the case.
    boolean
    isSatisfied(com.dna.jopt.assessment.costassessor.IEntityCostAssessor ca, INode node, ILogicEntityRoute route)
    Filters out hard constraint mismatches by checking whether a Node demands a Qualification as a hard constraint but the Resource does not provide this one.
    void
    setIsHard(boolean isHard)
    Sets the constraint to hard if the respective parameter is given or returns an IllegalStateException if this is expected but not the case.
    void
     
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • TypeConstraint

      public TypeConstraint()
  • Method Details

    • getTitle

      public String getTitle()
      Description copied from interface: IConstraint
      Gets the title of the constraint.
      Specified by:
      getTitle in interface IConstraint
      Returns:
      the title
    • isHard

      public boolean isHard()
      Description copied from interface: IConstraint
      Checks the parameter or directly returns true where this must be the case.
      Specified by:
      isHard in interface IConstraint
      Returns:
      the value of the checked boolean
    • setIsHard

      public void setIsHard(boolean isHard)
      Description copied from interface: IConstraint
      Sets the constraint to hard if the respective parameter is given or returns an IllegalStateException if this is expected but not the case.
      Specified by:
      setIsHard in interface IConstraint
      Parameters:
      isHard - the boolean to be set
    • isSatisfied

      public boolean isSatisfied(com.dna.jopt.assessment.costassessor.IEntityCostAssessor ca, INode node, ILogicEntityRoute route)
      Description copied from interface: IConstraint
      Filters out hard constraint mismatches by checking whether a Node demands a Qualification as a hard constraint but the Resource does not provide this one. The idea is to have only soft constraints problems in the optimisation which can get solved by adding cost.
      Specified by:
      isSatisfied in interface IConstraint
      Parameters:
      ca - the iEntityCostAssessor
      node - the iNode
      route - the iLogicEntityRoute
      Returns:
      the boolean whether the route is satisfied. True means no problems detected
    • assessConstraint

      public com.dna.jopt.assessment.costassessorrestriction.restrictionresult.IEntityRestrictionResult assessConstraint(IEntity en, ILogicEntityRoute route, INode node, com.dna.jopt.assessment.costadjustment.IEntityCostAdjuster cad, com.dna.jopt.assessment.costassessor.IEntityCostAssessor ca, com.dna.jopt.framework.inputplausibility.properties.IPropertyProvider propertyProvider, boolean resultRequested)
      Description copied from interface: IConstraint
      Assesses the route, checking if the appropriate qualifications for the constraints are present.

      The boolean true saves the data.

      Specified by:
      assessConstraint in interface IConstraint
      Parameters:
      en - entity
      route - the iLogicEntityRoute
      node - node
      cad - iEntityCostAdjuster
      ca - ca
      propertyProvider - iPropertyProvider
      resultRequested - the boolean whether to save the results of the route
      Returns:
      Entity Restriction Result
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • addType

      public void addType(String type)
    • getTypes

      public List<String> getTypes()
    • setTypes

      public void setTypes(List<String> types)
    • hasMembers

      public boolean hasMembers()
      Specified by:
      hasMembers in interface IConstraint