ObitFile.h

Go to the documentation of this file.

/* $Id: ObitFile.h,v 1.13 2007/08/31 17:24:48 bcotton Exp $        */
/*--------------------------------------------------------------------*/
/*;  Copyright (C) 2003-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 OBITFILE_H 
#define OBITFILE_H 
#include <sys/types.h>
#include "Obit.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"

/*-------- Obit: Software for the recently deceased ------------------*/
/*----------------- typedefs ---------------------------*/
typedef off_t ObitFilePos;
/*typedef gint64 ObitFilePos;*/

/*---------------Class Structure---------------------------*/
typedef struct {
#include "ObitFileDef.h"   /* actual definition */
} ObitFile;

/*----------------- Macroes ---------------------------*/

#define ObitFileUnref(in) ObitUnref (in)

#define ObitFileRef(in) ObitRef (in)

#define ObitFileIsA(in) ObitIsA (in, ObitFileGetClass())

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

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

ObitFile* newObitFile (gchar* name);

gconstpointer ObitFileGetClass (void);

ObitFile* ObitFileZap (ObitFile *in, ObitErr *err);
typedef ObitFile* (*ObitFileZapFP) (ObitFile *in, ObitErr *err);

void ObitFileRename (gchar *oldName, gchar *newName, ObitErr *err);
typedef void (*ObitFileRenameFP) (gchar *oldName, gchar *newName,  ObitErr *err);

ObitFile* ObitFileCopy  (ObitFile *in, ObitFile *out, ObitErr *err);

ObitIOCode 
ObitFileOpen (ObitFile *in, gchar *fileName, ObitIOAccess access,  
              ObitIOType type, glong blockSize, ObitErr *err);
typedef ObitIOCode (*ObitFileOpenFP) (ObitFile *in, gchar *fileName, 
                                      ObitIOAccess access,  
                                      ObitIOType type, glong blockSize, 
                                      ObitErr *err);

ObitIOCode ObitFileClose (ObitFile *in, ObitErr *err);
typedef ObitIOCode (*ObitFileCloseFP) (ObitFile *in, ObitErr *err);

ObitIOCode ObitFileSetPos (ObitFile *in, ObitFilePos filePos, ObitErr *err);
typedef ObitIOCode (*ObitFileSetPosFP) (ObitFile *in, ObitFilePos filePos, 
                                        ObitErr *err);

ObitIOCode ObitFileEnd (ObitFile *in, ObitErr *err);
typedef ObitIOCode (*ObitFileEndFP) (ObitFile *in, ObitErr *err);

ObitIOCode 
ObitFileRead (ObitFile *in, ObitFilePos filePos, glong size, gchar *buffer, 
              ObitErr *err);
typedef ObitIOCode (*ObitFileReadFP) (ObitFile *in, ObitFilePos filePos, 
                                      glong size,  gchar *buffer, 
                                      ObitErr *err);

ObitIOCode 
ObitFileReadLine (ObitFile *in, gchar *line, gint lineMax, ObitErr *err);
typedef ObitIOCode (*ObitFileReadLineFP) (ObitFile *in, gchar *line, gint lineMax, ObitErr *err);

ObitIOCode 
ObitFileWrite (ObitFile *in, ObitFilePos filePos, glong size, gchar *buffer, 
               ObitErr *err);
typedef ObitIOCode (*ObitFileWriteFP) (ObitFile *in, ObitFilePos filePos, 
                                       glong size, gchar *buffer, 
                                       ObitErr *err);

ObitIOCode 
ObitFileWriteLine (ObitFile *in, gchar *line, ObitErr *err);
typedef ObitIOCode (*ObitFileWriteLineFP) (ObitFile *in, gchar *line, ObitErr *err);

ObitIOCode 
ObitFilePad (ObitFile *in, glong padTo, gchar *buffer, glong bsize, 
             ObitErr *err);
typedef ObitIOCode (*ObitFilePadFP) (ObitFile *in, glong padTo, 
                                     gchar *buffer, 
                                     glong bsize, ObitErr *err);

ObitIOCode 
ObitFilePadFile (ObitFile *in, glong blksize, ObitErr *err);
typedef ObitIOCode (*ObitFilePadFileFP) (ObitFile *in, glong blksize, 
                                         ObitErr *err);

ObitIOCode ObitFileFlush (ObitFile *in, ObitErr *err);
typedef ObitIOCode (*ObitFileFlushFP) (ObitFile *in, ObitErr *err);

gboolean ObitFileExist (gchar *fileName, ObitErr *err);
typedef gboolean (*ObitFileExistFP) (gchar *fileName, ObitErr *err);

ObitFilePos ObitFileSize (gchar *fileName, ObitErr *err);
typedef ObitFilePos (*ObitFileSizeFP) (ObitFile *in, ObitErr *err);

gchar* ObitFileName (gchar *fileName);
typedef gchar* (*ObitFileNameFP) (ObitFile *in);


gboolean ObitFileErrMsg (ObitErr *err);
typedef gboolean (*ObitFileErrMsgFP) (ObitErr *err);

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


#endif /* OBITFILE_H */ 

---