Class Schedule.Builder

  • Enclosing class:
    Schedule

    public static class Schedule.Builder
    extends java.lang.Object
    A builder for configuring the set up of a Schedule
    • Constructor Detail

      • Builder

        public Builder​(ModelElement parent)
        Parameters:
        parent - the parent of the schedule
    • Method Detail

      • name

        public Schedule.Builder name​(java.lang.String name)
        Parameters:
        name - the name of the schedule
        Returns:
        the builder
      • noAutoStart

        public Schedule.Builder noAutoStart()
        Specifies that the schedule should not auto start
        Returns:
        the builder
      • noRepeats

        public Schedule.Builder noRepeats()
        Specifies that the schedule should not repeat
        Returns:
        the builder
      • startTime

        public Schedule.Builder startTime​(double startTime)
        Parameters:
        startTime - the time relative to the start of the simulation that indicates when the schedule should start, must be greater than or equal to zero. The default is zero.
        Returns:
        the builder
      • length

        public Schedule.Builder length​(double length)
        Parameters:
        length - the total length or duration of the schedule
        Returns:
        the Builder
      • priority

        public Schedule.Builder priority​(int priority)
        Parameters:
        priority - the priority of the schedule's start event
        Returns:
        the Builder
      • itemPriority

        public Schedule.Builder itemPriority​(int priority)
        Parameters:
        priority - the default priority associated with the item's start events
        Returns:
      • build

        public Schedule build()
        Builds the schedule
        Returns:
        the Schedule