ca.nrc.widar.mccc.crm
Enum CrmCommon.Baseband

java.lang.Object
  java.lang.Enum<CrmCommon.Baseband>
      ca.nrc.widar.mccc.crm.CrmCommon.Baseband

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CrmCommon.Baseband>

Enclosing class:

CrmCommon

public static enum CrmCommon.Baseband
extends java.lang.Enum<CrmCommon.Baseband>

Baseband Enum This enumeration encodes the various peculiarities of the different Baseband modes that are used to communicate the system status to the user via the GUI

Enum Constant Summary

BB0

BB1

BB2

BB3

blank

hi

warn

Method Summary

java.awt.Color	border() Return the color to be used for the border of this Baseband type
static CrmCommon.Baseband	get(int id) Supplied with an integer value, this method returns the associated enum value
java.lang.String	getBand(java.lang.Integer nBits, java.lang.Integer dp) Determines and returns the Baseband ID string to be used in identifying this Baseband type in the mode that is specified
int	getID() Returns the integer representation of the enum value
java.lang.String	getLabel(java.lang.Integer nBits, java.lang.Integer dp) Determines and returns the Baseband ID label to be used in the BBInfo objects on the GUI in the mode that is specified
java.lang.String	getPol(java.lang.Integer nBits, java.lang.Integer dp) Determines and returns the polarization string to be used for this Baseband type in the mode that is specified
java.awt.Color	in() Return the color to be used for input modes of this Baseband type
java.awt.Color	out() Return the color to be used for output modes of this Baseband type
java.lang.String	title() Return the title of this Baseband type
static CrmCommon.Baseband	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CrmCommon.Baseband[]	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

blank

public static final CrmCommon.Baseband blank

hi

public static final CrmCommon.Baseband hi

warn

public static final CrmCommon.Baseband warn

BB0

public static final CrmCommon.Baseband BB0

BB1

public static final CrmCommon.Baseband BB1

BB2

public static final CrmCommon.Baseband BB2

BB3

public static final CrmCommon.Baseband BB3

Method Detail

values

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

Returns:

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

valueOf

public static CrmCommon.Baseband valueOf(java.lang.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.)

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

title

public java.lang.String title()

Return the title of this Baseband type

Returns:

The string title

in

public java.awt.Color in()

Return the color to be used for input modes of this Baseband type

Returns:

The input color

out

public java.awt.Color out()

Return the color to be used for output modes of this Baseband type

Returns:

The output color

border

public java.awt.Color border()

Return the color to be used for the border of this Baseband type

Returns:

The border color

getPol

public java.lang.String getPol(java.lang.Integer nBits,
                               java.lang.Integer dp)

Determines and returns the polarization string to be used for this Baseband type in the mode that is specified

Parameters:

nBits - The integer number of bits

dp - The integer representing the data path (0 or 1)

Returns:

The polarization string for the specified mode

getBand

public java.lang.String getBand(java.lang.Integer nBits,
                                java.lang.Integer dp)

Determines and returns the Baseband ID string to be used in identifying this Baseband type in the mode that is specified

Parameters:

nBits - The integer number of bits

dp - The integer representing the data path (0 or 1)

Returns:

The baseband ID string for the specified mode

getLabel

public java.lang.String getLabel(java.lang.Integer nBits,
                                 java.lang.Integer dp)

Determines and returns the Baseband ID label to be used in the BBInfo objects on the GUI in the mode that is specified

Parameters:

nBits - The integer number of bits

dp - The integer representing the data path (0 or 1)

Returns:

The label string for the specified mode

getID

public int getID()

Returns the integer representation of the enum value

Returns:

The integer representation of the enum value

get

public static CrmCommon.Baseband get(int id)

Supplied with an integer value, this method returns the associated enum value

Parameters:

id - The integer value

Returns:

The Baseband enum value for the supplied integer id