HiRISE

HiRISE.HiPlan.HOGG
Enum Flight_Settings.Side

java.lang.Object
  extended by java.lang.Enum<Flight_Settings.Side>
      extended by HiRISE.HiPlan.HOGG.Flight_Settings.Side
All Implemented Interfaces:
Serializable, Comparable<Flight_Settings.Side>
Enclosing class:
Flight_Settings

public static enum Flight_Settings.Side
extends Enum<Flight_Settings.Side>

An enumeration defining the redundant electronics "sides" of HiRISE.

Version:
2.5
Author:
Christian Schaller - UA/PIRL

Enum Constant Summary
SIDE_A
          The primary side.
SIDE_B
          The redundant or secondary side.
 
Method Summary
 String getDescription()
          Gets the side's description.
 String getName()
          Gets the name of this side.
 char getSide()
          Gets the designation for this side.
static Flight_Settings.Side valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Flight_Settings.Side[] 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

SIDE_A

public static final Flight_Settings.Side SIDE_A
The primary side.


SIDE_B

public static final Flight_Settings.Side SIDE_B
The redundant or secondary side.

Method Detail

values

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

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

valueOf

public static Flight_Settings.Side 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

getName

public String getName()
Gets the name of this side. The name is a more conventional English version of the enum's value: Side A or Side B.

Returns:
the side's name.

getSide

public char getSide()
Gets the designation for this side. The designation is the one-character identifier: A or B.

Returns:
the side's designation.

getDescription

public String getDescription()
Gets the side's description. The description is a brief explanation of the side's use: Primary or Secondary.

Returns:
the side's description.

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona