Obit: ObitSystem.h Source File

00001 /* $Id: ObitSystem.h,v 1.6 2007/08/31 17:24:48 bcotton Exp $  */
00002 /*--------------------------------------------------------------------*/
00003 /*;  Copyright (C) 2003-2007                                          */
00004 /*;  Associated Universities, Inc. Washington DC, USA.                */
00005 /*;  This program is free software; you can redistribute it and/or    */
00006 /*;  modify it under the terms of the GNU General Public License as   */
00007 /*;  published by the Free Software Foundation; either version 2 of   */
00008 /*;  the License, or (at your option) any later version.              */
00009 /*;                                                                   */
00010 /*;  This program is distributed in the hope that it will be useful,  */
00011 /*;  but WITHOUT ANY WARRANTY; without even the implied warranty of   */
00012 /*;  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    */
00013 /*;  GNU General Public License for more details.                     */
00014 /*;                                                                   */
00015 /*;  You should have received a copy of the GNU General Public        */
00016 /*;  License along with this program; if not, write to the Free       */
00017 /*;  Software Foundation, Inc., 675 Massachusetts Ave, Cambridge,     */
00018 /*;  MA 02139, USA.                                                   */
00019 /*;                                                                   */
00020 /*;Correspondence about this software should be addressed as follows: */
00021 /*;         Internet email: bcotton@nrao.edu.                         */
00022 /*;         Postal address: William Cotton                            */
00023 /*;                         National Radio Astronomy Observatory      */
00024 /*;                         520 Edgemont Road                         */
00025 /*;                         Charlottesville, VA 22903-2475 USA        */
00026 /*--------------------------------------------------------------------*/
00027 #ifndef OBITSYSTEM_H 
00028 #define OBITSYSTEM_H 
00029 #include "ObitErr.h"
00030 #include "Obit.h"
00031 #include "ObitIO.h"
00032 
00033 /*-------- Obit: Software for the recently deceased ------------------*/
00061 /*------------------- Macroes ----------------------------------------*/
00062 /*--------------Class definitions-------------------------------------*/
00068 typedef struct {
00069 #include "ObitSystemDef.h" /* actual definition */
00070 } ObitSystem;
00071 
00072 /*---------------Public functions---------------------------*/
00074 void ObitSystemClassInit (void);
00075 
00077 ObitSystem* 
00078 ObitSystemStartup (gchar *pgmName, gint pgmNumber,
00079                    gint AIPSuser,
00080                    gint numberAIPSdisk, gchar* AIPSdir[], 
00081                    gint numberFITSdisk, gchar* FITSdir[], 
00082                    oint F_TRUE, oint F_FALSE, ObitErr *err);
00084 typedef ObitSystem* 
00085 (*ObitSystemStartupFP) (gchar *pgmName, gint pgmNumber, 
00086                         gint AIPSuser,
00087                         gint numberAIPSdisk, gchar* AIPSdir[], 
00088                         gint numberFITSdisk, gchar* FITSdir[], 
00089                         ObitErr *err);
00090 
00092 gconstpointer ObitSystemGetClass (void);
00093 
00095 ObitSystem* ObitSystemShutdown (ObitSystem* in);
00096 typedef ObitSystem* (*ObitSystemShutdownFP) (ObitSystem* in);
00097 
00099 void ObitSystemGetScratch (ObitIOType FileType, gchar *type,
00100                            ObitInfoList *info, ObitErr *err);
00101 typedef void (*ObitSystemGetScratchFP) (ObitIOType FileType, gchar *type,
00102                            ObitInfoList *info, ObitErr *err);
00103 
00105 void ObitSystemAddScratch (Obit *in, ObitErr *err);
00106 typedef void (*ObitSystemAddScratchFP) (Obit *in, ObitErr *err);
00107 
00109 void ObitSystemFreeScratch (Obit *in, ObitErr *err);
00110 typedef void (*ObitSystemFreeScratchFP) (Obit *in, ObitErr *err);
00111 
00113 gboolean ObitSystemIsInit (void);
00114 
00116 gchar* ObitSystemGetPgmName (void);
00117 
00119 void ObitSystemSetPgmName (gchar *pgmName);
00120 
00122 gint ObitSystemGetPgmNumber (void);
00123 
00125 void ObitSystemSetPgmNumber (gint pgmNumber);
00126 
00128 gint ObitSystemGetAIPSuser (void);
00129 
00131 void ObitSystemSetAIPSuser (gint AIPSuser);
00132 
00133 /*-------------------Class Info--------------------------*/
00139 typedef struct  {
00140 #include "ObitSystemClassDef.h" /* Actual definition */
00141 } ObitSystemClassInfo; 
00142 
00143 #endif /* OBITSYSTEM_H */ 
00144