ObitHistory.h

Go to the documentation of this file.

/* $Id: ObitHistory.h,v 1.7 2007/08/31 17:24:48 bcotton Exp $     */
/*--------------------------------------------------------------------*/
/*;  Copyright (C) 2004-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 OBITTABLEHISTORY_H 
#define OBITTABLEHISTORY_H 
#include "Obit.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"
#include "ObitIOHistory.h"

/*-------- Obit: Software for the recently deceased ------------------*/
/*--------------Class definitions-------------------------------------*/
typedef struct {
#include "ObitHistoryDef.h"   /* this class definition */
} ObitHistory;

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

#define ObitHistoryRef(in) ObitRef (in)

#define ObitHistoryIsA(in) ObitIsA (in, ObitHistoryGetClass())

#define ObitHistorySetFITS(in,disk,file,err) G_STMT_START{ \
       in->info->dim[0]=1; in->info->dim[1]=1; in->info->dim[2]=1;  \
       in->info->dim[3]=1; in->info->dim[4]=1;                      \
       in->info->work[0] = OBIT_IO_FITS;                            \
       in->info->work[2] = disk;                                    \
       in->info->dim[0] = 1;                                        \
       ObitInfoListPut (in->info, "Disk", OBIT_int,                 \
                 in->info->dim, (gpointer)&in->info->work[2], err); \
       ObitInfoListPut (in->info, "FileType", OBIT_int,             \
                  in->info->dim, (gpointer)&in->info->work[0], err);\
       in->info->dim[0] = strlen(file);                             \
       ObitInfoListPut (in->info, "FileName", OBIT_string,          \
                 in->info->dim, (gpointer)file, err);               \
     }G_STMT_END  

#define ObitHistorySetAIPS(in,disk,cno,user,err)  G_STMT_START{  \
       in->info->dim[0]=1; in->info->dim[1]=1; in->info->dim[2]=1;  \
       in->info->dim[3]=1; in->info->dim[4]=1;                      \
       in->info->work[0] = OBIT_IO_AIPS;                            \
       ObitInfoListPut (in->info, "FileType", OBIT_int,             \
                  in->info->dim, (gpointer)&in->info->work[0], err);\
       in->info->dim[0] = 1;                                        \
       ObitInfoListPut (in->info, "Disk", OBIT_int,                 \
                 in->info->dim, (gpointer)&disk, err);              \
       ObitInfoListPut (in->info, "CNO", OBIT_int,                  \
                 in->info->dim, (gpointer)&cno, err);               \
       ObitInfoListPut (in->info, "User", OBIT_int,                 \
                 in->info->dim, (gpointer)&user, err);              \
     }G_STMT_END   


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

ObitHistory* newObitHistory (gchar* name);

gconstpointer ObitHistoryGetClass (void);

ObitHistory* 
newObitHistoryValue (gchar* name, ObitInfoList *info, ObitErr *err);

ObitHistory* ObitHistoryZap (ObitHistory *in, ObitErr *err);
typedef ObitHistory*(*ObitHistoryZapFP) (ObitHistory *in, ObitErr *err);

ObitHistory* ObitHistoryCopy  (ObitHistory *in, ObitHistory *out, 
                                         ObitErr *err);

ObitIOCode ObitHistoryCopyHeader  (ObitHistory *in, ObitHistory *out, 
                                        ObitErr *err);

ObitIOCode ObitHistoryCopy2Header  (ObitHistory *in, ObitHistory *out, 
                                         ObitErr *err);

ObitIOCode ObitHistoryHeader2Header  (ObitHistory *in, ObitHistory *out, 
                                      ObitErr *err);

ObitIOCode ObitHistoryOpen (ObitHistory *in, ObitIOAccess access, 
                            ObitErr *err);
typedef ObitIOCode(*ObitHistoryOpenFP) (ObitHistory *in, ObitIOAccess access,
                                        ObitErr *err);

ObitIOCode ObitHistoryClose (ObitHistory *in, ObitErr *err);
typedef ObitIOCode(*ObitHistoryCloseFP) (ObitHistory *in,  ObitErr *err);

ObitIOCode 
ObitHistoryReadRec (ObitHistory *in, glong recno, gchar hiCard[73],
                    ObitErr *err);

ObitIOCode 
ObitHistoryWriteRec (ObitHistory *in, glong rowno, gchar hiCard[73], 
                     ObitErr *err);

ObitIOCode 
ObitHistoryTimeStamp (ObitHistory *in, gchar *label,
                              ObitErr *err);

ObitIOCode 
ObitHistoryCopyInfoList (ObitHistory *out, gchar *pgmName, gchar *list[], 
                         ObitInfoList *info, ObitErr *err);

gint ObitHistoryNumRec (ObitHistory *in);

/*----------- ClassInfo Structure -----------------------------------*/
typedef struct  {
#include "ObitHistoryClassDef.h"
} ObitHistoryClassInfo; 

#endif /* OBITTABLEHISTORY_H */ 

---