throw error if pointers do not exist and add header card access

knodlseder
1 parent 1eb6a5c9
Showing 5 changed files with 132 additions and 21 deletions
include/GException.hpp
include/GFitsHDU.hpp
src/GException.cpp
src/fits/GFitsHDU.cpp
src/fits/GFitsHeader.cpp
@@ -160,6 +160,12 @@ public:
         fits_column_not_found(string origin, string colname, int status = 0);
     };
  
+    // FITS has no header
+    class fits_no_header : public GExceptionHandler {
+    public:
+        fits_no_header(string origin, string message, int status = 0);
+    };
+
     // FITS has no data
     class fits_no_data : public GExceptionHandler {
     public:
@@ -61,15 +61,17 @@ public:
     GFitsHDU& operator= (const GFitsHDU& hdu);
  
     // Methods
-    std::string    extname(void) const;
-    void           extname(const std::string& extname);
-    int            extno(void) const;
-    int            exttype(void) const;
-    GFitsHeader*   header(void) const;
-    GFitsData*     data(void) const;
-    GFitsTableCol* column(const std::string& colname) const;
-    GFitsTableCol* column(const int& colnum) const;
-    void           primary(void);
+    std::string      extname(void) const;
+    void             extname(const std::string& extname);
+    int              extno(void) const;
+    int              exttype(void) const;
+    GFitsHeader*     header(void) const;
+    GFitsData*       data(void) const;
+    GFitsHeaderCard* card(const std::string& keyname) const;
+    GFitsHeaderCard* card(const int& cardno) const;
+    GFitsTableCol*   column(const std::string& colname) const;
+    GFitsTableCol*   column(const int& colnum) const;
+    void             primary(void);
  
 private:
     // Private methods
@@ -90,14 +92,4 @@ private:
     GFitsData*   m_data;        //!< HDU data
 };
  
-
-/***************************************************************************
- *                              Inline methods                             *
- ***************************************************************************/
-inline std::string  GFitsHDU::extname(void) const { return m_name; }
-inline int          GFitsHDU::extno(void) const { return m_hdunum; }
-inline int          GFitsHDU::exttype(void) const { return m_type; }
-inline GFitsHeader* GFitsHDU::header(void) const { return m_header; }
-inline GFitsData*   GFitsHDU::data(void) const { return m_data; }
-
 #endif /* GFITSHDU_HPP */
@@ -317,6 +317,24 @@ GException::fits_column_not_found::fits_column_not_found(string origin,
  
  
 /***********************************************************************//**
+ * @brief FITS error: No header
+ *
+ * @param[in] origin Method that throws the error.
+ * @param[in] message Error message.
+ * @param[in] status cfitsio status.
+ ***************************************************************************/
+GException::fits_no_header::fits_no_header(string origin,
+                                           string message,
+                                           int    status)
+{
+    m_origin  = origin;
+    m_message = message;
+    if (status != 0)
+        m_message += " (status=" + str(status) + ")";
+}
+
+
+/***********************************************************************//**
  * @brief FITS error: No data
  *
  * @param[in] origin Method that throws the error.
@@ -11,6 +11,11 @@
  *                                                                         *
  * ----------------------------------------------------------------------- *
  ***************************************************************************/
+/**
+ * @file GFitsHDU.cpp
+ * @brief GFitsHDU class implementation.
+ * @author J. Knodlseder
+ */
  
 /* __ Includes ___________________________________________________________ */
 #include <iostream>
@@ -24,6 +29,8 @@
 /* __ Method name definitions ____________________________________________ */
 #define G_OPEN      "GFitsHDU::open(int)"
 #define G_SAVE      "GFitsHDU::save()"
+#define G_HEADER    "GFitsHDU::header()"
+#define G_DATA      "GFitsHDU::data()"
 #define G_COLUMN    "GFitsHDU::column(const std::string&)"
 #define G_NEW_IMAGE "GFitsHDU::new_image()"
  
@@ -256,11 +263,20 @@ GFitsHDU&amp; GFitsHDU::operator= (const GFitsHDU&amp; hdu)
  ==========================================================================*/
  
 /***********************************************************************//**
+ * @brief Get HDU extension name (EXTNAME keyword)
+ ***************************************************************************/
+std::string GFitsHDU::extname(void) const
+{
+    return m_name;
+}
+
+
+/***********************************************************************//**
  * @brief Set HDU extension name (EXTNAME keyword)
  *
  * @param[in] extname Name of HDU
  *
- * This methos sets the extension name of the HDU. The extension name will
+ * This method sets the extension name of the HDU. The extension name will
  * be saved in the 'EXTNAME' header keyword. The header attached to the
  * HDU will be automatically updated by this method.
  ***************************************************************************/
@@ -282,10 +298,89 @@ void GFitsHDU::extname(const std::string&amp; extname)
  
  
 /***********************************************************************//**
+ * @brief Get HDU extension number
+***************************************************************************/
+int GFitsHDU::extno(void) const
+{ 
+    return m_hdunum; 
+}
+
+
+/***********************************************************************//**
+ * @brief Get HDU extension type
+***************************************************************************/
+int GFitsHDU::exttype(void) const
+{
+    return m_type;
+}
+
+
+/***********************************************************************//**
+ * @brief Get pointer to header
+ *
+ * @exception GException::fits_no_header
+ *            No header was found in HDU
+ ***************************************************************************/
+GFitsHeader* GFitsHDU::header(void) const
+{
+    // If no header pointer is available then throw exception
+    if (m_header == NULL)
+        throw GException::fits_no_header(G_HEADER, "No header found");
+
+    // Return header pointer
+    return m_header;
+}
+
+
+/***********************************************************************//**
+ * @brief Get pointer to data
+ *
+ * @exception GException::fits_no_data
+ *            No data was found in HDU
+ ***************************************************************************/
+GFitsData* GFitsHDU::data(void) const
+{
+    // If no header pointer is available then throw exception
+    if (m_data == NULL)
+        throw GException::fits_no_data(G_HEADER, "No data found");
+
+    // Return data pointer
+    return m_data;
+}
+
+
+/***********************************************************************//**
+ * @brief Get pointer to header card
+ *
+ * @param[in] keyname Name of header card
+ ***************************************************************************/
+GFitsHeaderCard* GFitsHDU::card(const std::string& keyname) const
+{
+    return m_header->card(keyname);
+}
+
+
+/***********************************************************************//**
+ * @brief Get pointer to header card
+ *
+ * @param[in] cardno Number of card in header
+ ***************************************************************************/
+GFitsHeaderCard* GFitsHDU::card(const int& cardno) const
+{
+    return m_header->card(cardno);
+}
+
+
+/***********************************************************************//**
  * @brief Return pointer to column of table
  *
  * @param[in] colname Name of FITS table column to be returned
  *
+ * @exception GException::fits_HDU_not_a_table
+ *            HDU is not a table
+ * @exception GException::fits_unknown_HDU_type
+ *            HDU type is not known
+ *
  * If this method is called for an image a 'fits_HDU_not_a_table' exception
  * will be thrown.
  ***************************************************************************/
@@ -189,7 +189,7 @@ GFitsHeaderCard* GFitsHeader::card(const std::string&amp; keyname)
 /***********************************************************************//**
  * @brief Return pointer of header card
  *
- * @param[in] keyname Name of header card
+ * @param[in] cardno Number of card in header
  *
  * Returns a pointer on the header card.
  * If card was not found a 'out_of_range' error will be thrown.