Changeset 6767 for trunk/psLib/src/fits/psFitsTable.h

Timestamp:

Apr 4, 2006, 9:52:55 AM (20 years ago)

Author:

desonia

Message:

modified API to match current SDRS.

File:

• trunk/psLib/src/fits/psFitsTable.h (modified) (4 diffs)

trunk/psLib/src/fits/psFitsTable.h

@@ -7 +7 @@
  *  @author Robert DeSonia, MHPCC
  *
- *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-11-14 22:18:30 $
+ *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-04-04 19:52:42 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -72 +72 @@
 );
 
-/** Writes a whole FITS table.  The current HDU type must be either
- *  PS_FITS_TYPE_BINARY_TABLE or PS_FITS_TYPE_ASCII_TABLE.
+/** Writes a whole FITS table. A new HDU of the type BINTABLE is appended
+ *  to the file.
  *
  *  @return bool        TRUE if the write was successful, otherwise FALSE
  *
- *  @see psFitsReadTableRow
+ *  @see psFitsReadTable
+ *  @see psFitsInsertTable
  */
 bool psFitsWriteTable(
@@ -84 +85 @@
     const psArray* table
     ///< Array of psMetadata items, which contains the output data items of each row.
+);
+
+/** Inserts a whole FITS table. A new HDU of the type BINTABLE is inserted either
+ *  before or after, depending on the AFTER parameter, the current HDU.
+ *
+ *  @return bool        TRUE if the insert/write was successful, otherwise FALSE
+ *
+ *  @see psFitsWriteTable
+ */
+bool psFitsInsertTable(
+    psFits* fits,                  ///< the psFits object
+    const psMetadata* header,      ///< header items for the new HDU.  Can be NULL.
+    const psArray* table,
+    ///< Array of psMetadata items, which contains the output data items of each row.
+    bool after
+    ///< TRUE if insert is done after CHDU, otherwise table is inserted before CHDU
 );
 
@@ -94 +111 @@
  */
 bool psFitsUpdateTable(
-    psFits* fits,                ///< the psFits object
+    psFits* fits,                      ///< the psFits object
     const psMetadata* data,
     ///< Array of psMetadata items, which contains the output data items of each row.