Main Page | Class List | Directories | File List | Class Members | File Members
src

ObitIOTableAIPS.c File Reference

ObitIOTableAIPS class function definitions. More...

#include <stdio.h>
#include "ObitIOTableAIPS.h"
#include "ObitAIPSCat.h"
#include "ObitAIPS.h"
#include "ObitMem.h"

Functions

void ObitIOTableAIPSInit (gpointer in)
 Private: Initialize newly instantiated object.
void ObitIOTableAIPSClear (gpointer in)
 Private: Deallocate members.
ObitIOTableAIPS * newObitIOTableAIPS (gchar *name, ObitInfoList *info, ObitErr *err)
 Public: Constructor.
gconstpointer ObitIOTableAIPSGetClass (void)
 Public: ClassInfo pointer.
gboolean ObitIOTableAIPSSame (ObitIO *in, ObitInfoList *in1, ObitInfoList *in2, ObitErr *err)
 Public: Are underlying structures the same.
void ObitIOTableAIPSZap (ObitIOTableAIPS *in, ObitErr *err)
 Public: Delete underlying structures.
ObitIOTableAIPS * ObitIOTableAIPSCopy (ObitIOTableAIPS *in, ObitIOTableAIPS *out, ObitErr *err)
 Public: Copy constructor.
ObitIOCode ObitIOTableAIPSOpen (ObitIOTableAIPS *in, ObitIOAccess access, ObitInfoList *info, ObitErr *err)
 Public: Open.
ObitIOCode ObitIOTableAIPSClose (ObitIOTableAIPS *in, ObitErr *err)
 Public: Close.
ObitIOCode ObitIOTableAIPSSet (ObitIOTableAIPS *in, ObitInfoList *info, ObitErr *err)
 Public: Init I/O.
ObitIOCode ObitIOTableAIPSReadRow (ObitIOTableAIPS *in, glong rowno, gfloat *data, ObitErr *err)
 Public: Read specifying start row.
ObitIOCode ObitIOTableAIPSRead (ObitIOTableAIPS *in, gfloat *data, ObitErr *err)
 Public: Read.
ObitIOCode ObitIOTableAIPSReadRowSelect (ObitIOTableAIPS *in, glong rowno, gfloat *data, ObitErr *err)
 Read table data from disk applying selection and specifying start row.
ObitIOCode ObitIOTableAIPSReadSelect (ObitIOTableAIPS *in, gfloat *data, ObitErr *err)
 Read table data from disk applying selection.
ObitIOCode ObitIOTableAIPSWriteRow (ObitIOTableAIPS *in, glong rowno, gfloat *data, ObitErr *err)
 Public: Write specifying start row.
ObitIOCode ObitIOTableAIPSWrite (ObitIOTableAIPS *in, gfloat *data, ObitErr *err)
 Public: Write.
ObitIOCode ObitIOTableAIPSReadDescriptor (ObitIOTableAIPS *in, ObitErr *err)
 Public: Read Descriptor.
ObitIOCode ObitIOTableAIPSWriteDescriptor (ObitIOTableAIPS *in, ObitErr *err)
 Public: Write Descriptor.
ObitIOCode ObitIOTableAIPSFlush (ObitIOTableAIPS *in, ObitErr *err)
 Public: Flush.
void ObitIOTableAIPSCreateBuffer (gfloat **data, glong *size, ObitIOTableAIPS *in, ObitInfoList *info, ObitErr *err)
 Public: Create buffer.
void ObitIOTableAIPSClassInit (void)
 Public: Class initializer.

Variables

gchar * NotAIPSTable [] = {"HI", "PL", "SL", NULL}
 List of AIPS "extensions which are not Tables.

Detailed Description

ObitIOTableAIPS class function definitions.

Function Documentation

ObitIOTableAIPS* newObitIOTableAIPS (  gchar *  name,
ObitInfoList *  info,
ObitErr *  err
) 
 

Public: Constructor.

Initializes class on the first call.

Parameters:
name An optional name for the object.
info if non-NULL it is used to initialize the new object.
err ObitErr for error messages.
Returns:
the new object, NULL on failure.

void ObitIOTableAIPSClassInit (  void   ) 
 

Public: Class initializer.

void ObitIOTableAIPSClear (  gpointer  inn  ) 
 

Private: Deallocate members.

Does (recursive) deallocation of parent class members.

Parameters:
inn Pointer to the object to deallocate.

ObitIOCode ObitIOTableAIPSClose (  ObitIOTableAIPS *  in,
ObitErr *  err
) 
 

Public: Close.

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

ObitIOTableAIPS* ObitIOTableAIPSCopy (  ObitIOTableAIPS *  in,
ObitIOTableAIPS *  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.

void ObitIOTableAIPSCreateBuffer (  gfloat **  data,
glong *  size,
ObitIOTableAIPS *  in,
ObitInfoList *  info,
ObitErr *  err
) 
 

Public: Create buffer.

Parameters:
data (output) pointer to data array
size (output) size of data array in bytes.
in Pointer to object to be accessed.
info ObitInfoList with instructions
err ObitErr for reporting errors.

ObitIOCode ObitIOTableAIPSFlush (  ObitIOTableAIPS *  in,
ObitErr *  err
) 
 

Public: Flush.

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

gconstpointer ObitIOTableAIPSGetClass (  void   ) 
 

Public: ClassInfo pointer.

Initializes class if needed on first call.

Returns:
pointer to the class structure.

void ObitIOTableAIPSInit (  gpointer  inn  ) 
 

Private: Initialize newly instantiated object.

for each parent class.

Parameters:
inn Pointer to the object to initialize.

ObitIOCode ObitIOTableAIPSOpen (  ObitIOTableAIPS *  in,
ObitIOAccess  access,
ObitInfoList *  info,
ObitErr *  err
) 
 

Public: Open.

The file etc. info should have been stored in the ObitInfoList. For accessing AIPS files the following entries in the ObitInfoList are used:

  • "Disk" OBIT_int (1,1,1) AIPS "disk" number.
  • "User" OBIT_int (1,1,1) user number.
  • "CNO" OBIT_int (1,1,1) AIPS catalog slot number.
  • "TableType" OBIT_string (2,1,1) AIPS Table type
  • "Ver" OBIT_int (1,1,1) AIPS table version number.
    Parameters:
    in Pointer to object to be opened.
    access access (OBIT_IO_ReadOnly,OBIT_IO_ReadWrite, OBIT_IO_WriteOnly).
    info ObitInfoList with instructions for opening
    err ObitErr for reporting errors.
    Returns:
    return code, 0=> OK

ObitIOCode ObitIOTableAIPSRead (  ObitIOTableAIPS *  in,
gfloat *  data,
ObitErr *  err
) 
 

Public: Read.

If there are existing rows in the buffer marked as modified ("_status" column value =1) the buffer is rewritten to disk before the new buffer is read.

Parameters:
in Pointer to object to be read.
data pointer to buffer to receive results.
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

ObitIOCode ObitIOTableAIPSReadDescriptor (  ObitIOTableAIPS *  in,
ObitErr *  err
) 
 

Public: Read Descriptor.

AIPS Table headers are REALLY messy! This routine needs to be coordinated with ObitAIPSCat::ObitAIPSCatTableGetDesc.

Parameters:
in Pointer to object with ObitTableDesc to be read.
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

ObitIOCode ObitIOTableAIPSReadRow (  ObitIOTableAIPS *  in,
glong  rowno,
gfloat *  data,
ObitErr *  err
) 
 

Public: Read specifying start row.

If there are existing rows in the buffer marked as modified ("_status" column value =1) the buffer is rewritten to disk before the new buffer is read.

Parameters:
in Pointer to object to be read.
rowno Starting row number (1-rel) -1=> next.
data pointer to buffer to receive results.
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

ObitIOCode ObitIOTableAIPSReadRowSelect (  ObitIOTableAIPS *  in,
glong  rowno,
gfloat *  data,
ObitErr *  err
) 
 

Read table data from disk applying selection and specifying start row.

If there are existing rows in the buffer marked as modified ("_status" column value =1) the buffer is rewritten to disk before the new buffer is read.

Parameters:
in Pointer to object to be read.
rowno Starting row number (1-rel), -1=> next.
data pointer to buffer to write results.
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

ObitIOCode ObitIOTableAIPSReadSelect (  ObitIOTableAIPS *  in,
gfloat *  data,
ObitErr *  err
) 
 

Read table data from disk applying selection.

If there are existing rows in the buffer marked as modified ("_status" column value =1) the buffer is rewritten to disk before the new buffer is read.

Parameters:
in Pointer to object to be read.
data pointer to buffer to write results.
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

gboolean ObitIOTableAIPSSame (  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 ObitIOTableAIPSSet (  ObitIOTableAIPS *  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, 0=> OK

ObitIOCode ObitIOTableAIPSWrite (  ObitIOTableAIPS *  in,
gfloat *  data,
ObitErr *  err
) 
 

Public: Write.

Write the desc->numRowBuff rows beginning with desc->firstRow with the data in data. Rows with negative values in the "_status" column are not written.

Parameters:
in Pointer to object to be written.
data pointer to buffer containing input data.
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

ObitIOCode ObitIOTableAIPSWriteDescriptor (  ObitIOTableAIPS *  in,
ObitErr *  err
) 
 

Public: Write Descriptor.

Parameters:
in Pointer to object with ObitTableDesc to be written.
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

ObitIOCode ObitIOTableAIPSWriteRow (  ObitIOTableAIPS *  in,
glong  rowno,
gfloat *  data,
ObitErr *  err
) 
 

Public: Write specifying start row.

Write the desc->numRowBuff rows beginning with desc->firstRow with the data in data. Rows with negative values in the "_status" column are not written.

Parameters:
in Pointer to object to be written.
rowno Starting row number (1-rel) -1=> next.
data pointer to buffer containing input data.
err ObitErr for reporting errors.
Returns:
return code, 0=> OK

void ObitIOTableAIPSZap (  ObitIOTableAIPS *  in,
ObitErr *  err
) 
 

Public: Delete underlying structures.

Parameters:
in Pointer to object to be zapped.
err ObitErr for reporting errors.

Variable Documentation

gchar* NotAIPSTable[] = {"HI", "PL", "SL", NULL}
 

List of AIPS "extensions which are not Tables.

Generated on Fri Aug 31 22:13:06 2007 for Obit by  doxygen 1.3.9.1