1 package nom.tam.fits.header;
2
3 /*
4 * #%L
5 * nom.tam FITS library
6 * %%
7 * Copyright (C) 1996 - 2024 nom-tam-fits
8 * %%
9 * This is free and unencumbered software released into the public domain.
10 *
11 * Anyone is free to copy, modify, publish, use, compile, sell, or
12 * distribute this software, either in source code form or as a compiled
13 * binary, for any purpose, commercial or non-commercial, and by any
14 * means.
15 *
16 * In jurisdictions that recognize copyright laws, the author or authors
17 * of this software dedicate any and all copyright interest in the
18 * software to the public domain. We make this dedication for the benefit
19 * of the public at large and to the detriment of our heirs and
20 * successors. We intend this dedication to be an overt act of
21 * relinquishment in perpetuity of all present and future rights to this
22 * software under copyright law.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
27 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
30 * OTHER DEALINGS IN THE SOFTWARE.
31 * #L%
32 */
33
34 /**
35 * <p>
36 * This data dictionary contains FITS keywords that have been widely used within the astronomical community. It is
37 * recommended that these keywords only be used as defined here. These are the Hierarchical file grouping keywords.
38 * </p>
39 * <p>
40 * See <a href=
41 * "http://heasarc.gsfc.nasa.gov/docs/fcg/common_dict.html">http://heasarc.gsfc.nasa.gov/docs/fcg/common_dict.html</a>
42 * </p>
43 *
44 * @author Richard van Nieuwenhoven
45 */
46 public enum HierarchicalGrouping implements IFitsHeader {
47 /**
48 * TODO: find description?
49 */
50 GRPIDn(SOURCE.HEASARC, HDU.TABLE, VALUE.STRING, ""),
51 /**
52 * TODO: find description?
53 */
54 GRPLCn(SOURCE.HEASARC, HDU.TABLE, VALUE.STRING, ""),
55 /**
56 * the grouping table name. TODO: find description?
57 */
58 GRPNAME(SOURCE.HEASARC, HDU.TABLE, VALUE.STRING, "the grouping table name");
59
60 private final FitsKey key;
61
62 HierarchicalGrouping(IFitsHeader.SOURCE status, HDU hdu, VALUE valueType, String comment) {
63 key = new FitsKey(name(), status, hdu, valueType, comment);
64 }
65
66 @Override
67 public final FitsKey impl() {
68 return key;
69 }
70 }