edu.nrao.sss.model.resource
Enum AntennaSelectionMethod

java.lang.Object
  java.lang.Enum<AntennaSelectionMethod>
      edu.nrao.sss.model.resource.AntennaSelectionMethod

All Implemented Interfaces:

Serializable, Comparable<AntennaSelectionMethod>

public enum AntennaSelectionMethod
extends Enum<AntennaSelectionMethod>

The way in which an observer selects antennas.

Version Info:

$Revision: 429 $

$Date: 2007-03-08 15:34:34 -0700 (Thu, 08 Mar 2007) $

$Author: dharland $

Since:

2007-03-07

Author:

David M. Harland

Enum Constant Summary

ALL
Select all available antennas.

LIST
Provide a list of specific antennas.

MINIMUM_NUMBER
Select a minimum number of antennas.

MINIMUM_NUMBER_EVEN_DISTRIBUTION
Select a minimum number of antennas, choosing XXX.

MINIMUM_NUMBER_LONGEST_BASELINES
Select a minimum number of antennas, choosing those that produce the longest baselines.

MINIMUM_NUMBER_SHORTEST_BASELINES
Select a minimum number of antennas, choosing those that produce the shortest baselines.

Method Summary

boolean	requiresManualIdentification() Returns true if this method requires clients to make a manual selection of antennas.
boolean	requiresMinimumNumberSpecification() Returns true if this method requires clients to specify a minimum number of antennas to select.
static AntennaSelectionMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static AntennaSelectionMethod[]	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

ALL

public static final AntennaSelectionMethod ALL

Select all available antennas.

LIST

public static final AntennaSelectionMethod LIST

Provide a list of specific antennas.

MINIMUM_NUMBER

public static final AntennaSelectionMethod MINIMUM_NUMBER

Select a minimum number of antennas.

MINIMUM_NUMBER_SHORTEST_BASELINES

public static final AntennaSelectionMethod MINIMUM_NUMBER_SHORTEST_BASELINES

Select a minimum number of antennas, choosing those that produce the shortest baselines.

MINIMUM_NUMBER_LONGEST_BASELINES

public static final AntennaSelectionMethod MINIMUM_NUMBER_LONGEST_BASELINES

Select a minimum number of antennas, choosing those that produce the longest baselines.

MINIMUM_NUMBER_EVEN_DISTRIBUTION

public static final AntennaSelectionMethod MINIMUM_NUMBER_EVEN_DISTRIBUTION

Select a minimum number of antennas, choosing XXX.

Method Detail

values

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

Returns:

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

valueOf

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

requiresManualIdentification

public boolean requiresManualIdentification()

Returns true if this method requires clients to make a manual selection of antennas.

Returns:

true if this method requires clients to make a manual selection of antennas.

requiresMinimumNumberSpecification

public boolean requiresMinimumNumberSpecification()

Returns true if this method requires clients to specify a minimum number of antennas to select.

Returns:

true if this method requires clients to specify a minimum number of antennas to select.