Class PointShiftsBuilder

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      PointShiftsBuilder addShift​(int scenarioIndex, java.lang.Object nodeIdentifier, double shiftAmount)
      Adds a shift for a parameter to the builder.
      PointShiftsBuilder addShifts​(int scenarioIndex, java.util.Map<?,​java.lang.Double> shiftMap)
      Adds multiple shifts to the builder.
      PointShifts build()
      Returns an instance of PointShifts built from the data in this builder.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • addShift

        public PointShiftsBuilder addShift​(int scenarioIndex,
                                           java.lang.Object nodeIdentifier,
                                           double shiftAmount)
        Adds a shift for a parameter to the builder.
        Parameters:
        scenarioIndex - the index of the scenario containing the shift
        nodeIdentifier - the identifier of the node to which the shift should be applied
        shiftAmount - the size of the shift
        Returns:
        this builder
      • addShifts

        public PointShiftsBuilder addShifts​(int scenarioIndex,
                                            java.util.Map<?,​java.lang.Double> shiftMap)
        Adds multiple shifts to the builder.
        Parameters:
        scenarioIndex - the index of the scenario containing the shifts
        shiftMap - the shift amounts, keyed by the identifier of the node to which they should be applied
        Returns:
        this builder
      • build

        public PointShifts build()
        Returns an instance of PointShifts built from the data in this builder.
        Returns:
        an instance of PointShifts built from the data in this builder