ObitInfoList.h

Go to the documentation of this file.

/* $Id: ObitInfoList.h,v 1.4 2006/05/09 13:07:53 bcotton Exp $        */
/*--------------------------------------------------------------------*/
/*;  Copyright (C) 2002-2006                                          */
/*;  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 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 OBITINFOLIST_H 
#define OBITINFOLIST_H 
#include <stdio.h>
#include <glib.h>
#include "ObitErr.h"
#include "ObitInfoElem.h"

/*-------- Obit: Software for the recently deceased ------------------*/
/*---------------Class Structure---------------------------*/
typedef struct {
  gchar className[16];
  gint32  ReferenceCount;
  gint32 number;
  GSList* list;
  gint32 dim[MAXINFOELEMDIM];
  gint work[10];
  gfloat fwork[10];
} ObitInfoList;

/* Private functions are only defined in the .c file */

/*---------------Public functions---------------------------*/
ObitInfoList* newObitInfoList (void);

ObitInfoList* freeObitInfoList (ObitInfoList *in);

ObitInfoList* ObitInfoListCopy (ObitInfoList* in);

ObitInfoList* ObitInfoListRef (ObitInfoList* in);

ObitInfoList* ObitInfoListUnref (ObitInfoList* in);

ObitInfoList* ObitInfoListCopyData (ObitInfoList* in, ObitInfoList* out);

void ObitInfoListCopyList(ObitInfoList* in, ObitInfoList* out, gchar **list);

void ObitInfoListPut(ObitInfoList *in, 
                      gchar* name, ObitInfoType type, gint32 *dim, 
                      gconstpointer data, ObitErr *err);

void ObitInfoListAlwaysPut(ObitInfoList *in, 
                      gchar* name, ObitInfoType type, gint32 *dim, 
                      gconstpointer data);

gboolean ObitInfoListInfo(ObitInfoList *in, 
                      gchar *name, ObitInfoType *type, gint32 *dim, 
                      ObitErr *err);

gboolean ObitInfoListGet(ObitInfoList *in, 
                      gchar *name, ObitInfoType *type, gint32 *dim, 
                      gpointer data, ObitErr *err);

gboolean ObitInfoListGetP(ObitInfoList *in, 
                          gchar *name, ObitInfoType *type, gint32 *dim, 
                          gpointer *data);

gboolean ObitInfoListGetTest(ObitInfoList *in, 
                      gchar *name, ObitInfoType *type, gint32 *dim, 
                      gpointer data);

gboolean 
ObitInfoListGetNumber(ObitInfoList *in, gint number,
                      gchar **name, ObitInfoType *type, gint32 *dim, 
                      gpointer data, ObitErr *err);

gboolean 
ObitInfoListGetNumberP(ObitInfoList *in, gint number,
                       gchar **name, ObitInfoType *type, gint32 *dim, 
                       gpointer *data);

void ObitInfoListRemove (ObitInfoList *in, gchar *name);

void ObitInfoListResize(ObitInfoList *in, 
                        gchar *name, ObitInfoType type, gint32 *dim);

void ObitInfoListPrint (ObitInfoList *in, FILE *file);

gboolean ObitInfoListIsA (ObitInfoList* in);

#endif /* OBITINFOLIST_H */ 

---