Obit.h

Go to the documentation of this file.

/* $Id: Obit.h,v 1.10 2007/08/31 17:24:48 bcotton Exp $            */
/*--------------------------------------------------------------------*/
/*;  Copyright (C) 2002-2007                                          */
/*;  Associated Universities, Inc. Washington DC, USA.                */
/*;                                                                   */
/*;  This program is free software; you can redistribute it and/or    */
/*;  modify it under the terms of the GNU General Public License as   */
/*;  published by the Free Software Foundation; either version 2 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 General Public License for more details.                     */
/*;                                                                   */
/*;  You should have received a copy of the GNU General Public        */
/*;  License along with this program; if not, write to the Free       */
/*;  Software Foundation, Inc., 675 Massachusetts Ave, Cambridge,     */
/*;  MA 02139, USA.                                                   */
/*;                                                                   */
/*;Correspondence about this software should be addressed as follows: */
/*;         Internet email: bcotton@nrao.edu.                         */
/*;         Postal address: William Cotton                            */
/*;                         National Radio Astronomy Observatory      */
/*;                         520 Edgemont Road                         */
/*;                         Charlottesville, VA 22903-2475 USA        */
/*--------------------------------------------------------------------*/
#ifndef OBIT_H 
#define OBIT_H 
#include <glib.h>
#include <string.h>
#include "memwatch.h"  /* For debugging memory problems */
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include "ObitTypes.h"
#include "ObitErr.h"
/*-------- Obit: Software for the recently deceased ------------------*/
/*-------------- enumerations -------------------------------------*/
/*--------------Class definitions-------------------------------------*/
#define OBIT_ID 0x4f626974

typedef struct {
#include "ObitDef.h"    /* actual CLASS definition */
} Obit;

/*---------------Public functions---------------------------*/
Obit* newObit (gchar* name);
/* define type for ClassInfo structure */
typedef gpointer (*newObitFP)(gchar* name);

void ObitClassInit (void);
typedef void (*ObitClassInitFP) (void);

gconstpointer ObitGetClass (void);
typedef gconstpointer (*ObitGetClassFP)(void);

Obit* ObitCopy  (Obit *in, Obit *out, ObitErr *err);
typedef gpointer (*ObitCopyFP)   (gpointer in, gpointer out, 
                                  ObitErr *err);

Obit* ObitClone (Obit *in, Obit *out);
typedef gpointer (*ObitCloneFP)  (Obit* in, Obit* out);

gpointer ObitRef (gpointer in);
typedef  gpointer (*ObitRefFP)   (gpointer in);

gpointer ObitUnref (gpointer in);
typedef gpointer (*ObitUnrefFP) (gpointer *in);

gboolean ObitIsA (gpointer in, gconstpointer type);
typedef gboolean (*ObitIsAFP) (gpointer in, gconstpointer class);

gfloat ObitMagicF (void);

void ObitTrimTrail (gchar *str);

gboolean ObitStrCmp (gchar *str1, gchar *str2, gint maxlen);

gchar* ObitToday (void);

typedef void (*ObitInitFP)      (gpointer in);
typedef void (*ObitClearFP)     (gpointer in);

/*----------------------- Class Info ---------------------------------*/
void ObitClassInfoDefFn (gpointer inClass);
typedef void (*ObitClassInfoDefFnFP) (gpointer inClass);

typedef struct  {
#include "ObitClassDef.h" /* actual definitions */
} ObitClassInfo; 

gboolean ObitInfoIsA (ObitClassInfo* in, ObitClassInfo* type);
typedef gboolean (*ObitInfoIsAFP) (ObitClassInfo* in, ObitClassInfo* type);


#endif /* OBIT_H */ 

---