edu.nrao.sss.model.resource
Enum TelescopeConfiguration

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

All Implemented Interfaces:

Serializable, Comparable<TelescopeConfiguration>

public enum TelescopeConfiguration
extends Enum<TelescopeConfiguration>

A particular configuration of a telescope.

A telescope configuration is typically most appropriate for telescopes that consist of multiple antennas or mirrors, such as the VLA. More information about the VLA's configurations, and a schedule for when the array is in a given configuration, can be found at the VLA Configurations page.

(This class replaces the old VlaConfiguration class.)

Version Info:

$Revision: 2258 $

$Date: 2009-04-24 13:25:38 -0600 (Fri, 24 Apr 2009) $

$Author: dharland $

Since:

2006-11-13

Author:

David M. Harland

Enum Constant Summary

ANY
An unspecified configuration applicable to all telescopes.

VLA_A
The A configuration of the Very Large Array.

VLA_AtoBnA
Represents the VLA as it is being moved from the A to the B/A Hybrid configuration.

VLA_B
The B configuration of the Very Large Array.

VLA_BnA
A hybrid of the VLA B and A configurations.

VLA_BnAtoB
Represents the VLA as it is being moved from the B/A Hybrid to the B configuration.

VLA_BtoCnB
Represents the VLA as it is being moved from the B to the C/B Hybrid configuration.

VLA_C
The C configuration of the Very Large Array.

VLA_CnB
A hybrid of the VLA C and B configurations.

VLA_CnBtoC
Represents the VLA as it is being moved from the C/B Hybrid to the C configuration.

VLA_CtoDnC
Represents the VLA as it is being moved from the C to the D/C Hybrid configuration.

VLA_D
The D configuration of the Very Large Array.

VLA_DnC
A hybrid of the VLA D and C configurations.

VLA_DnCtoD
Represents the VLA as it is being moved from the D/C Hybrid to the D configuration.

VLA_DtoA
Represents the VLA as it is being moved from the D to the A configuration.

Method Summary

static TelescopeConfiguration	fromString(String text) Returns the telescope configuration represented by text.
String	getCode() Returns a short code for this configuration.
static TelescopeConfiguration	getDefault() Returns a default telescope configuration.
static Set<TelescopeConfiguration>	getElementsFor(TelescopeType telescope) Returns the subset of elements that are appropriate for the given telescope.
String	getHistoricalCode() Returns another code for this configuration.
boolean	isCompatibleWith(TelescopeConfiguration other) Returns true if this configuration is compatible with other.
String	toString() Returns a text representation of this configuration.
static TelescopeConfiguration	valueOf(String name) Returns the enum constant of this type with the specified name.
static TelescopeConfiguration[]	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

VLA_A

public static final TelescopeConfiguration VLA_A

The A configuration of the Very Large Array.

This is the configuration where the antennas are most widely separated. Each arm of the array is 21 kilometers long.

VLA_B

public static final TelescopeConfiguration VLA_B

The B configuration of the Very Large Array.

This is the second-most widely separated configuration of the array.

VLA_C

public static final TelescopeConfiguration VLA_C

The C configuration of the Very Large Array.

This is the second-most tightly spaced configuration of the array.

VLA_D

public static final TelescopeConfiguration VLA_D

The D configuration of the Very Large Array.

This is the configuration where the antennas are most tightly spaced. Each antenna is within 0.6 kilometers of the center.

VLA_BnA

public static final TelescopeConfiguration VLA_BnA

A hybrid of the VLA B and A configurations.

In this configuration the east and west arms are in the B configuration, but the north arm is still in the A configuration.

VLA_CnB

public static final TelescopeConfiguration VLA_CnB

A hybrid of the VLA C and B configurations.

In this configuration the east and west arms are in the C configuration, but the north arm is still in the B configuration.

VLA_DnC

public static final TelescopeConfiguration VLA_DnC

A hybrid of the VLA D and C configurations.

In this configuration the east and west arms are in the D configuration, but the north arm is still in the C configuration.

VLA_AtoBnA

public static final TelescopeConfiguration VLA_AtoBnA

Represents the VLA as it is being moved from the A to the B/A Hybrid configuration.

VLA_BnAtoB

public static final TelescopeConfiguration VLA_BnAtoB

Represents the VLA as it is being moved from the B/A Hybrid to the B configuration.

VLA_BtoCnB

public static final TelescopeConfiguration VLA_BtoCnB

Represents the VLA as it is being moved from the B to the C/B Hybrid configuration.

VLA_CnBtoC

public static final TelescopeConfiguration VLA_CnBtoC

Represents the VLA as it is being moved from the C/B Hybrid to the C configuration.

VLA_CtoDnC

public static final TelescopeConfiguration VLA_CtoDnC

Represents the VLA as it is being moved from the C to the D/C Hybrid configuration.

VLA_DnCtoD

public static final TelescopeConfiguration VLA_DnCtoD

Represents the VLA as it is being moved from the D/C Hybrid to the D configuration.

VLA_DtoA

public static final TelescopeConfiguration VLA_DtoA

Represents the VLA as it is being moved from the D to the A configuration.

ANY

public static final TelescopeConfiguration ANY

An unspecified configuration applicable to all telescopes.

Clients use the ANY configuration when they are not concerned with the particular arrangement of the telescope. This element is also used to implement the Null Object Pattern. In situations where a method might be tempted to return null, this element is returned instead.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Returns a text representation of this configuration.

Overrides:

toString in class Enum<TelescopeConfiguration>

getCode

public String getCode()

Returns a short code for this configuration.

Examples: "A", "A->B/A" (for A to B/A hybrid), "B/A" (for B-north-A hybrid).

Returns:

a short code for this configuration.

Since:

2008-07-25

See Also:

getHistoricalCode()

getHistoricalCode

public String getHistoricalCode()

Returns another code for this configuration.

Returns:

a historical code for this configuration.

Since:

2009-04-24

isCompatibleWith

public boolean isCompatibleWith(TelescopeConfiguration other)

Returns true if this configuration is compatible with other.

The best way to understand compatibility is to imagine that the telescope is currently in the other configuration and that some specification says we may only use the telescope if it is in this configuration. In general, two configurations are compatible if either they are the same configuration or if one of them is the ANY configuration.

Parameters:

other - the configuration to be tested for compatibility.

Returns:

true if this configuration is compatible with other.

getDefault

public static TelescopeConfiguration getDefault()

Returns a default telescope configuration.

Returns:

a default telescope configuration.

fromString

public static TelescopeConfiguration fromString(String text)

Returns the telescope configuration represented by text.

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

Parameters:

text - a text representation of a telescope configuration.

Returns:

the telescope configuration represented by text.

getElementsFor

public static Set<TelescopeConfiguration> getElementsFor(TelescopeType telescope)

Returns the subset of elements that are appropriate for the given telescope.

Parameters:

telescope - the telescope for which a set of configurations is desired.

Returns:

a set of configurations for telescope.