View Javadoc
1   package nom.tam.fits.header.extra;
2   
3   import nom.tam.fits.header.DateTime;
4   
5   /*
6    * #%L
7    * nom.tam FITS library
8    * %%
9    * Copyright (C) 1996 - 2024 nom-tam-fits
10   * %%
11   * This is free and unencumbered software released into the public domain.
12   *
13   * Anyone is free to copy, modify, publish, use, compile, sell, or
14   * distribute this software, either in source code form or as a compiled
15   * binary, for any purpose, commercial or non-commercial, and by any
16   * means.
17   *
18   * In jurisdictions that recognize copyright laws, the author or authors
19   * of this software dedicate any and all copyright interest in the
20   * software to the public domain. We make this dedication for the benefit
21   * of the public at large and to the detriment of our heirs and
22   * successors. We intend this dedication to be an overt act of
23   * relinquishment in perpetuity of all present and future rights to this
24   * software under copyright law.
25   *
26   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27   * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
29   * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30   * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31   * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32   * OTHER DEALINGS IN THE SOFTWARE.
33   * #L%
34   */
35  
36  import nom.tam.fits.header.FitsKey;
37  import nom.tam.fits.header.IFitsHeader;
38  
39  /**
40   * This is the file represents the common keywords between CXC and STSclExt. See e.g. the ASC keywords at
41   * <a href="https://planet4589.org/astro/sds/asc/ps/SDS05.pdf">https://planet4589.org/astro/sds/asc/ps/SDS05.pdf</a> for
42   * defititions of these. .
43   * 
44   * @deprecated These are available both in the {@link CXCExt} and {@link STScIExt} enums. This class may be removed in
45   *                 the future.
46   * 
47   * @see        STScIExt
48   * @see        CXCExt
49   * 
50   * @author     Attila Kovacs and Richard van Nieuwenhoven
51   */
52  @Deprecated
53  public enum CXCStclSharedExt implements IFitsHeader {
54  
55      /**
56       * Same as {@link STScIExt#CLOCKAPP}.
57       */
58      @Deprecated
59      CLOCKAPP(STScIExt.CLOCKAPP),
60  
61      /**
62       * Same as {@link STScIExt#MJDREF}.
63       */
64      @Deprecated
65      MJDREF(STScIExt.MJDREF),
66  
67      /**
68       * Same as {@link STScIExt#TASSIGN}.
69       */
70      @Deprecated
71      TASSIGN(STScIExt.TASSIGN),
72  
73      /**
74       * Same as {@link DateTime#TIMEDEL}.
75       */
76      @Deprecated
77      TIMEDEL(DateTime.TIMEDEL),
78  
79      /**
80       * Same as {@link STScIExt#TIMEREF}.
81       */
82      @Deprecated
83      TIMEREF(STScIExt.TIMEREF),
84  
85      /**
86       * Same as {@link STScIExt#TIMEUNIT}.
87       */
88      @Deprecated
89      TIMEUNIT(STScIExt.TIMEUNIT),
90  
91      /**
92       * Same as {@link STScIExt#TIMVERSN}.
93       */
94      @Deprecated
95      TIMVERSN(STScIExt.TIMVERSN),
96  
97      /**
98       * Same as {@link STScIExt#TIMEZERO}.
99       */
100     @Deprecated
101     TIMEZERO(STScIExt.TIMEZERO),
102 
103     /**
104      * Same as {@link STScIExt#TSTART}.
105      */
106     @Deprecated
107     TSTART(STScIExt.TSTART),
108 
109     /**
110      * Same as {@link CXCStclSharedExt#TSTOP}.
111      */
112     @Deprecated
113     TSTOP(STScIExt.TSTOP);
114 
115     private final FitsKey key;
116 
117     CXCStclSharedExt(IFitsHeader orig) {
118         key = orig.impl();
119     }
120 
121     @Deprecated
122     @Override
123     public final FitsKey impl() {
124         return key;
125     }
126 
127 }