Package nom.tam.fits.header
Enum HierarchicalGrouping
- java.lang.Object
-
- java.lang.Enum<HierarchicalGrouping>
-
- nom.tam.fits.header.HierarchicalGrouping
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<HierarchicalGrouping>
,IFitsHeader
public enum HierarchicalGrouping extends java.lang.Enum<HierarchicalGrouping> implements IFitsHeader
This data dictionary contains FITS keywords that have been widely used within the astronomical community. It is recommended that these keywords only be used as defined here. These are the Hierarchical file grouping keywords.- Author:
- Richard van Nieuwenhoven
- See Also:
- http://heasarc.gsfc.nasa.gov/docs/fcg/common_dict.html
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface nom.tam.fits.header.IFitsHeader
IFitsHeader.HDU, IFitsHeader.SOURCE, IFitsHeader.VALUE
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
comment()
IFitsHeader.HDU
hdu()
java.lang.String
key()
IFitsHeader
n(int... number)
IFitsHeader.SOURCE
status()
static HierarchicalGrouping
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static HierarchicalGrouping[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.IFitsHeader.VALUE
valueType()
-
-
-
Enum Constant Detail
-
GRPIDn
public static final HierarchicalGrouping GRPIDn
TODO: find description?
-
GRPLCn
public static final HierarchicalGrouping GRPLCn
TODO: find description?
-
GRPNAME
public static final HierarchicalGrouping GRPNAME
the grouping table name. TODO: find description?
-
-
Method Detail
-
values
public static HierarchicalGrouping[] 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 (HierarchicalGrouping c : HierarchicalGrouping.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static HierarchicalGrouping 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.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
comment
public java.lang.String comment()
- Specified by:
comment
in interfaceIFitsHeader
-
hdu
public IFitsHeader.HDU hdu()
- Specified by:
hdu
in interfaceIFitsHeader
-
key
public java.lang.String key()
- Specified by:
key
in interfaceIFitsHeader
-
n
public IFitsHeader n(int... number)
- Specified by:
n
in interfaceIFitsHeader
-
status
public IFitsHeader.SOURCE status()
- Specified by:
status
in interfaceIFitsHeader
-
valueType
public IFitsHeader.VALUE valueType()
- Specified by:
valueType
in interfaceIFitsHeader
-
-