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
|
#if !defined( FLUXFRAME_INCLUDED ) /* Include this file only once */
#define FLUXFRAME_INCLUDED
/*
*+
* Name:
* fluxframe.h
* Type:
* C include file.
* Purpose:
* Define the interface to the FluxFrame class.
* Invocation:
* #include "fluxframe.h"
* Description:
* This include file defines the interface to the FluxFrame 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:
* 1-DEC-2004 (DSB):
* Original version.
*-
*/
/* Include files. */
/* ============== */
/* Interface definitions. */
/* ---------------------- */
#include "object.h" /* Base Object class */
#include "frame.h" /* Parent Frame class */
#include "specframe.h" /* Spectral 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__FLUXDEN 1
#define AST__FLUXDENW 2
#define AST__SBRIGHT 3
#define AST__SBRIGHTW 4
/* Define constants used to size global arrays in this module. */
#define AST__FLUXFRAME_GETATTRIB_BUFF_LEN 50
#define AST__FLUXFRAME_GETLABEL_BUFF_LEN 200
#define AST__FLUXFRAME_GETSYMBOL_BUFF_LEN 20
#define AST__FLUXFRAME_GETTITLE_BUFF_LEN 200
#endif
/* Type Definitions. */
/* ================= */
/* FluxFrame structure. */
/* ------------------- */
/* This structure contains all information that is unique to each object in
the class (e.g. its instance variables). */
typedef struct AstFluxFrame {
/* Attributes inherited from the parent class. */
AstFrame frame; /* Parent class structure */
/* Attributes specific to objects in this class. */
double specval; /* Spectral position */
double defspecval; /* Default spectral position */
AstSpecFrame *specframe; /* SpecFrame describing specval & defspecval */
int nuunits; /* Size of usedunits array */
char **usedunits; /* Last used units for each system */
} AstFluxFrame;
/* 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 AstFluxFrameVtab {
/* 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;
AstSystemType (* GetDensitySystem)( AstFluxFrame *, int * );
const char *(* GetDensityUnit)( AstFluxFrame *, int * );
double (* GetSpecVal)( AstFluxFrame *, int * );
int (* TestSpecVal)( AstFluxFrame *, int * );
void (* ClearSpecVal)( AstFluxFrame *, int * );
void (* SetSpecVal)( AstFluxFrame *, double, int * );
} AstFluxFrameVtab;
#if defined(THREAD_SAFE)
/* Define a structure holding all data items that are global within this
class. */
typedef struct AstFluxFrameGlobals {
AstFluxFrameVtab Class_Vtab;
int Class_Init;
char GetAttrib_Buff[ AST__FLUXFRAME_GETATTRIB_BUFF_LEN + 1 ];
char GetLabel_Buff[ AST__FLUXFRAME_GETLABEL_BUFF_LEN + 1 ];
char GetSymbol_Buff[ AST__FLUXFRAME_GETSYMBOL_BUFF_LEN + 1 ];
char GetTitle_Buff[ AST__FLUXFRAME_GETTITLE_BUFF_LEN + 1 ];
} AstFluxFrameGlobals;
#endif
#endif
/* Function prototypes. */
/* ==================== */
/* Prototypes for standard class functions. */
/* ---------------------------------------- */
astPROTO_CHECK(FluxFrame) /* Check class membership */
astPROTO_ISA(FluxFrame) /* Test class membership */
/* Constructor. */
#if defined(astCLASS) /* Protected */
AstFluxFrame *astFluxFrame_( double, void *, const char *, int *, ...);
#else
AstFluxFrame *astFluxFrameId_( double, void *, const char *, ... )__attribute__((format(printf,3,4)));
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
AstFluxFrame *astInitFluxFrame_( void *, size_t, int,
AstFluxFrameVtab *,
const char *, double, AstSpecFrame *, int * );
/* Vtab initialiser. */
void astInitFluxFrameVtab_( AstFluxFrameVtab *, const char *, int * );
/* Loader. */
AstFluxFrame *astLoadFluxFrame_( void *, size_t,
AstFluxFrameVtab *,
const char *, AstChannel *channel, int * );
/* Thread-safe initialiser for all global data used by this module. */
#if defined(THREAD_SAFE)
void astInitFluxFrameGlobals_( AstFluxFrameGlobals * );
#endif
#endif
/* Prototypes for member functions. */
/* -------------------------------- */
#if defined(astCLASS) /* Protected */
AstSystemType astGetDensitySystem_( AstFluxFrame *, int * );
const char *astGetDensityUnit_( AstFluxFrame *, int * );
double astGetSpecVal_( AstFluxFrame *, int * );
int astTestSpecVal_( AstFluxFrame *, int * );
void astClearSpecVal_( AstFluxFrame *, int * );
void astSetSpecVal_( AstFluxFrame *, double, 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 astCheckFluxFrame(this) astINVOKE_CHECK(FluxFrame,this,0)
#define astVerifyFluxFrame(this) astINVOKE_CHECK(FluxFrame,this,1)
/* Test class membership. */
#define astIsAFluxFrame(this) astINVOKE_ISA(FluxFrame,this)
/* Constructor. */
#if defined(astCLASS) /* Protected */
#define astFluxFrame astINVOKE(F,astFluxFrame_)
#else
#define astFluxFrame astINVOKE(F,astFluxFrameId_)
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
#define astInitFluxFrame(mem,size,init,vtab,name,specval,specfrm) \
astINVOKE(O,astInitFluxFrame_(mem,size,init,vtab,name,specval,astCheckSpecFrame(specfrm),STATUS_PTR))
/* Vtab Initialiser. */
#define astInitFluxFrameVtab(vtab,name) astINVOKE(V,astInitFluxFrameVtab_(vtab,name,STATUS_PTR))
/* Loader. */
#define astLoadFluxFrame(mem,size,vtab,name,channel) \
astINVOKE(O,astLoadFluxFrame_(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 astCheckFluxFrame to validate FluxFrame pointers
before use. This provides a contextual error report if a pointer to
the wrong sort of object is supplied. */
#if defined(astCLASS) /* Protected */
#define astGetDensitySystem(this) astINVOKE(V,astGetDensitySystem_(astCheckFluxFrame(this),STATUS_PTR))
#define astGetDensityUnit(this) astINVOKE(V,astGetDensityUnit_(astCheckFluxFrame(this),STATUS_PTR))
#define astGetSpecVal(this) astINVOKE(V,astGetSpecVal_(astCheckFluxFrame(this),STATUS_PTR))
#define astTestSpecVal(this) astINVOKE(V,astTestSpecVal_(astCheckFluxFrame(this),STATUS_PTR))
#define astClearSpecVal(this) astINVOKE(V,astClearSpecVal_(astCheckFluxFrame(this),STATUS_PTR))
#define astSetSpecVal(this,value) astINVOKE(V,astSetSpecVal_(astCheckFluxFrame(this),value,STATUS_PTR))
#endif
#endif
|
