ObitIOHistoryFITS.h File Reference

ObitIOHistoryFITS class definition. More...

#include "Obit.h"
#include "ObitErr.h"
#include "ObitThread.h"
#include "ObitInfoList.h"
#include "ObitIOHistory.h"
#include "ObitTableHistory.h"

Go to the source code of this file.

Classes
struct	ObitIOHistoryFITS
	ObitIOHistoryFITS Class. More...
struct	ObitIOHistoryFITSClassInfo
	ClassInfo Structure. More...
Defines
#define	ObitIOHistoryFITSUnref(in)   ObitUnref (in)
	Macro to unreference (and possibly destroy) an ObitIOHistoryFITS returns a ObitIOHistoryFITS*.
#define	ObitIOHistoryFITSRef(in)   ObitRef (in)
	Macro to reference (update reference count) an ObitIOHistoryFITS.
#define	ObitIOHistoryFITSIsA(in)   ObitIsA (in, ObitIOHistoryFITSGetClass())
	Macro to determine if an object is the member of this or a derived class.
Typedefs
typedef ObitIOCode(*	ObitIOHistoryFITSReadRecFP )(ObitIOHistoryFITS *in, glong recno, gchar *hiCard, ObitErr *err)
typedef ObitIOCode(*	ObitIOHistoryFITSWriteRecFP )(ObitIOHistoryFITS *in, glong recno, gchar *hiCard, ObitErr *err)
Functions
void	ObitIOHistoryFITSClassInit (void)
	Public: Class initializer.
ObitIOHistoryFITS *	newObitIOHistoryFITS (gchar *name, ObitInfoList *info, ObitErr *err)
	Public: Constructor.
gconstpointer	ObitIOHistoryFITSGetClass (void)
	Public: ClassInfo pointer.
gboolean	ObitIOHistoryFITSSame (ObitIO *in, ObitInfoList *in1, ObitInfoList *in2, ObitErr *err)
	Public: Are underlying structures the same.
void	ObitIOHistoryFITSZap (ObitIOHistoryFITS *in, ObitErr *err)
	Public: Delete underlying structures.
ObitIOHistoryFITS *	ObitIOHistoryFITSCopy (ObitIOHistoryFITS *in, ObitIOHistoryFITS *out, ObitErr *err)
	Public: Copy constructor.
ObitIOCode	ObitIOHistoryFITSOpen (ObitIOHistoryFITS *in, ObitIOAccess access, ObitInfoList *info, ObitErr *err)
	Public: Open.
ObitIOCode	ObitIOHistoryFITSClose (ObitIOHistoryFITS *in, ObitErr *err)
	Public: Close.
ObitIOCode	ObitIOHistoryFITSSet (ObitIOHistoryFITS *in, ObitInfoList *info, ObitErr *err)
	Public: Init I/O.
ObitIOCode	ObitIOHistoryFITSReadRrec (ObitIOHistoryFITS *in, glong recno, gchar *hiCard, ObitErr *err)
	Public: Read Record.
ObitIOCode	ObitIOHistoryFITSWriteRec (ObitIOHistoryFITS *in, glong recno, gchar *hiCard, ObitErr *err)
	Public: Write Record.
ObitIOCode	ObitIOHistoryFITSFlush (ObitIOHistoryFITS *in, ObitErr *err)
	Public: Flush.
ObitIOCode	ObitIOHistoryFITSReadDescriptor (ObitIOHistoryFITS *in, ObitErr *err)
	Public: Read Descriptor.
ObitIOCode	ObitIOHistoryFITSWriteDescriptor (ObitIOHistoryFITS *in, ObitErr *err)
	Public: Write Descriptor.
gint	ObitIOHistoryFITSNumRec (ObitIOHistory *in)
	Public: number of records.

---

Detailed Description

ObitIOHistoryFITS class definition.

This class is derived from the ObitIOHistory class.

This class allows history access to FITS files

---

Define Documentation

#define ObitIOHistoryFITSIsA (  in   )     ObitIsA (in, ObitIOHistoryFITSGetClass())

Macro to determine if an object is the member of this or a derived class. Returns TRUE if a member, else FALSE in = object to reference

#define ObitIOHistoryFITSRef (  in   )     ObitRef (in)

Macro to reference (update reference count) an ObitIOHistoryFITS. returns a ObitIOHistoryFITS*. in = object to reference

#define ObitIOHistoryFITSUnref (  in   )     ObitUnref (in)

Macro to unreference (and possibly destroy) an ObitIOHistoryFITS returns a ObitIOHistoryFITS*. in = object to unreference

---

Typedef Documentation

typedef ObitIOCode(* ObitIOHistoryFITSReadRecFP)(ObitIOHistoryFITS *in, glong recno, gchar *hiCard, ObitErr *err)

typedef ObitIOCode(* ObitIOHistoryFITSWriteRecFP)(ObitIOHistoryFITS *in, glong recno, gchar *hiCard, ObitErr *err)

---

Function Documentation

ObitIOHistoryFITS* newObitIOHistoryFITS (  gchar *  name, ObitInfoList *  info, ObitErr *  err )

Public: Constructor. Initializes class if needed on first call. Parameters: name  Name [optional] for object info  InfoList defining file err  ObitErr for reporting errors. Returns: the new object.

void ObitIOHistoryFITSClassInit (  void   )

Public: Class initializer.

ObitIOCode ObitIOHistoryFITSClose (  ObitIOHistoryFITS *  in, ObitErr *  err )

Public: Close. Parameters: in  Pointer to object to be closed. err  ObitErr for reporting errors. Returns: error code, OBIT_IO_OK=> OK

ObitIOHistoryFITS* ObitIOHistoryFITSCopy (  ObitIOHistoryFITS *  in, ObitIOHistoryFITS *  out, ObitErr *  err )

Public: Copy constructor. The result will have pointers to the more complex members. Parent class members are included but any derived class info is ignored. Parameters: in  The object to copy out  An existing object pointer for output or NULL if none exists. err  Obit error stack object. Returns: pointer to the new object.

ObitIOCode ObitIOHistoryFITSFlush (  ObitIOHistoryFITS *  in, ObitErr *  err )

Public: Flush. Parameters: in  Pointer to object to be accessed. err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

gconstpointer ObitIOHistoryFITSGetClass (  void   )

Public: ClassInfo pointer. Initializes class if needed on first call. Returns: pointer to the class structure.

gint ObitIOHistoryFITSNumRec (  ObitIOHistory *  in  )

Public: number of records. Parameters: in  Pointer to open object to be tested Returns: number of records, <0 => problem

ObitIOCode ObitIOHistoryFITSOpen (  ObitIOHistoryFITS *  in, ObitIOAccess  access, ObitInfoList *  info, ObitErr *  err )

Public: Open. The file and selection info member should have been stored in the ObitInfoList prior to calling. See derived classes for details. Parameters: in  Pointer to object to be opened. access  access (OBIT_IO_ReadOnly,OBIT_IO_ReadWrite) info  ObitInfoList with instructions for opening err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

ObitIOCode ObitIOHistoryFITSReadDescriptor (  ObitIOHistoryFITS *  in, ObitErr *  err )

Public: Read Descriptor. The Table system does this automagically for FITS files Parameters: in  Pointer to object be read. err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

ObitIOCode ObitIOHistoryFITSReadRrec (  ObitIOHistoryFITS *  in, glong  recno, gchar *  hiCard, ObitErr *  err )

Public: Read Record.

gboolean ObitIOHistoryFITSSame (  ObitIO *  in, ObitInfoList *  in1, ObitInfoList *  in2, ObitErr *  err )

Public: Are underlying structures the same. This test is done using values entered into the ObitInfoList in case the object has not yet been opened. Parameters: in  ObitIO for test in1  ObitInfoList for first object to be tested in2  ObitInfoList for second object to be tested err  ObitErr for reporting errors. Returns: TRUE if to objects have the same underlying structures else FALSE

ObitIOCode ObitIOHistoryFITSSet (  ObitIOHistoryFITS *  in, ObitInfoList *  info, ObitErr *  err )

Public: Init I/O. Parameters: in  Pointer to object to be accessed. info  ObitInfoList with instructions err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

ObitIOCode ObitIOHistoryFITSWriteDescriptor (  ObitIOHistoryFITS *  in, ObitErr *  err )

Public: Write Descriptor. The Table system does this automagically for FITS files Parameters: in  Pointer to object to be written. err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

ObitIOCode ObitIOHistoryFITSWriteRec (  ObitIOHistoryFITS *  in, glong  recno, gchar *  hiCard, ObitErr *  err )

Public: Write Record. Parameters: in  Pointer to object to be written. recno  Record number (1-rel) -1=> next, overwrites any existing hiCard  input history record (70 char) err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

void ObitIOHistoryFITSZap (  ObitIOHistoryFITS *  in, ObitErr *  err )

Public: Delete underlying structures. Parameters: in  Pointer to object to be zapped. err  ObitErr for reporting errors.

---