summaryrefslogtreecommitdiffstats
path: root/ast/stcsearchlocation.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/stcsearchlocation.h
parent75fab9d80911f74aaab738fa9ab8a4f9b0f57a6b (diff)
downloadblt-0b1addf5643c828955a6add53f2a4f7a7a813e41.zip
blt-0b1addf5643c828955a6add53f2a4f7a7a813e41.tar.gz
blt-0b1addf5643c828955a6add53f2a4f7a7a813e41.tar.bz2
upgrade ast 8.7.1
Diffstat (limited to 'ast/stcsearchlocation.h')
-rw-r--r--ast/stcsearchlocation.h222
1 files changed, 222 insertions, 0 deletions
diff --git a/ast/stcsearchlocation.h b/ast/stcsearchlocation.h
new file mode 100644
index 0000000..c359711
--- /dev/null
+++ b/ast/stcsearchlocation.h
@@ -0,0 +1,222 @@
+#if !defined( STCSEARCHLOCATION_INCLUDED ) /* Include this file only once */
+#define STCSEARCHLOCATION_INCLUDED
+/*
+*+
+* Name:
+* stcsearchlocation.h
+
+* Type:
+* C include file.
+
+* Purpose:
+* Define the interface to the StcSearchLocation class.
+
+* Invocation:
+* #include "stcsearchlocation.h"
+
+* Description:
+* This include file defines the interface to the StcSearchLocation class
+* and provides the type definitions, function prototypes and macros,
+* etc. needed to use this class.
+*
+* The StcSearchLocation class is a sub-class of Stc used to describe
+* the coverage of a VO query.
+*
+* See http://hea-www.harvard.edu/~arots/nvometa/STC.html
+
+* Inheritance:
+* The StcSearchLocation class inherits from the Stc 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:
+* 26-NOV-2004 (DSB):
+* Original version.
+*-
+*/
+
+/* Include files. */
+/* ============== */
+/* Interface definitions. */
+/* ---------------------- */
+#include "stc.h" /* Coordinate stcs (parent class) */
+
+#if defined(astCLASS) /* Protected */
+#include "channel.h" /* I/O channels */
+#endif
+
+/* C header files. */
+/* --------------- */
+#if defined(astCLASS) /* Protected */
+#include <stddef.h>
+#endif
+
+/* Macros */
+/* ====== */
+
+/* Define a dummy __attribute__ macro for use on non-GNU compilers. */
+#ifndef __GNUC__
+# define __attribute__(x) /*NOTHING*/
+#endif
+
+/* Type Definitions. */
+/* ================= */
+/* StcSearchLocation structure. */
+/* ----------------------------- */
+/* This structure contains all information that is unique to each object in
+ the class (e.g. its instance variables). */
+typedef struct AstStcSearchLocation {
+
+/* Attributes inherited from the parent class. */
+ AstStc stc; /* Parent class structure */
+
+} AstStcSearchLocation;
+
+/* 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 AstStcSearchLocationVtab {
+
+/* Properties (e.g. methods) inherited from the parent class. */
+ AstStcVtab stc_vtab; /* Parent class virtual function table */
+
+/* A Unique identifier to determine class membership. */
+ AstClassIdentifier id;
+
+/* Properties (e.g. methods) specific to this class. */
+} AstStcSearchLocationVtab;
+
+#if defined(THREAD_SAFE)
+
+/* Define a structure holding all data items that are global within the
+ object.c file. */
+
+typedef struct AstStcSearchLocationGlobals {
+ AstStcSearchLocationVtab Class_Vtab;
+ int Class_Init;
+} AstStcSearchLocationGlobals;
+
+
+/* Thread-safe initialiser for all global data used by this module. */
+void astInitStcSearchLocationGlobals_( AstStcSearchLocationGlobals * );
+
+#endif
+
+
+#endif
+
+/* Function prototypes. */
+/* ==================== */
+/* Prototypes for standard class functions. */
+/* ---------------------------------------- */
+astPROTO_CHECK(StcSearchLocation) /* Check class membership */
+astPROTO_ISA(StcSearchLocation) /* Test class membership */
+
+/* Constructor. */
+#if defined(astCLASS) /* Protected. */
+AstStcSearchLocation *astStcSearchLocation_( void *, int, AstKeyMap **, const char *, int *, ...);
+#else
+AstStcSearchLocation *astStcSearchLocationId_( void *, int, AstKeyMap **, const char *, ... )__attribute__((format(printf,4,5)));
+#endif
+
+#if defined(astCLASS) /* Protected */
+
+/* Initialiser. */
+AstStcSearchLocation *astInitStcSearchLocation_( void *, size_t, int, AstStcSearchLocationVtab *, const char *, AstRegion *, int, AstKeyMap **, int * );
+
+/* Vtab initialiser. */
+void astInitStcSearchLocationVtab_( AstStcSearchLocationVtab *, const char *, int * );
+
+/* Loader. */
+AstStcSearchLocation *astLoadStcSearchLocation_( void *, size_t, AstStcSearchLocationVtab *, const char *, AstChannel *, int * );
+
+#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 astCheckStcSearchLocation(this) astINVOKE_CHECK(StcSearchLocation,this,0)
+#define astVerifyStcSearchLocation(this) astINVOKE_CHECK(StcSearchLocation,this,1)
+
+/* Test class membership. */
+#define astIsAStcSearchLocation(this) astINVOKE_ISA(StcSearchLocation,this)
+
+/* Constructor. */
+#if defined(astCLASS) /* Protected. */
+#define astStcSearchLocation astINVOKE(F,astStcSearchLocation_)
+#else
+#define astStcSearchLocation astINVOKE(F,astStcSearchLocationId_)
+#endif
+
+#if defined(astCLASS) /* Protected */
+
+/* Initialiser. */
+#define astInitStcSearchLocation(mem,size,init,vtab,name,region,ncoords,coords) \
+astINVOKE(O,astInitStcSearchLocation_(mem,size,init,vtab,name,region,ncoords,coords,STATUS_PTR))
+
+/* Vtab Initialiser. */
+#define astInitStcSearchLocationVtab(vtab,name) astINVOKE(V,astInitStcSearchLocationVtab_(vtab,name,STATUS_PTR))
+/* Loader. */
+#define astLoadStcSearchLocation(mem,size,vtab,name,channel) \
+astINVOKE(O,astLoadStcSearchLocation_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
+#endif
+
+/* Interfaces to public member functions. */
+/* -------------------------------------- */
+/* Here we make use of astCheckStcSearchLocation to validate StcSearchLocation pointers
+ before use. This provides a contextual error report if a pointer
+ to the wrong sort of Object is supplied. */
+
+#if defined(astCLASS) /* Protected */
+#endif
+#endif
+
+
+
+
+