ObitIOHistory.h

Go to the documentation of this file.

/* $Id: ObitIOHistory.h,v 1.6 2006/06/19 14:51:27 bcotton Exp $      */
/*--------------------------------------------------------------------*/
/*;  Copyright (C) 2004,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 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 OBITIOHISTORY_H 
#define OBITIOHISTORY_H 
#include "Obit.h"
#include "ObitIO.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"

/*-------- Obit: Software for the recently deceased ------------------*/
/*---------------Class Structure---------------------------*/
typedef struct {
#include "ObitIOHistoryDef.h"   /* actual definition */
} ObitIOHistory;

/*----------------- Macroes ---------------------------*/
#define ObitIOHistoryUnref(in) ObitUnref (in)

#define ObitIOHistoryRef(in) ObitRef (in)

#define ObitIOHistoryIsA(in) ObitIsA (in, ObitIOHistoryGetClass())

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

/*---------------Public functions---------------------------*/
void ObitIOHistoryClassInit (void);

ObitIOHistory* newObitIOHistory (gchar *name, ObitInfoList *info,
                   ObitErr *err);

gconstpointer ObitIOHistoryGetClass (void);

gboolean ObitIOHistorySame (ObitIOHistory *in, ObitInfoList *in1, 
                            ObitInfoList *in2, ObitErr *err);

void ObitIOHistoryZap  (ObitIOHistory *in, ObitErr *err);

ObitIOHistory* ObitIOHistoryCopy  (ObitIOHistory *in, ObitIOHistory *out, ObitErr *err);

ObitIOCode ObitIOHistoryOpen (ObitIOHistory *in, ObitIOAccess access, ObitInfoList *info, 
                                     ObitErr *err);

ObitIOCode ObitIOHistoryClose (ObitIOHistory *in, ObitErr *err);

ObitIOCode ObitIOHistorySet (ObitIOHistory *in, ObitInfoList *info, ObitErr *err);

ObitIOCode ObitIOHistoryReadRec (ObitIOHistory *in, glong recno, gchar *hiCard, ObitErr *err);
typedef ObitIOCode (*ObitIOHistoryReadRecFP) (ObitIOHistory *in, glong recno, gchar *hiCard, 
                                              ObitErr *err);

ObitIOCode ObitIOHistoryWriteRec (ObitIOHistory *in, glong recno, gchar *hiCard, ObitErr *err);
typedef ObitIOCode (*ObitIOHistoryWriteRecFP) (ObitIOHistory *in, glong recno, gchar *hiCard, 
                                     ObitErr *err);

ObitIOCode ObitIOHistoryFlush (ObitIOHistory *in, ObitErr *err);

ObitIOCode ObitIOHistoryReadDescriptor (ObitIOHistory *in, ObitErr *err);

ObitIOCode ObitIOHistoryWriteDescriptor (ObitIOHistory *in, ObitErr *err);

gint ObitIOHistoryNumRec (ObitIOHistory *in);
typedef gint (*ObitIOHistoryNumRecFP) (ObitIOHistory *in);

/*-------------------Class Info--------------------------*/
typedef struct  {
#include "ObitIOHistoryClassDef.h" /* Actual definition */
} ObitIOHistoryClassInfo; 


#endif /* OBITIOHISTORY_H */ 

---