edu.nrao.sss.model.project.scheduling.constraint
Enum ConstraintType

java.lang.Object
  java.lang.Enum<ConstraintType>
      edu.nrao.sss.model.project.scheduling.constraint.ConstraintType

All Implemented Interfaces:

Serializable, Comparable<ConstraintType>

public enum ConstraintType
extends Enum<ConstraintType>

An enumeration of operating conditions that may affect the probability of a scheduling achieving its scientific goals.

Enum Constant Summary

API
Atmospheric Phase Interference.

POSITION_ELEVATION
The sine of the current elevation of the target or 0 if the target is not currently visible.

POSITION_MAXIMUM
The absolute value of the difference between the current LST and the LST at the maximum elevation is computed.

WIND
Wind speed.

Method Summary

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

WIND

public static final ConstraintType WIND

Wind speed.

API

public static final ConstraintType API

Atmospheric Phase Interference.

POSITION_ELEVATION

public static final ConstraintType POSITION_ELEVATION

The sine of the current elevation of the target or 0 if the target is not currently visible. The idea is to penalize a block if its elevation is low.

POSITION_MAXIMUM

public static final ConstraintType POSITION_MAXIMUM

The absolute value of the difference between the current LST and the LST at the maximum elevation is computed. The idea is to give a higher probability of success to an observation if it is close to the maximum elevation of the source.

Method Detail

values

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

Returns:

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

valueOf

public static ConstraintType 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 ConstraintType getDefault()

Returns a default constraint type.

Returns:

a default constraint type.

toString

public String toString()

Returns a text representation of this enumeration constant.

Overrides:

toString in class Enum<ConstraintType>

Returns:

a text representation of this enumeration constant.

fromString

public static ConstraintType fromString(String text)

Returns the constraint type represented by text.

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

Parameters:

text - a text representation of a priority type.

Returns:

the priority type represented by text.