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

ObitTableOTFIndex.c File Reference

ObitTableOTFIndex class function definitions. More...

#include "ObitTableOTFIndex.h"
#include "ObitTableList.h"
#include "ObitData.h"

Functions

void ObitTableOTFIndexRowInit (gpointer in)
 Private: Initialize newly instantiated Row object.
void ObitTableOTFIndexRowClear (gpointer in)
 Private: Deallocate Row members.
void ObitTableOTFIndexInit (gpointer in)
 Private: Initialize newly instantiated object.
void ObitTableOTFIndexClear (gpointer in)
 Private: Deallocate members.
ObitTableOTFIndexRownewObitTableOTFIndexRow (ObitTableOTFIndex *table)
 Public: Constructor.
gconstpointer ObitTableOTFIndexRowGetClass (void)
 Public: ClassInfo pointer.
ObitTableOTFIndexnewObitTableOTFIndex (gchar *name)
 Public: Constructor.
gconstpointer ObitTableOTFIndexGetClass (void)
 Public: ClassInfo pointer.
ObitTableOTFIndexnewObitTableOTFIndexValue (gchar *name, Obit *file, glong *ver, ObitIOAccess access, ObitErr *err)
 Public: Constructor from values.
ObitTableOTFIndexObitTableOTFIndexConvert (ObitTable *in)
 Public: Convert an ObitTable to an ObitTableOTFIndex.
ObitTableOTFIndexObitTableOTFIndexCopy (ObitTableOTFIndex *in, ObitTableOTFIndex *out, ObitErr *err)
 Public: Copy (deep) constructor.
ObitIOCode ObitTableOTFIndexOpen (ObitTableOTFIndex *in, ObitIOAccess access, ObitErr *err)
 Public: Create ObitIO structures and open file.
ObitIOCode ObitTableOTFIndexReadRow (ObitTableOTFIndex *in, glong iOTFIndexRow, ObitTableOTFIndexRow *row, ObitErr *err)
 Public: Read a table row.
void ObitTableOTFIndexSetRow (ObitTableOTFIndex *in, ObitTableOTFIndexRow *row, ObitErr *err)
 Public: Init a table row for write.
ObitIOCode ObitTableOTFIndexWriteRow (ObitTableOTFIndex *in, glong iOTFIndexRow, ObitTableOTFIndexRow *row, ObitErr *err)
 Public: Write a table row.
ObitIOCode ObitTableOTFIndexClose (ObitTableOTFIndex *in, ObitErr *err)
 Public: Close file and become inactive.
void ObitTableOTFIndexRowClassInit (void)
 Public: Row Class initializer.
void ObitTableOTFIndexClassInit (void)
 Public: Class initializer.


Detailed Description

ObitTableOTFIndex class function definitions.

This class is derived from the ObitTable class.


Function Documentation

ObitTableOTFIndex* newObitTableOTFIndex gchar *  name  ) 
 

Public: Constructor.

Initializes class if needed on first call.

Parameters:
name An optional name for the object.
Returns:
the new object.

ObitTableOTFIndexRow* newObitTableOTFIndexRow ObitTableOTFIndex table  ) 
 

Public: Constructor.

If table is open and for write, the row is attached to the buffer Initializes Row class if needed on first call.

Parameters:
name An optional name for the object.
Returns:
the new object.

ObitTableOTFIndex* newObitTableOTFIndexValue gchar *  name,
Obit *  file,
glong *  ver,
ObitIOAccess  access,
ObitErr *  err
 

Public: Constructor from values.

Creates a new table structure and attaches to the TableList of file. If the specified table already exists then it is returned. Initializes class if needed on first call. Forces an update of any disk resident structures (e.g. AIPS header).

Parameters:
name An optional name for the object.
file ObitData which which the table is to be associated.
ver Table version number. 0=> add higher, value used returned
access access (OBIT_IO_ReadOnly, means do not create if it doesn't exist.
err Error stack, returns if not empty.
Returns:
the new object, NULL on failure.

void ObitTableOTFIndexClassInit void   ) 
 

Public: Class initializer.

void ObitTableOTFIndexClear gpointer  inn  ) 
 

Private: Deallocate members.

Does (recursive) deallocation of parent class members. For some reason this wasn't build into the GType class.

Parameters:
inn Pointer to the object to deallocate. Actually it should be an ObitTableOTFIndex* cast to an Obit*.

ObitIOCode ObitTableOTFIndexClose ObitTableOTFIndex in,
ObitErr *  err
 

Public: Close file and become inactive.

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

ObitTableOTFIndex* ObitTableOTFIndexConvert ObitTable *  in  ) 
 

Public: Convert an ObitTable to an ObitTableOTFIndex.

New object will have references to members of in.

Parameters:
in The object to copy, will still exist afterwards and should be Unrefed if not needed.
Returns:
pointer to the new object.

ObitTableOTFIndex* ObitTableOTFIndexCopy ObitTableOTFIndex in,
ObitTableOTFIndex out,
ObitErr *  err
 

Public: Copy (deep) constructor.

Copies are made of complex members including disk files; these will be copied applying whatever selection is associated with the input. Objects should be closed on input and will be closed on output. In order for the disk file structures to be copied, the output file must be sufficiently defined that it can be written. The copy will be attempted but no errors will be logged until both input and output have been successfully opened. ObitInfoList and ObitThread members are only copied if the output object didn't previously exist. 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 Error stack, returns if not empty.
Returns:
pointer to the new object.

gconstpointer ObitTableOTFIndexGetClass void   ) 
 

Public: ClassInfo pointer.

Returns:
pointer to the class structure.

void ObitTableOTFIndexInit gpointer  inn  ) 
 

Private: Initialize newly instantiated object.

Parent classes portions are (recursively) initialized first

Parameters:
inn Pointer to the object to initialize.

ObitIOCode ObitTableOTFIndexOpen ObitTableOTFIndex in,
ObitIOAccess  access,
ObitErr *  err
 

Public: Create ObitIO structures and open file.

The image descriptor is read if OBIT_IO_ReadOnly or OBIT_IO_ReadWrite and written to disk if opened OBIT_IO_WriteOnly. After the file has been opened the member, buffer is initialized for reading/storing the table unless member bufferSize is <0. If the requested version ("Ver" in InfoList) is 0 then the highest numbered table of the same type is opened on Read or Read/Write, or a new table is created on on Write. The file etc. info should have been stored in the ObitInfoList:

  • "FileType" OBIT_int scalar = OBIT_IO_FITS for file type (see class documentation for details).
  • "nRowPIO" OBIT_int scalar = Maximum number of table rows per transfer, this is the target size for Reads (may be fewer) and is used to create buffers.
    Parameters:
    in Pointer to object to be opened.
    access access (OBIT_IO_ReadOnly,OBIT_IO_ReadWrite, or OBIT_IO_WriteOnly). If OBIT_IO_WriteOnly any existing data in the output file will be lost.
    err ObitErr for reporting errors.
    Returns:
    return code, OBIT_IO_OK=> OK

ObitIOCode ObitTableOTFIndexReadRow ObitTableOTFIndex in,
glong  iOTFIndexRow,
ObitTableOTFIndexRow row,
ObitErr *  err
 

Public: Read a table row.

Scalar values are copied but for array values, pointers into the data array are returned.

Parameters:
in Table to read
iOTFIndexRow Row number, -1 -> next
row Table Row structure to receive data
err ObitErr for reporting errors.
Returns:
return code, OBIT_IO_OK=> OK

void ObitTableOTFIndexRowClassInit void   ) 
 

Public: Row Class initializer.

void ObitTableOTFIndexRowClear gpointer  inn  ) 
 

Private: Deallocate Row members.

Does (recursive) deallocation of parent class members. For some reason this wasn't build into the GType class.

Parameters:
inn Pointer to the object to deallocate. Actually it should be an ObitTableOTFIndexRow* cast to an Obit*.

gconstpointer ObitTableOTFIndexRowGetClass void   ) 
 

Public: ClassInfo pointer.

Returns:
pointer to the Row class structure.

void ObitTableOTFIndexRowInit gpointer  inn  ) 
 

Private: Initialize newly instantiated Row object.

Parent classes portions are (recursively) initialized first

Parameters:
inn Pointer to the object to initialize.

void ObitTableOTFIndexSetRow ObitTableOTFIndex in,
ObitTableOTFIndexRow row,
ObitErr *  err
 

Public: Init a table row for write.

This is only useful prior to filling a row structure in preparation . for a WriteRow operation. Array members of the Row structure are . pointers to independently allocated memory, this routine allows using . the table IO buffer instead of allocating yet more memory.. This routine need only be called once to initialize a Row structure for write..

Parameters:
in Table with buffer to be written
row Table Row structure to attach
err ObitErr for reporting errors.

ObitIOCode ObitTableOTFIndexWriteRow ObitTableOTFIndex in,
glong  iOTFIndexRow,
ObitTableOTFIndexRow row,
ObitErr *  err
 

Public: Write a table row.

Before calling this routine, the row structure needs to be initialized and filled with data. The array members of the row structure are pointers to independently allocated memory. These pointers can be set to the correct table buffer locations using ObitTableOTFIndexSetRow

Parameters:
in Table to read
iOTFIndexRow Row number, -1 -> next
row Table Row structure containing data
err ObitErr for reporting errors.
Returns:
return code, OBIT_IO_OK=> OK


Generated on Mon Sep 3 20:43:54 2007 by  doxygen 1.3.9.1