1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
|
#if !defined( TIMEFRAME_INCLUDED ) /* Include this file only once */
#define TIMEFRAME_INCLUDED
/*
*+
* Name:
* timeframe.h
* Type:
* C include file.
* Purpose:
* Define the interface to the TimeFrame class.
* Invocation:
* #include "timeframe.h"
* Description:
* This include file defines the interface to the TimeFrame class
* and provides the type definitions, function prototypes and
* macros, etc. needed to use this class.
* Copyright:
* Copyright (C) 1997-2006 Council for the Central Laboratory of the
* Research Councils
* Licence:
* This program is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation, either
* version 3 of the License, or (at your option) any later
* version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
* Authors:
* DSB: David S. Berry (Starlink)
* History:
* 20-MAY-2005 (DSB):
* Original version.
*-
*/
/* Include files. */
/* ============== */
/* Interface definitions. */
/* ---------------------- */
#include "object.h" /* Base Object class */
#include "frame.h" /* Parent Frame class */
#include "skyframe.h" /* Celestial coordinate systems */
/* Macros. */
/* ======= */
#if defined(astCLASS) || defined(astFORTRAN77)
#define STATUS_PTR status
#else
#define STATUS_PTR astGetStatusPtr
#endif
/* Define a dummy __attribute__ macro for use on non-GNU compilers. */
#ifndef __GNUC__
# define __attribute__(x) /*NOTHING*/
#endif
#if defined(astCLASS) /* Protected */
/* Values used to represent different System attribute values. */
#define AST__MJD 1
#define AST__JD 2
#define AST__JEPOCH 3
#define AST__BEPOCH 4
/* Values used to represent different TimeScale attribute values. */
#define AST__BADTS 0
#define AST__TAI 1
#define AST__UTC 2
#define AST__UT1 3
#define AST__GMST 4
#define AST__LAST 5
#define AST__LMST 6
#define AST__TT 7
#define AST__TDB 8
#define AST__TCB 9
#define AST__TCG 10
#define AST__LT 11
/* Define constants used to size global arrays in this module. */
#define AST__TIMEFRAME_FORMAT_BUFF_LEN 200
#define AST__TIMEFRAME_GETATTRIB_BUFF_LEN 50
#define AST__TIMEFRAME_GETLABEL_BUFF_LEN 200
#define AST__TIMEFRAME_GETSYMBOL_BUFF_LEN 20
#define AST__TIMEFRAME_GETTITLE_BUFF_LEN 200
#endif
/* Type Definitions. */
/* ================= */
/* Integer type used to store the TimeScale attribute. */
typedef int AstTimeScaleType;
/* TimeFrame structure. */
/* ------------------- */
/* This structure contains all information that is unique to each object in
the class (e.g. its instance variables). */
typedef struct AstTimeFrame {
/* Attributes inherited from the parent class. */
AstFrame frame; /* Parent class structure */
/* Attributes specific to objects in this class. */
double ltoffset; /* Offset from UTC to Local Time */
double timeorigin; /* Zero point for time axis */
AstTimeScaleType timescale; /* Time scale */
AstTimeScaleType aligntimescale; /* Alignment time scale */
} AstTimeFrame;
/* Virtual function table. */
/* ----------------------- */
/* This table contains all information that is the same for all objects in the
class (e.g. pointers to its virtual functions). */
#if defined(astCLASS) /* Protected */
typedef struct AstTimeFrameVtab {
/* Properties (e.g. methods) inherited from the parent class. */
AstFrameVtab frame_vtab; /* Parent class virtual function table */
/* A Unique identifier to determine class membership. */
AstClassIdentifier id;
/* Properties (e.g. methods) specific to this class. */
double (* CurrentTime)( AstTimeFrame *, int * );
double (* GetLTOffset)( AstTimeFrame *, int * );
int (* TestLTOffset)( AstTimeFrame *, int * );
void (* ClearLTOffset)( AstTimeFrame *, int * );
void (* SetLTOffset)( AstTimeFrame *, double, int * );
double (* GetTimeOrigin)( AstTimeFrame *, int * );
int (* TestTimeOrigin)( AstTimeFrame *, int * );
void (* ClearTimeOrigin)( AstTimeFrame *, int * );
void (* SetTimeOrigin)( AstTimeFrame *, double, int * );
AstTimeScaleType (* GetTimeScale)( AstTimeFrame *, int * );
int (* TestTimeScale)( AstTimeFrame *, int * );
void (* ClearTimeScale)( AstTimeFrame *, int * );
void (* SetTimeScale)( AstTimeFrame *, AstTimeScaleType, int * );
AstTimeScaleType (* GetAlignTimeScale)( AstTimeFrame *, int * );
int (* TestAlignTimeScale)( AstTimeFrame *, int * );
void (* ClearAlignTimeScale)( AstTimeFrame *, int * );
void (* SetAlignTimeScale)( AstTimeFrame *, AstTimeScaleType, int * );
} AstTimeFrameVtab;
#if defined(THREAD_SAFE)
/* Define a structure holding all data items that are global within this
class. */
typedef struct AstTimeFrameGlobals {
AstTimeFrameVtab Class_Vtab;
int Class_Init;
char Format_Buff[ AST__TIMEFRAME_FORMAT_BUFF_LEN + 1 ];
char GetAttrib_Buff[ AST__TIMEFRAME_GETATTRIB_BUFF_LEN + 1 ];
char GetLabel_Buff[ AST__TIMEFRAME_GETLABEL_BUFF_LEN + 1 ];
char GetSymbol_Buff[ AST__TIMEFRAME_GETSYMBOL_BUFF_LEN + 1 ];
char GetTitle_Buff[ AST__TIMEFRAME_GETTITLE_BUFF_LEN + 1 ];
} AstTimeFrameGlobals;
#endif
#endif
/* Function prototypes. */
/* ==================== */
/* Prototypes for standard class functions. */
/* ---------------------------------------- */
astPROTO_CHECK(TimeFrame) /* Check class membership */
astPROTO_ISA(TimeFrame) /* Test class membership */
/* Constructor. */
#if defined(astCLASS) /* Protected */
AstTimeFrame *astTimeFrame_( const char *, int *, ...);
#else
AstTimeFrame *astTimeFrameId_( const char *, ... )__attribute__((format(printf,1,2)));
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
AstTimeFrame *astInitTimeFrame_( void *, size_t, int, AstTimeFrameVtab *,
const char *, int * );
/* Vtab initialiser. */
void astInitTimeFrameVtab_( AstTimeFrameVtab *, const char *, int * );
/* Loader. */
AstTimeFrame *astLoadTimeFrame_( void *, size_t, AstTimeFrameVtab *,
const char *, AstChannel *channel, int * );
/* Thread-safe initialiser for all global data used by this module. */
#if defined(THREAD_SAFE)
void astInitTimeFrameGlobals_( AstTimeFrameGlobals * );
#endif
#endif
/* Prototypes for member functions. */
/* -------------------------------- */
double astCurrentTime_( AstTimeFrame *, int * );
#if defined(astCLASS) /* Protected */
double astGetLTOffset_( AstTimeFrame *, int * );
int astTestLTOffset_( AstTimeFrame *, int * );
void astClearLTOffset_( AstTimeFrame *, int * );
void astSetLTOffset_( AstTimeFrame *, double, int * );
double astGetTimeOrigin_( AstTimeFrame *, int * );
int astTestTimeOrigin_( AstTimeFrame *, int * );
void astClearTimeOrigin_( AstTimeFrame *, int * );
void astSetTimeOrigin_( AstTimeFrame *, double, int * );
AstTimeScaleType astGetTimeScale_( AstTimeFrame *, int * );
int astTestTimeScale_( AstTimeFrame *, int * );
void astClearTimeScale_( AstTimeFrame *, int * );
void astSetTimeScale_( AstTimeFrame *, AstTimeScaleType, int * );
AstTimeScaleType astGetAlignTimeScale_( AstTimeFrame *, int * );
int astTestAlignTimeScale_( AstTimeFrame *, int * );
void astClearAlignTimeScale_( AstTimeFrame *, int * );
void astSetAlignTimeScale_( AstTimeFrame *, AstTimeScaleType, int * );
#endif
/* Function interfaces. */
/* ==================== */
/* These macros are wrap-ups for the functions defined by this class
to make them easier to invoke (e.g. to avoid type mis-matches when
passing pointers to objects from derived classes). */
/* Interfaces to standard class functions. */
/* --------------------------------------- */
/* Some of these functions provide validation, so we cannot use them
to validate their own arguments. We must use a cast when passing
object pointers (so that they can accept objects from derived
classes). */
/* Check class membership. */
#define astCheckTimeFrame(this) astINVOKE_CHECK(TimeFrame,this,0)
#define astVerifyTimeFrame(this) astINVOKE_CHECK(TimeFrame,this,1)
/* Test class membership. */
#define astIsATimeFrame(this) astINVOKE_ISA(TimeFrame,this)
/* Constructor. */
#if defined(astCLASS) /* Protected */
#define astTimeFrame astINVOKE(F,astTimeFrame_)
#else
#define astTimeFrame astINVOKE(F,astTimeFrameId_)
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
#define astInitTimeFrame(mem,size,init,vtab,name) \
astINVOKE(O,astInitTimeFrame_(mem,size,init,vtab,name,STATUS_PTR))
/* Vtab Initialiser. */
#define astInitTimeFrameVtab(vtab,name) astINVOKE(V,astInitTimeFrameVtab_(vtab,name,STATUS_PTR))
/* Loader. */
#define astLoadTimeFrame(mem,size,vtab,name,channel) \
astINVOKE(O,astLoadTimeFrame_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
#endif
/* Interfaces to public member functions. */
/* -------------------------------------- */
/* None. */
/* Interfaces to protected member functions. */
/* ----------------------------------------- */
/* Here we make use of astCheckTimeFrame to validate TimeFrame pointers
before use. This provides a contextual error report if a pointer to
the wrong sort of object is supplied. */
#define astCurrentTime(this) astINVOKE(V,astCurrentTime_(astCheckTimeFrame(this),STATUS_PTR))
#if defined(astCLASS) /* Protected */
#define astGetTimeOrigin(this) astINVOKE(V,astGetTimeOrigin_(astCheckTimeFrame(this),STATUS_PTR))
#define astTestTimeOrigin(this) astINVOKE(V,astTestTimeOrigin_(astCheckTimeFrame(this),STATUS_PTR))
#define astClearTimeOrigin(this) astINVOKE(V,astClearTimeOrigin_(astCheckTimeFrame(this),STATUS_PTR))
#define astSetTimeOrigin(this,value) astINVOKE(V,astSetTimeOrigin_(astCheckTimeFrame(this),value,STATUS_PTR))
#define astGetLTOffset(this) astINVOKE(V,astGetLTOffset_(astCheckTimeFrame(this),STATUS_PTR))
#define astTestLTOffset(this) astINVOKE(V,astTestLTOffset_(astCheckTimeFrame(this),STATUS_PTR))
#define astClearLTOffset(this) astINVOKE(V,astClearLTOffset_(astCheckTimeFrame(this),STATUS_PTR))
#define astSetLTOffset(this,value) astINVOKE(V,astSetLTOffset_(astCheckTimeFrame(this),value,STATUS_PTR))
#define astGetTimeScale(this) astINVOKE(V,astGetTimeScale_(astCheckTimeFrame(this),STATUS_PTR))
#define astTestTimeScale(this) astINVOKE(V,astTestTimeScale_(astCheckTimeFrame(this),STATUS_PTR))
#define astClearTimeScale(this) astINVOKE(V,astClearTimeScale_(astCheckTimeFrame(this),STATUS_PTR))
#define astSetTimeScale(this,value) astINVOKE(V,astSetTimeScale_(astCheckTimeFrame(this),value,STATUS_PTR))
#define astGetAlignTimeScale(this) astINVOKE(V,astGetAlignTimeScale_(astCheckTimeFrame(this),STATUS_PTR))
#define astTestAlignTimeScale(this) astINVOKE(V,astTestAlignTimeScale_(astCheckTimeFrame(this),STATUS_PTR))
#define astClearAlignTimeScale(this) astINVOKE(V,astClearAlignTimeScale_(astCheckTimeFrame(this),STATUS_PTR))
#define astSetAlignTimeScale(this,value) astINVOKE(V,astSetAlignTimeScale_(astCheckTimeFrame(this),value,STATUS_PTR))
#endif
#endif
|
