Package repast.simphony.engine.schedule

Annotation Interface ScheduledMethod

@Retention(RUNTIME) @Target(METHOD) public @interface ScheduledMethod
Annotation for scheduling a method.
Version:
$Revision: 1.1 $ $Date: 2005/12/21 22:25:34 $
Author:
Nick Collier

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    double
    duration
    How many ticks the action can execute in the background while the tick count progresses.
    double
    interval
    Specifies the interval.
    long
    pick
    Specifies the number of objects that implement to this method to schedule this method on.
    double
    priority
    Priority w/r to other actions scheduled for the same tick.
    boolean
    shuffle
    Whether or not to randomize the scheduling of collections of agent methods, if more than one agent is being scheduled by this annonation.
    double
    start
    Specifies the start time

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final long
    ALL
     
    static final double
    END
     
    static final int
    NO_PARAMETERS
     

  • Field Details

  • Element Details

    • pick

      long pick
      Specifies the number of objects that implement to this method to schedule this method on. The objects will be drawn randomly from a Context. Default is to schedule all instances.
      Default:
      9223372036854775807L

    • start

      double start
      Specifies the start time
      Default:
      1.0/0.0

    • interval

      double interval
      Specifies the interval. If > 0, then the method is scheduled to repeat at the specified interval. Otherwise, method is scheduled for one time execution. Default is 0 meaning by default the method will only execute once.
      Default:
      0.0

    • priority

      double priority
      Priority w/r to other actions scheduled for the same tick. Default is ScheduleParameters.RANDOM_PRIORITY.
      Default:
      0.0/0.0

    • duration

      double duration
      How many ticks the action can execute in the background while the tick count progresses. Default is no duration meaning the method must finish execution before the next scheduled action can execute.
      Default:
      -1.0

    • shuffle

      boolean shuffle
      Whether or not to randomize the scheduling of collections of agent methods, if more than one agent is being scheduled by this annonation.
      Default:
      true