summaryrefslogtreecommitdiffstats
path: root/ast/stcobsdatalocation.h
diff options
context:
space:
mode:
authorWilliam Joye <wjoye@cfa.harvard.edu>2016-11-02 19:16:17 (GMT)
committerWilliam Joye <wjoye@cfa.harvard.edu>2016-11-02 19:16:17 (GMT)
commit293057bdd882685f8ddad66bf77196a5853b08da (patch)
tree22c02c3808f490432f5f785c8bb665438169662b /ast/stcobsdatalocation.h
parent87f20cbc44f8f6b53c00c37f89bc134a1f4cf29e (diff)
parentd26ed8388f100a12996c0b92a98040ef2ba7fa8e (diff)
downloadblt-293057bdd882685f8ddad66bf77196a5853b08da.zip
blt-293057bdd882685f8ddad66bf77196a5853b08da.tar.gz
blt-293057bdd882685f8ddad66bf77196a5853b08da.tar.bz2
Merge commit 'd26ed8388f100a12996c0b92a98040ef2ba7fa8e' as 'ast'
Diffstat (limited to 'ast/stcobsdatalocation.h')
-rw-r--r--ast/stcobsdatalocation.h236
1 files changed, 236 insertions, 0 deletions
diff --git a/ast/stcobsdatalocation.h b/ast/stcobsdatalocation.h
new file mode 100644
index 0000000..ad3b793
--- /dev/null
+++ b/ast/stcobsdatalocation.h
@@ -0,0 +1,236 @@
+#if !defined( STCOBSDATALOCATION_INCLUDED ) /* Include this file only once */
+#define STCOBSDATALOCATION_INCLUDED
+/*
+*+
+* Name:
+* stcobsdatalocation.h
+
+* Type:
+* C include file.
+
+* Purpose:
+* Define the interface to the StcObsDataLocation class.
+
+* Invocation:
+* #include "stcobsdatalocation.h"
+
+* Description:
+* This include file defines the interface to the StcObsDataLocation class
+* and provides the type definitions, function prototypes and macros,
+* etc. needed to use this class.
+*
+* The StcObsDataLocation class is a sub-class of Stc used to describe
+* the an observation contained in some VO resource.
+*
+* See http://hea-www.harvard.edu/~arots/nvometa/STC.html
+
+* Inheritance:
+* The StcObsDataLocation 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:
+* 25-APR-2005 (DSB):
+* Original version.
+*-
+*/
+
+/* Include files. */
+/* ============== */
+/* Interface definitions. */
+/* ---------------------- */
+#include "stc.h" /* Coordinate stcs (parent class) */
+#include "pointlist.h" /* Points within coordinate systems */
+
+#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. */
+/* ================= */
+/* StcObsDataLocation structure. */
+/* ----------------------------- */
+/* This structure contains all information that is unique to each object in
+ the class (e.g. its instance variables). */
+typedef struct AstStcObsDataLocation {
+
+/* Attributes inherited from the parent class. */
+ AstStc stc; /* Parent class structure */
+
+/* Attributes specific to the StcObsDataLOcation class. */
+ AstPointList *obs; /* Observatory position */
+
+} AstStcObsDataLocation;
+
+/* 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 AstStcObsDataLocationVtab {
+
+/* 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. */
+ void (* StcSetObs)( AstStcObsDataLocation *, AstPointList *, int * );
+
+} AstStcObsDataLocationVtab;
+
+#if defined(THREAD_SAFE)
+
+/* Define a structure holding all data items that are global within the
+ object.c file. */
+
+typedef struct AstStcObsDataLocationGlobals {
+ AstStcObsDataLocationVtab Class_Vtab;
+ int Class_Init;
+} AstStcObsDataLocationGlobals;
+
+
+/* Thread-safe initialiser for all global data used by this module. */
+void astInitStcObsDataLocationGlobals_( AstStcObsDataLocationGlobals * );
+
+#endif
+
+
+#endif
+
+/* Function prototypes. */
+/* ==================== */
+/* Prototypes for standard class functions. */
+/* ---------------------------------------- */
+astPROTO_CHECK(StcObsDataLocation) /* Check class membership */
+astPROTO_ISA(StcObsDataLocation) /* Test class membership */
+
+/* Constructor. */
+#if defined(astCLASS) /* Protected. */
+AstStcObsDataLocation *astStcObsDataLocation_( void *, int, AstKeyMap **, const char *, int *, ...);
+#else
+AstStcObsDataLocation *astStcObsDataLocationId_( void *, int, AstKeyMap **, const char *, ... )__attribute__((format(printf,4,5)));
+#endif
+
+#if defined(astCLASS) /* Protected */
+
+/* Initialiser. */
+AstStcObsDataLocation *astInitStcObsDataLocation_( void *, size_t, int, AstStcObsDataLocationVtab *, const char *, AstRegion *, int, AstKeyMap **, int * );
+
+/* Vtab initialiser. */
+void astInitStcObsDataLocationVtab_( AstStcObsDataLocationVtab *, const char *, int * );
+
+/* Loader. */
+AstStcObsDataLocation *astLoadStcObsDataLocation_( void *, size_t, AstStcObsDataLocationVtab *,
+ const char *, AstChannel *, int * );
+
+#endif
+
+/* Prototypes for member functions. */
+/* -------------------------------- */
+
+
+#if defined(astCLASS) /* Protected */
+void astStcSetObs_( AstStcObsDataLocation *, AstPointList *, 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 astCheckStcObsDataLocation(this) astINVOKE_CHECK(StcObsDataLocation,this,0)
+#define astVerifyStcObsDataLocation(this) astINVOKE_CHECK(StcObsDataLocation,this,1)
+
+/* Test class membership. */
+#define astIsAStcObsDataLocation(this) astINVOKE_ISA(StcObsDataLocation,this)
+
+/* Constructor. */
+#if defined(astCLASS) /* Protected. */
+#define astStcObsDataLocation astINVOKE(F,astStcObsDataLocation_)
+#else
+#define astStcObsDataLocation astINVOKE(F,astStcObsDataLocationId_)
+#endif
+
+#if defined(astCLASS) /* Protected */
+
+/* Initialiser. */
+#define astInitStcObsDataLocation(mem,size,init,vtab,name,region,ncoords,coords) \
+astINVOKE(O,astInitStcObsDataLocation_(mem,size,init,vtab,name,region,ncoords,coords,STATUS_PTR))
+
+/* Vtab Initialiser. */
+#define astInitStcObsDataLocationVtab(vtab,name) astINVOKE(V,astInitStcObsDataLocationVtab_(vtab,name,STATUS_PTR))
+/* Loader. */
+#define astLoadStcObsDataLocation(mem,size,vtab,name,channel) \
+astINVOKE(O,astLoadStcObsDataLocation_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
+#endif
+
+/* Interfaces to public member functions. */
+/* -------------------------------------- */
+/* Here we make use of astCheckStcObsDataLocation to validate StcObsDataLocation 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 astStcSetObs(this,obs) \
+astINVOKE(V,astStcSetObs_(astCheckStcObsDataLocation(this),obs?astCheckPointList(obs):NULL,STATUS_PTR))
+#endif
+#endif
+
+
+
+
+