GResponseCache.hpp

Go to the documentation of this file.

/***************************************************************************
 *               GResponseCache.hpp - Response cache class                 *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2020 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 GResponseCache.hpp
 * @brief Response cache class definition
 * @author Juergen Knoedlseder
 */

#ifndef GRESPONSECACHE_HPP
#define GRESPONSECACHE_HPP

/* __ Includes ___________________________________________________________ */
#include <string>
#include <sys/types.h>
#if defined(__sun) && (defined(__svr4__) || defined(__SVR4)) // SOLARIS
    typedef uint64_t u_int64_t;
#endif // SOLARIS
#include <map>
#include "GBase.hpp"
#include "GEnergy.hpp"

/* __ Forward declarations _______________________________________________ */
class GInstDir;

/* __ Constants __________________________________________________________ */

/* __ Typedefs ___________________________________________________________ */
typedef std::map<u_int64_t,double>                 GResponseCacheDir;
typedef std::map<u_int64_t,GResponseCacheDir>      GResponseCacheEnergy;
typedef std::map<std::string,GResponseCacheEnergy> GResponseCacheName;


/***********************************************************************//**
 * @class GResponseCache
 *
 * @brief Response cache class
 *
 * The class implements a cache for the Instrument Response Function values
 * so that the values do not need to be recomputed each time but can be
 * fetched from the cache.
 ***************************************************************************/
class GResponseCache : public GBase {

public:
    // Constructors and destructors
    GResponseCache(void);
    GResponseCache(const GResponseCache& cache);
    virtual ~GResponseCache(void);

    // Operators
    GResponseCache& operator=(const GResponseCache& cache);

    // Methods
    void            clear(void);
    GResponseCache* clone(void) const;
    std::string     classname(void) const;
    bool            is_empty(void) const;
    int             size(void) const;
    int             nenergies(void) const;
    void            set(const std::string& name,
                        const GEnergy&     ereco,
                        const GEnergy&     etrue,
                        const double&      value);
    void            set(const std::string& name,
                        const GInstDir&    dir,
                        const GEnergy&     ereco,
                        const GEnergy&     etrue,
                        const double&      value);
    void            remove(const std::string& name);
    bool            contains(const std::string& name,
                             const GEnergy&     ereco,
                             const GEnergy&     etrue,
                             double*            value = NULL) const;
    bool            contains(const std::string& name,
                             const GInstDir&    dir,
                             const GEnergy&     ereco,
                             const GEnergy&     etrue,
                             double*            value = NULL) const;
    std::string     print(const GChatter& chatter = NORMAL) const;

protected:
    // Protected methods
    void      init_members(void);
    void      copy_members(const GResponseCache& cache);
    void      free_members(void);
    u_int64_t hash(const GEnergy&  ereco, const GEnergy&  etrue) const;

    // Protected members
    GResponseCacheName m_cache;   //<! Response cache
};


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


/***********************************************************************//**
 * @brief Checks whether the cache is empty
 *
 * @return True if cache is empty, false otherwise.
 *
 * Checks whether the response cache is empty.
 ***************************************************************************/
inline
bool GResponseCache::is_empty(void) const
{
    return (m_cache.empty());
}


/***********************************************************************//**
 * @brief Remove cache for source
 *
 * @param[in] name Source name.
 *
 * Remove cache for source with @p name.
 ***************************************************************************/
inline
void GResponseCache::remove(const std::string& name)
{
    m_cache.erase(name);
    return;
}

#endif /* GRESPONSECACHE_HPP */