ObitIOHistory.c File Reference

ObitIOHistory class function definitions. More...

#include "ObitIOHistory.h"

Functions
void	ObitIOHistoryInit (gpointer in)
	Private: Initialize newly instantiated object.
void	ObitIOHistoryClear (gpointer in)
	Private: Deallocate members.
ObitIOHistory *	newObitIOHistory (gchar *name, ObitInfoList *info, ObitErr *err)
	Public: Constructor.
gconstpointer	ObitIOHistoryGetClass (void)
	Public: ClassInfo pointer.
gboolean	ObitIOHistorySame (ObitIOHistory *in, ObitInfoList *in1, ObitInfoList *in2, ObitErr *err)
	Public: Are underlying structures the same.
void	ObitIOHistoryZap (ObitIOHistory *in, ObitErr *err)
	Public: Delete underlying structures.
ObitIOHistory *	ObitIOHistoryCopy (ObitIOHistory *in, ObitIOHistory *out, ObitErr *err)
	Public: Copy constructor.
ObitIOCode	ObitIOHistoryOpen (ObitIOHistory *in, ObitIOAccess access, ObitInfoList *info, ObitErr *err)
	Public: Open.
ObitIOCode	ObitIOHistoryClose (ObitIOHistory *in, ObitErr *err)
	Public: Close.
ObitIOCode	ObitIOHistorySet (ObitIOHistory *in, ObitInfoList *info, ObitErr *err)
	Public: Init I/O.
ObitIOCode	ObitIOHistoryReadRec (ObitIOHistory *in, glong recno, gchar *hiCard, ObitErr *err)
	Public: Read Record.
ObitIOCode	ObitIOHistoryWriteRec (ObitIOHistory *in, glong recno, gchar *hiCard, ObitErr *err)
	Public: Write Record.
gint	ObitIOHistoryNumRec (ObitIOHistory *in)
	Public: number of records.
ObitIOCode	ObitIOHistoryReadDescriptor (ObitIOHistory *in, ObitErr *err)
	Public: Read Descriptor.
ObitIOCode	ObitIOHistoryWriteDescriptor (ObitIOHistory *in, ObitErr *err)
	Public: Write Descriptor.
ObitIOCode	ObitIOHistoryFlush (ObitIOHistory *in, ObitErr *err)
	Public: Flush.
void	ObitIOHistoryClassInit (void)
	Public: Class initializer.

---

Detailed Description

ObitIOHistory class function definitions.

This is a virtual base class and should never be directly instantiated. Derived classes provide an I/O interface to various underlying disk structures.

---

Function Documentation

ObitIOHistory* newObitIOHistory (  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 ObitIOHistoryClassInit (  void   )

Public: Class initializer.

void ObitIOHistoryClear (  gpointer  inn  )

Private: Deallocate members. Does (recursive) deallocation of parent class members. Parameters: inn  Pointer to the object to deallocate.

ObitIOCode ObitIOHistoryClose (  ObitIOHistory *  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

ObitIOHistory* ObitIOHistoryCopy (  ObitIOHistory *  in, ObitIOHistory *  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 ObitIOHistoryFlush (  ObitIOHistory *  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 ObitIOHistoryGetClass (  void   )

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

void ObitIOHistoryInit (  gpointer  inn  )

Private: Initialize newly instantiated object. Does (recursive) initialization of base class members before this class. Parameters: inn  Pointer to the object to initialize.

gint ObitIOHistoryNumRec (  ObitIOHistory *  in  )

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

ObitIOCode ObitIOHistoryOpen (  ObitIOHistory *  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 ObitIOHistoryReadDescriptor (  ObitIOHistory *  in, ObitErr *  err )

Public: Read Descriptor. Parameters: in  Pointer to object with ObitImageDescto be read. err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

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

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

gboolean ObitIOHistorySame (  ObitIOHistory *  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 ObitIOHistorySet (  ObitIOHistory *  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 ObitIOHistoryWriteDescriptor (  ObitIOHistory *  in, ObitErr *  err )

Public: Write Descriptor. Parameters: in  Pointer to object with ObitImageDesc to be written. err  ObitErr for reporting errors. Returns: return code, OBIT_IO_OK=> OK

ObitIOCode ObitIOHistoryWriteRec (  ObitIOHistory *  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 ObitIOHistoryZap (  ObitIOHistory *  in, ObitErr *  err )

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

---