Add ctool::get_obs_header() method.

Jürgen Knödlseder
1 parent 0847394c
Showing 3 changed files with 41 additions and 5 deletions
pyext/ctool.i
src/support/ctool.cpp
src/support/ctool.hpp
@@ -99,6 +99,7 @@ public:
     %rename(_set_obs_bounds)       set_obs_bounds(GObservations& obs);
     %rename(_get_mean_pointing)    get_mean_pointing(const GObservations& obs);
     %rename(_get_current_rss)      get_current_rss();
+    %rename(_get_obs_header)       get_obs_header();
     // Protected methods
     const bool&           read_ahead(void) const;
@@ -122,6 +123,7 @@ public:
     void            set_obs_bounds(GObservations& obs);
     GSkyDir         get_mean_pointing(const GObservations& obs);
     size_t          get_current_rss(void);
+    std::string     get_obs_header(const GObservation* obs);
 };
@@ -1108,6 +1108,39 @@ size_t ctool::get_current_rss(void)
 /***********************************************************************//**
+ * @brief Return observation header string
+ *
+ * @param[in] obs Pointer to observation.
+ * @return String containing observation information.
+ *
+ * Returns a string that contains observation information, including the
+ * instrument name, the observation name, and the observation ID. The format
+ * of the string is
+ *
+ *      XXX observation "name" (id=YYYYY)
+ *
+ ***************************************************************************/
+std::string ctool::get_obs_header(const GObservation* obs)
+{
+    // Initialise header string
+    std::string header = obs->instrument() + " observation";
+
+    // If observation name is not empty then add name
+    if (!obs->name().empty()) {
+        header += " \"" + obs->name() + "\"";
+    }
+
+    // If observation ID is not empty then add ID
+    if (!obs->id().empty()) {
+        header += " (id=" + obs->id() +")";
+    }
+
+    // Return header
+    return header;
+}
+
+
+/***********************************************************************//**
  * @brief Dumps help text in the console
  ***************************************************************************/
 void ctool::provide_help(void) const
 /***************************************************************************
  *                        ctool - ctool base class                         *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2014-2015 by Juergen Knoedlseder                         *
+ *  copyright (C) 2014-2016 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -90,17 +90,18 @@ protected:
     void            set_obs_bounds(GObservations& obs);
     GSkyDir         get_mean_pointing(const GObservations& obs);
     size_t          get_current_rss(void);
+    std::string     get_obs_header(const GObservation* obs);
     // Protected members
-    bool            m_read_ahead; //!< Read ahead parameters
+    bool            m_read_ahead; //!< Read ahead output parameters
 protected:
     // Protected methods
-    void           provide_help(void) const;
+    void            provide_help(void) const;
     // Protected members
-    bool           m_use_xml;    //!< Use XML file instead of FITS file for observations
-    GTimeReference m_cta_ref;    //!< CTA time reference
+    bool            m_use_xml;  //!< Use XML file instead of FITS file for observations
+    GTimeReference  m_cta_ref;  //!< CTA time reference
 };