edu.nrao.sss.model.project
Enum SchedulingType

java.lang.Object
  java.lang.Enum<SchedulingType>
      edu.nrao.sss.model.project.SchedulingType

All Implemented Interfaces:

Serializable, Comparable<SchedulingType>

public enum SchedulingType
extends Enum<SchedulingType>

An enumeration of scheduling types.

This list is based on Bryan Butler's schedBlock_v2.xsd file from March 2006. It was then modified based on an email reply from B.Clark to D.Harland on 2008-01-10 regarding the overlap between ProjectType and SchedulingType.

Version Info:

$Revision: 1710 $

$Date: 2008-11-14 11:54:07 -0700 (Fri, 14 Nov 2008) $

$Author: dharland $

Since:

2006-07-28

Enum Constant Summary

DYNAMIC
Used for standard scheduling blocks that may be scheduled dynamically.

FIXED_DATE
Used for scheduling blocks that should begin a precise point in time.

MONITORING
Used for scheduling blocks that are rerun from time to time.

PERIODIC
Used for scheduling blocks that observe phenomena that occur on a periodic basis.

Method Summary

static SchedulingType	fromString(String text) Returns the scheduling type represented by text.
static SchedulingType	getDefault() Returns a default scheduling type.
String	toString() Returns a text representation of this enumeration constant.
static SchedulingType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SchedulingType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DYNAMIC

public static final SchedulingType DYNAMIC

Used for standard scheduling blocks that may be scheduled dynamically. The term standard is used to mean that the scheduling block is not used for monitoring or for observering periodic phenomena.

Find acceptable time interval. Priority for scheduling is very low if current time does not lie in this interval.
-- Barry Clark, from email to D.Harland, 2008-Jan-10

FIXED_DATE

public static final SchedulingType FIXED_DATE

Used for scheduling blocks that should begin a precise point in time.

MONITORING

public static final SchedulingType MONITORING

Used for scheduling blocks that are rerun from time to time.

Find requested monitoring interval and time of last observation. Priority for scheduling is low in the interval between the time of the last observation and, say, the time of the last observation +0.8*(monitoring interval).
-- Barry Clark, from email to D.Harland, 2008-Jan-10

PERIODIC

public static final SchedulingType PERIODIC

Used for scheduling blocks that observe phenomena that occur on a periodic basis.

Find period, reference time, and requested phase. Priority for scheduling is very low except when (current time + 0.5*observation length - reference time)/period - N is within, say, 0.1 of the requested phase.
-- Barry Clark, from email to D.Harland, 2008-Jan-10

Method Detail

values

public static SchedulingType[] 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 (SchedulingType c : SchedulingType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SchedulingType 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

getDefault

public static SchedulingType getDefault()

Returns a default scheduling type.

Returns:

a default scheduling type.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<SchedulingType>

Returns:

a text representation of this enumeration constant.

fromString

public static SchedulingType fromString(String text)

Returns the scheduling type represented by text.

For details about the transformation, see EnumerationUtility.enumFromString(Class, String).

Parameters:

text - a text representation of a scheduling type.

Returns:

the scheduling type represented by text.