summaryrefslogtreecommitdiffstats
path: root/ast/stc.h
diff options
context:
space:
mode:
authorWilliam Joye <wjoye@cfa.harvard.edu>2019-05-10 18:45:23 (GMT)
committerWilliam Joye <wjoye@cfa.harvard.edu>2019-05-10 18:45:23 (GMT)
commit0b1addf5643c828955a6add53f2a4f7a7a813e41 (patch)
tree94fe32a76399be787746c3c403cca2076a253e29 /ast/stc.h
parent75fab9d80911f74aaab738fa9ab8a4f9b0f57a6b (diff)
downloadblt-0b1addf5643c828955a6add53f2a4f7a7a813e41.zip
blt-0b1addf5643c828955a6add53f2a4f7a7a813e41.tar.gz
blt-0b1addf5643c828955a6add53f2a4f7a7a813e41.tar.bz2
upgrade ast 8.7.1
Diffstat (limited to 'ast/stc.h')
-rw-r--r--ast/stc.h240
1 files changed, 240 insertions, 0 deletions
diff --git a/ast/stc.h b/ast/stc.h
new file mode 100644
index 0000000..1fe0b1b
--- /dev/null
+++ b/ast/stc.h
@@ -0,0 +1,240 @@
+#if !defined( STC_INCLUDED ) /* Include this file only once */
+#define STC_INCLUDED
+/*
+*+
+* Name:
+* stc.h
+
+* Type:
+* C include file.
+
+* Purpose:
+* Define the interface to the Stc class.
+
+* Invocation:
+* #include "stc.h"
+
+* Description:
+* This include file defines the interface to the Stc class and
+* provides the type definitions, function prototypes and macros,
+* etc. needed to use this class.
+*
+* The Stc class is an implementation of the IVOA STC class which forms
+* part of the IVOA Space-Time Coordinate Metadata system. See:
+*
+* http://hea-www.harvard.edu/~arots/nvometa/STC.html
+
+* Inheritance:
+* The Stc class inherits from the Region class.
+
+* 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 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:
+* 23-NOV-2004 (DSB):
+* Original version.
+*-
+*/
+
+/* Include files. */
+/* ============== */
+/* Interface definitions. */
+/* ---------------------- */
+#include "region.h" /* Coordinate regions (parent class) */
+#include "keymap.h" /* Lists of value/key pairs */
+
+#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 AST__STCNAME "Name"
+#define AST__STCVALUE "Value"
+#define AST__STCERROR "Error"
+#define AST__STCRES "Resolution"
+#define AST__STCSIZE "Size"
+#define AST__STCPIXSZ "PixSize"
+
+/* Type Definitions. */
+/* ================= */
+/* Stc structure. */
+/* ------------------ */
+
+/* This structure contains all information that is unique to each object in
+ the class (e.g. its instance variables). */
+typedef struct AstStc {
+
+/* Attributes inherited from the parent class. */
+ AstRegion parent_region; /* Parent class structure */
+
+/* Attributes specific to objects in this class. */
+ AstRegion *region; /* Encapsulated Region */
+ AstKeyMap **coord; /* STC AstroCoords info */
+ int ncoord; /* Number of AstroCoords in "coords" */
+} AstStc;
+
+/* 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 AstStcVtab {
+
+/* Properties (e.g. methods) inherited from the parent class. */
+ AstRegionVtab region_vtab; /* Parent class virtual function table */
+
+/* A Unique identifier to determine class membership. */
+ AstClassIdentifier id;
+
+/* Properties (e.g. methods) specific to this class. */
+ const char *(* GetRegionClass)( AstStc *, int * );
+ AstRegion *(* GetStcRegion)( AstStc *, int * );
+ AstKeyMap *(* GetStcCoord)( AstStc *, int, int * );
+ int (* GetStcNCoord)( AstStc *, int * );
+
+} AstStcVtab;
+
+#if defined(THREAD_SAFE)
+
+/* Define a structure holding all data items that are global within the
+ object.c file. */
+
+typedef struct AstStcGlobals {
+ AstStcVtab Class_Vtab;
+ int Class_Init;
+} AstStcGlobals;
+
+
+/* Thread-safe initialiser for all global data used by this module. */
+void astInitStcGlobals_( AstStcGlobals * );
+
+#endif
+
+
+#endif
+
+/* Function prototypes. */
+/* ==================== */
+/* Prototypes for standard class functions. */
+/* ---------------------------------------- */
+astPROTO_CHECK(Stc) /* Check class membership */
+astPROTO_ISA(Stc) /* Test class membership */
+
+#if defined(astCLASS) /* Protected */
+
+/* Initialiser. */
+AstStc *astInitStc_( void *, size_t, int, AstStcVtab *, const char *,
+ AstRegion *, int, AstKeyMap **, int * );
+
+/* Vtab initialiser. */
+void astInitStcVtab_( AstStcVtab *, const char *, int * );
+
+/* Loader. */
+AstStc *astLoadStc_( void *, size_t, AstStcVtab *,
+ const char *, AstChannel *, int * );
+
+#endif
+
+/* Prototypes for member functions. */
+/* -------------------------------- */
+AstRegion *astGetStcRegion_( AstStc *, int * );
+AstKeyMap *astGetStcCoord_( AstStc *, int, int * );
+int astGetStcNCoord_( AstStc *, int * );
+
+# if defined(astCLASS) /* Protected */
+const char *astGetRegionClass_( AstStc *, 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 astCheckStc(this) astINVOKE_CHECK(Stc,this,0)
+#define astVerifyStc(this) astINVOKE_CHECK(Stc,this,1)
+
+/* Test class membership. */
+#define astIsAStc(this) astINVOKE_ISA(Stc,this)
+
+#if defined(astCLASS) /* Protected */
+
+/* Initialiser. */
+#define astInitStc(mem,size,init,vtab,name,reg,ncoords,coords) \
+astINVOKE(O,astInitStc_(mem,size,init,vtab,name,reg,ncoords,coords,STATUS_PTR))
+
+/* Vtab Initialiser. */
+#define astInitStcVtab(vtab,name) astINVOKE(V,astInitStcVtab_(vtab,name,STATUS_PTR))
+/* Loader. */
+#define astLoadStc(mem,size,vtab,name,channel) \
+astINVOKE(O,astLoadStc_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
+#endif
+
+/* Interfaces to public member functions. */
+/* -------------------------------------- */
+/* Here we make use of astCheckStc to validate Stc pointers
+ before use. This provides a contextual error report if a pointer
+ to the wrong sort of Object is supplied. */
+
+#define astGetStcRegion(this) astINVOKE(O,astGetStcRegion_(astCheckStc(this),STATUS_PTR))
+#define astGetStcCoord(this,icoord) astINVOKE(O,astGetStcCoord_(astCheckStc(this),icoord,STATUS_PTR))
+#define astGetStcNCoord(this) astINVOKE(V,astGetStcNCoord_(astCheckStc(this),STATUS_PTR))
+#if defined(astCLASS) /* Protected */
+#define astGetRegionClass(this) astINVOKE(V,astGetRegionClass_(astCheckStc(this),STATUS_PTR))
+#endif
+#endif
+
+
+
+
+