Enum HierarchicalGrouping

java.lang.Object

java.lang.Enum<HierarchicalGrouping>

nom.tam.fits.header.HierarchicalGrouping

All Implemented Interfaces:

Serializable, Comparable<HierarchicalGrouping>, java.lang.constant.Constable, IFitsHeader

public enum HierarchicalGrouping
extends 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.

See http://heasarc.gsfc.nasa.gov/docs/fcg/common_dict.html

Author:

Richard van Nieuwenhoven

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Nested classes/interfaces inherited from interface IFitsHeader

IFitsHeader.HDU, IFitsHeader.SOURCE, IFitsHeader.VALUE

Modifier and Type	Interface	Description
static enum	IFitsHeader.HDU	An enumeration of HDU types in which a header keyword may be used.
static enum	IFitsHeader.SOURCE	Documentation sources for the various known conventions.
static enum	IFitsHeader.VALUE	Values types to which implementing keywords can be restricted to.

Enum Constant Summary

Enum Constants

Enum Constant	Description
GRPIDn	TODO: find description?
GRPLCn	TODO: find description?
GRPNAME	the grouping table name.

Field Summary

Fields inherited from interface IFitsHeader

MAX_INDEX

Modifier and Type	Field	Description
static final int	MAX_INDEX	Max numeric index we may use to replace n in the Java name of indexed variables.

Method Summary

Modifier and Type	Method	Description
final FitsKey	impl()	(primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.
static HierarchicalGrouping	valueOf(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.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface IFitsHeader

comment, extractIndices, hdu, key, n, status, valueType

Modifier and Type	Method	Description
default String	comment()	Returns the comment associated to this FITS header entry.
default int[]	extractIndices(String key)	Extracts the indices for this stndardized key from an actual keyword realization.
default IFitsHeader.HDU	hdu()	Returns the type of HDU(s) in which this header entry may be used.
default String	key()	Returns the FITS header keyword (or keyword template) for this header entry.
default IFitsHeader	n(int... numbers)	Constructs an indexed FITS header keyword entry from this stem, replacing index place-holders (indicated by lower-case 'n' in the name) with actual numerical values.
default IFitsHeader.SOURCE	status()	Returns the standard convention, which defines this FITS header entry
default IFitsHeader.VALUE	valueType()	The type(s) of value(s) this FITS header entry might take.

Enum Constant Details

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 Details

values

public static HierarchicalGrouping[] values()

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

Returns:

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

valueOf

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

impl

public final FitsKey impl()

Description copied from interface: IFitsHeader

(primarily for internal use) Returns the concrete implementation of this header entry, which provides implementation of access methods.

Specified by:

impl in interface IFitsHeader

Returns:

the implementation of this keyword, which provides the actual access methods. Implementations of this interface should simply return themselves.