Frequency (Repast Simphony 2.10 API)

java.lang.Object
- java.lang.Enum<Frequency>
- - repast.simphony.engine.schedule.Frequency

All Implemented Interfaces:

Serializable, Comparable<Frequency>
```
public enum Frequency
extends Enum<Frequency>
```
An enumeration of the types of execution frequency.

Version:

$Revision: 1.1 $ $Date: 2005/12/21 22:25:34 $

Author:

Nick Collier

Enum Constant Summary

Enum Constants
Enum Constant Description

AT_INTERVAL

AT_UPDATE

ON_MOVE

ON_NEW

ONE_TIME

REPEAT

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Frequency`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Frequency[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ONE_TIME
```
public static final Frequency ONE_TIME
```
  - REPEAT
```
public static final Frequency REPEAT
```
  - AT_INTERVAL
```
public static final Frequency AT_INTERVAL
```
  - ON_NEW
```
public static final Frequency ON_NEW
```
  - ON_MOVE
```
public static final Frequency ON_MOVE
```
  - AT_UPDATE
```
public static final Frequency AT_UPDATE
```
- Method Detail
  - values
```
public static Frequency[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (Frequency c : Frequency.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Frequency valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null