Obit: ObitDisplay.h Source File

00001 /* $Id: ObitDisplay.h,v 1.4 2007/08/31 17:24:48 bcotton Exp $        */
00002 /*--------------------------------------------------------------------*/
00003 /*;  Copyright (C) 2005,2007                                          */
00004 /*;  Associated Universities, Inc. Washington DC, USA.                */
00005 /*;                                                                   */
00006 /*;  This program is free software; you can redistribute it and/or    */
00007 /*;  modify it under the terms of the GNU General Public License as   */
00008 /*;  published by the Free Software Foundation; either version 2 of   */
00009 /*;  the License, or (at your option) any later version.              */
00010 /*;                                                                   */
00011 /*;  This program is distributed in the hope that it will be useful,  */
00012 /*;  but WITHOUT ANY WARRANTY; without even the implied warranty of   */
00013 /*;  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    */
00014 /*;  GNU General Public License for more details.                     */
00015 /*;                                                                   */
00016 /*;  You should have received a copy of the GNU General Public        */
00017 /*;  License along with this program; if not, write to the Free       */
00018 /*;  Software Foundation, Inc., 675 Massachusetts Ave, Cambridge,     */
00019 /*;  MA 02139, USA.                                                   */
00020 /*;                                                                   */
00021 /*; Correspondence about this software should be addressed as follows:*/
00022 /*;         Internet email: bcotton@nrao.edu.                         */
00023 /*;         Postal address: William Cotton                            */
00024 /*;                         National Radio Astronomy Observatory      */
00025 /*;                         520 Edgemont Road                         */
00026 /*;                         Charlottesville, VA 22903-2475 USA        */
00027 /*--------------------------------------------------------------------*/
00028 #ifndef OBITDISPLAY_H 
00029 #define OBITDISPLAY_H 
00030 
00031 #include "Obit.h"
00032 #include "ObitErr.h"
00033 #include "ObitRPC.h"
00034 #include "ObitDConCleanWindow.h"
00035 
00036 /*-------- Obit: Software for the recently deceased ------------------*/
00163 /*-------------- enumerations -------------------------------------*/
00170 enum obitDisplayRequest {
00172   OBIT_Request_Continue = 0, 
00174   OBIT_Request_Abort, 
00176   OBIT_Request_Quit, 
00178   OBIT_Request_NoTV,
00180   OBIT_Request_View,
00182   OBIT_Request_Edit
00183 }; /* end enum obitDisplayRequest */
00185 typedef enum obitDisplayRequest ObitDisplayRequest;
00186 
00187 /*--------------Class definitions-------------------------------------*/
00189 typedef struct {
00190 #include "ObitDisplayDef.h"   /* this class definition */
00191 } ObitDisplay;
00192 
00193 /*----------------- Macroes ---------------------------*/
00199 #define ObitDisplayUnref(in) ObitUnref (in)
00200 
00206 #define ObitDisplayRef(in) ObitRef (in)
00207 
00214 #define ObitDisplayIsA(in) ObitIsA (in, ObitDisplayGetClass())
00215 
00216 /*---------------Public functions---------------------------*/
00218 void ObitDisplayClassInit (void);
00219 
00221 ObitDisplay* newObitDisplay (gchar* name);
00222 
00224 ObitDisplay* ObitDisplayCreate (gchar* name, gchar *ServerURL, ObitErr *err);
00226 typedef ObitDisplay* (*ObitDisplayCreateFP) (gchar* name, gchar *ServerURL, 
00227                                              ObitErr *err);
00228 
00230 gconstpointer ObitDisplayGetClass (void);
00231 
00233 gboolean ObitDisplayShow (ObitDisplay* display, Obit *image, 
00234                           ObitDConCleanWindow *window, 
00235                           gint field, ObitErr *err);
00237 typedef gboolean (*ObitDisplayShowFP) (ObitDisplay* display, Obit *image, 
00238                                        ObitDConCleanWindow *window, gint field, 
00239                                        ObitErr *err);
00240 
00242 void ObitDisplayTurnOn (ObitDisplay* display);
00244 typedef void (*ObitDisplayTurnOnFP) (ObitDisplay* display);
00245 
00247 void ObitDisplayTurnOff (ObitDisplay* display);
00249 typedef void (*ObitDisplayTurnOffFP) (ObitDisplay* display);
00250 
00251 
00252 /*----------- ClassInfo Structure -----------------------------------*/
00258 typedef struct  {
00259 #include "ObitDisplayClassDef.h"
00260 } ObitDisplayClassInfo; 
00261 
00262 #endif /* OBITDISPLAY_H */