File: cmpframe.h

package info (click to toggle)
starlink-ast 7.0.4%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 27,216 kB
  • sloc: ansic: 165,183; sh: 8,558; makefile: 635; perl: 158
file content (428 lines) | stat: -rw-r--r-- 14,962 bytes parent folder | download
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
#if !defined( CMPFRAME_INCLUDED ) /* Include this file only once */
#define CMPFRAME_INCLUDED
/*
*+
*  Name:
*     cmpframe.h

*  Type:
*     C include file.

*  Purpose:
*     Define the interface to the CmpFrame class.

*  Invocation:
*     #include "cmpframe.h"

*  Description:
*     This include file defines the interface to the CmpFrame class
*     and provides the type definitions, function prototypes and
*     macros, etc. needed to use this class.
*
*     A CmpFrame is a compound Frame which allows two component Frames
*     (of any class) to be merged together to form a more complex
*     Frame. The axes of the two component Frames then appear together
*     in the resulting CmpFrame (those of the first Frame, followed by
*     those of the second Frame).
*
*     Since a CmpFrame is itself a Frame, it can be used as a
*     component in forming further CmpFrames. Frames of arbitrary
*     complexity may be built from simple individual Frames in this
*     way.

*  Inheritance:
*     The CmpFrame class inherits from the Frame class.

*  Attributes Over-Ridden:
*     Domain (string)
*        A string which may be used to identify a CmpFrame and used as
*        an additional key when matching a target CmpFrame with a
*        template.  The CmpFrame class re-defines the default value to
*        "CMP".
*     MaxAxes (integer)
*        Specifies the maximum number of axes in a target Frame that
*        can be matched when using the CmpFrame as a template. The
*        CmpFrame class sets this to be the sum of the MaxAxes
*        attribute values for the two component Frames contained by
*        the CmpFrame. Any attempt to alter this value (other than
*        through the component Frames) is simply ignored.
*     MinAxes (integer)
*        Specifies the minimum number of axes in a target Frame that
*        can be matched when using the CmpFrame as a template. The
*        CmpFrame class sets this to be the sum of the MinAxes
*        attribute values for the two component Frames contained by
*        the CmpFrame. Any attempt to alter this value (other than
*        through the component Frames) is simply ignored.
*     Naxes (integer)
*        A read-only attribute that gives the number of axes in a
*        CmpFrame (i.e. the number of dimensions of the space which
*        the CmpFrame describes). This value is determined when the
*        CmpFrame is created and is equal to the sum of the Naxes
*        attributes of the two component Frames.
*     Title (string)
*        Specifies a string to be used as a title on (e.g.) graphs to
*        describe the coordinate system which the CmpFrame
*        represents. The CmpFrame class re-defines the default value
*        to "<n>-D Compound Coordinate System", where <n> is the
*        number of CmpFrame axes.

*  New Attributes Defined:
*     None.

*  Methods Over-Ridden:
*     Public:
*        astDistance
*           Calculate the distance between two points.
*        astFormat
*           Format a coordinate value for a CmpFrame axis.
*        astNorm
*           Normalise a set of CmpFrame coordinates.
*        astOffset
*           Calculate an offset along a geodesic curve.
*        astPermAxes
*           Permute the order of a CmpFrame's axes.
*        astUnformat
*           Read a formatted coordinate value for a CmpFrame axis.
*
*     Protected:
*        astAbbrev
*           Abbreviate a formatted CmpFrame axis value by skipping leading
*           fields.
*        astClearDirection
*           Clear the value of the Direction attribute for a CmpFrame axis.
*        astClearFormat
*           Clear the value of the Format attribute for a CmpFrame axis.
*        astClearLabel
*           Clear the value of the Label attribute for a CmpFrame axis.
*        astClearMaxAxes
*           Clear the value of the MaxAxes attribute for a CmpFrame.
*        astClearMinAxes
*           Clear the value of the MinAxes attribute for a CmpFrame.
*        astClearSymbol
*           Clear the value of the Symbol attribute for a CmpFrame axis.
*        astClearUnit
*           Clear the value of the Unit attribute for a CmpFrame axis.
*        astGap
*           Find a "nice" gap for tabulating CmpFrame axis values.
*        astGetAxis
*           Obtain a pointer to a specified Axis from a CmpFrame.
*        astGetDirection
*           Obtain the value of the Direction attribute for a CmpFrame axis.
*        astGetDomain
*           Obtain a pointer to the Domain attribute string for a CmpFrame.
*        astGetFormat
*           Obtain the value of the Format attribute for a CmpFrame axis.
*        astGetLabel
*           Obtain the value of the Label attribute for a CmpFrame axis.
*        astGetMaxAxes
*           Obtain the value of the MaxAxes attribute for a CmpFrame.
*        astGetMinAxes
*           Obtain the value of the MinAxes attribute for a CmpFrame.
*        astGetNaxes
*           Obtain the value of the Naxes attribute for a CmpFrame.
*        astGetPerm
*           Access the axis permutation array for a CmpFrame.
*        astGetSymbol
*           Obtain the value of the Symbol attribute for a CmpFrame axis.
*        astGetTitle
*           Obtain a pointer to the Title attribute string for a CmpFrame.
*        astGetUnit
*           Obtain the value of the Unit attribute for a CmpFrame axis.
*        astMatch
*           Determine if conversion is possible between two coordinate
*           systems.
*        astPrimaryFrame
*           Uniquely identify a primary Frame and one of its axes.
*        astSetAxis
*           Set a new Axis for a CmpFrame.
*        astSetDirection
*           Set the value of the Direction attribute for a CmpFrame axis.
*        astSetFormat
*           Set the value of the Format attribute for a CmpFrame axis.
*        astSetLabel
*           Set the value of the Label attribute for a CmpFrame axis.
*        astSetMaxAxes
*           Set a value for the MaxAxes attribute of a CmpFrame.
*        astSetMinAxes
*           Set a value for the MinAxes attribute of a CmpFrame.
*        astSetSymbol
*           Set the value of the Symbol attribute for a CmpFrame axis.
*        astSetUnit
*           Set the value of the Unit attribute for a CmpFrame axis.
*        astSubFrame
*           Select axes from a CmpFrame and convert to the new coordinate
*           system.
*        astTestDirection
*           Test if a Direction attribute value has been set for a CmpFrame
*           axis.
*        astTestFormat
*           Test if a Format attribute value has been set for a CmpFrame axis.
*        astTestLabel
*           Test if a Label attribute value has been set for a CmpFrame axis.
*        astTestMaxAxes
*           Test if a value has been set for the MaxAxes attribute of a
*           CmpFrame.
*        astTestMinAxes
*           Test if a value has been set for the MinAxes attribute of a
*           CmpFrame.
*        astTestSymbol
*           Test if a Symbol attribute value has been set for a CmpFrame axis.
*        astTestUnit
*           Test if a Unit attribute value has been set for a CmpFrame axis.

*  New Methods Defined:
*     Public:
*        None.
*
*     Protected:
*        None.

*  Other Class Functions:
*     Public:
*        astIsACmpFrame
*           Test class membership.
*        astCmpFrame
*           Create a CmpFrame.
*
*     Protected:
*        astCheckCmpFrame
*           Validate class membership.
*        astInitCmpFrame
*           Initialise a CmpFrame.
*        astInitCmpFrameVtab
*           Initialise the virtual function table for the CmpFrame class.
*        astLoadCmpFrame
*           Load a CmpFrame.

*  Macros:
*     None.

*  Type Definitions:
*     Public:
*        AstCmpFrame
*           CmpFrame object type.
*
*     Protected:
*        AstCmpFrameVtab
*           CmpFrame virtual function table type.

*  Feature Test Macros:
*     astCLASS
*        If the astCLASS macro is undefined, only public symbols are
*        made available, otherwise protected symbols (for use in other
*        class implementations) are defined. This macro also affects
*        the reporting of error context information, which is only
*        provided for external calls to the AST library.

*  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 General Public Licence as
*     published by the Free Software Foundation; either version 2 of
*     the Licence, 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 General Public Licence for more details.
*
*     You should have received a copy of the GNU General Public Licence
*     along with this program; if not, write to the Free Software
*     Foundation, Inc., 51 Franklin Street,Fifth Floor, Boston, MA
*     02110-1301, USA

*  Authors:
*     RFWS: R.F. Warren-Smith (Starlink)

*  History:
*     6-MAR-1996 (RFWS):
*        Original version.
*     27-FEB-1997 (RFWS):
*        Improved the prologue.
*     25-FEB-1998 (RFWS):
*        Over-ride the astUnformat method.
*     8-JAN-2003 (DSB):
*        Added protected astInitCmpFrameVtab method.
*-
*/

/* Include files. */
/* ============== */
/* Interface definitions. */
/* ---------------------- */
#include "object.h"              /* Base Object class */
#include "frame.h"               /* Parent Frame class */

#if defined(astCLASS)            /* Protected */
#include "channel.h"             /* I/O channels */
#endif

/* C header files. */
/* --------------- */
#if defined(astCLASS)            /* Protected */
#include <stddef.h>
#endif

/* 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 */

/* The legal System values recognized by this class of Frame. */
#define AST__COMP 0

#endif

/* Type Definitions. */
/* ================= */
/* CmpFrame structure. */
/* ------------------ */
/* This structure contains all information that is unique to each
   object in the class (e.g. its instance variables). */
typedef struct AstCmpFrame {

/* Attributes inherited from the parent class. */
   AstFrame frame;               /* Parent class structure */

/* Attributes specific to objects in this class. */
   AstFrame *frame1;             /* First component frame */
   AstFrame *frame2;             /* Second component Frame */
   int *perm;                    /* Pointer to axis permutation array */
} AstCmpFrame;

/* 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 AstCmpFrameVtab {

/* 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. */

} AstCmpFrameVtab;

#if defined(THREAD_SAFE)

/* Define a structure holding all data items that are global within this
   class. */
typedef struct AstCmpFrameGlobals {
   AstCmpFrameVtab Class_Vtab;
   int Class_Init;
   int *qsort_axes;
   char Label_Buff[ 101 ];
   char Symbol_Buff[ 51 ];
   char GetDomain_Buff[ 101 ];
   char GetTitle_Buff[ 101 ];
} AstCmpFrameGlobals;

#endif

#endif

/* Function prototypes. */
/* ==================== */
/* Prototypes for standard class functions. */
/* ---------------------------------------- */
astPROTO_CHECK(CmpFrame)         /* Check class membership */
astPROTO_ISA(CmpFrame)           /* Test class membership */

/* Constructor. */
#if defined(astCLASS)            /* Protected. */
AstCmpFrame *astCmpFrame_( void *, void *, const char *, int *, ...);
#else
AstCmpFrame *astCmpFrameId_( void *, void *, const char *, ... )__attribute__((format(printf,3,4)));
#endif

#if defined(astCLASS)            /* Protected */

/* Initialiser. */
AstCmpFrame *astInitCmpFrame_( void *, size_t, int, AstCmpFrameVtab *,
                               const char *, AstFrame *, AstFrame *, int * );

/* Vtab initialiser. */
void astInitCmpFrameVtab_( AstCmpFrameVtab *, const char *, int * );

/* Loader. */
AstCmpFrame *astLoadCmpFrame_( void *, size_t, AstCmpFrameVtab *,
                               const char *, AstChannel *, int * );
/* Thread-safe initialiser for all global data used by this module. */
#if defined(THREAD_SAFE)
void astInitCmpFrameGlobals_( AstCmpFrameGlobals * );
#endif

#endif

/* Prototypes for member functions. */
/* -------------------------------- */

/* 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 astCheckCmpFrame(this) astINVOKE_CHECK(CmpFrame,this,0)
#define astVerifyCmpFrame(this) astINVOKE_CHECK(CmpFrame,this,1)

/* Test class membership. */
#define astIsACmpFrame(this) astINVOKE_ISA(CmpFrame,this)

/* Constructor. */
#if defined(astCLASS)            /* Protected. */
#define astCmpFrame astINVOKE(F,astCmpFrame_)
#else
#define astCmpFrame astINVOKE(F,astCmpFrameId_)
#endif

#if defined(astCLASS)            /* Protected */

/* Initialiser. */
#define astInitCmpFrame(mem,size,init,vtab,name,frame1,frame2) \
astINVOKE(O,astInitCmpFrame_(mem,size,init,vtab,name,astCheckFrame(frame1),astCheckFrame(frame2),STATUS_PTR))

/* Vtab Initialiser. */
#define astInitCmpFrameVtab(vtab,name) astINVOKE(V,astInitCmpFrameVtab_(vtab,name,STATUS_PTR))
/* Loader. */
#define astLoadCmpFrame(mem,size,vtab,name,channel) \
astINVOKE(O,astLoadCmpFrame_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
#endif

/* Interfaces to public member functions. */
/* -------------------------------------- */
/* Here we make use of astCheckCmpFrame to validate CmpFrame pointers
   before use.  This provides a contextual error report if a pointer
   to the wrong sort of Object is supplied. */

#endif