GCaldb.hpp

Go to the documentation of this file.

/***************************************************************************
 *                 GCaldb.hpp - Calibration database class                 *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2011-2016 by Juergen Knoedlseder                         *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  This program is free software: you can redistribute it and/or modify   *
 *  it under the terms of the GNU General Public License as published by   *
 *  the Free Software Foundation, either version 3 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  This program is distributed in the hope that it will be useful,        *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
 *  GNU General Public License for more details.                           *
 *                                                                         *
 *  You should have received a copy of the GNU General Public License      *
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.  *
 *                                                                         *
 ***************************************************************************/
/**
 * @file GCaldb.hpp
 * @brief Calibration database class interface definition
 * @author Juergen Knoedlseder
 */

#ifndef GCALDB_HPP
#define GCALDB_HPP

/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
#include "GFits.hpp"
#include "GFitsTable.hpp"
#include "GFilename.hpp"


/***********************************************************************//**
 * @class GCaldb
 *
 * @brief Calibration database class
 *
 * This class holds the definition of a calibration database. The
 * calibration database is located in a root directory that can be set using
 * the GCaldb::rootdir method. If no root directory is set, GCaldb will take
 * the directory path from the CALDB environment variable, which is mandatory
 * in case that no root directory has been set.
 *
 * It is assumed that the calibration data are found under
 *
 *     $CALDB/data/<mission>[/<instrument>]
 *
 * and that the Calibration Index File (CIF) is located at
 *
 *     $CALDB/data/<mission>[/<instrument>]/caldb.indx
 *
 * where <mission> is the name of the mission and <instrument> is the
 * optional instrument name (all lower case). If the root directory has been
 * set using the GCaldb::rootdir method, $CALDB is replaced by the root
 * directory name.
 *
 * The calibration database for a given mission and instrument is opened
 * using the open() method. Once opened, database information can be
 * accessed. After usage, the database is closed using the close() method.
 ***************************************************************************/
class GCaldb : public GBase {

public:
    // Constructors and destructors
    GCaldb(void);
    GCaldb(const GCaldb& caldb);
    explicit GCaldb(const std::string& pathname);
    GCaldb(const std::string& mission, const std::string& instrument);
    virtual ~GCaldb(void);

    // Operators
    GCaldb& operator=(const GCaldb& caldb);

    // Methods
    void               clear(void);
    GCaldb*            clone(void) const;
    std::string        classname(void) const;
    int                size(void) const;
    std::string        rootdir(void) const;
    void               rootdir(const std::string& pathname);
    std::string        path(const std::string& mission,
                            const std::string& instrument = "");
    std::string        cifname(const std::string& mission,
                               const std::string& instrument = "");
    void               open(const std::string& mission,
                            const std::string& instrument = "");
    void               close(void);
    GFilename          filename(const std::string& detector,
                                const std::string& filter,
                                const std::string& codename,
                                const std::string& date,
                                const std::string& time,
                                const std::string& expr);
    const std::string& mission(void) const;
    const std::string& instrument(void) const;
    std::string        print(const GChatter& chatter = NORMAL) const;

protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GCaldb& caldb);
    void free_members(void);

    // Protected data area
    std::string m_opt_rootdir;  //!< Optional root directory
    std::string m_mission;      //!< Mission of opened database
    std::string m_instrument;   //!< Instrument of opened database
    std::string m_cifname;      //!< CIF filename of opened database
    GFits       m_fits;         //!< CIF FITS file
    GFitsTable* m_cif;          //!< Pointer to CIF table
};


/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCaldb").
 ***************************************************************************/
inline
std::string GCaldb::classname(void) const
{
    return ("GCaldb");
}


/***********************************************************************//**
 * @brief Return mission
 *
 * @return String containing the mission.
 ***************************************************************************/
inline
const std::string& GCaldb::mission(void) const
{
    return (m_mission);
}


/***********************************************************************//**
 * @brief Return instrument
 *
 * @return String containing the instrument.
 ***************************************************************************/
inline
const std::string& GCaldb::instrument(void) const
{
    return (m_instrument);
}

#endif /* GCALDB_HPP */