GWcsRegistry.hpp

Go to the documentation of this file.

/***************************************************************************
 *      GWcsRegistry.hpp - World Coordinate Projection registry class      *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2011-2021 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 GWcsRegistry.hpp
 * @brief World Coordinate Projection registry class interface definition
 * @author Juergen Knoedlseder
 */

#ifndef GWCSREGISTRY_HPP
#define GWCSREGISTRY_HPP

/* __ Includes ___________________________________________________________ */
#include <string>
#include "GRegistry.hpp"
#include "GWcs.hpp"


/***********************************************************************//**
 * @class GWcsRegistry
 *
 * @brief Interface definition for the WCS registry class
 *
 * The registry class allows the registration of WCS projections that are not
 * necessarily compiled into the GammaLib. It uses the static members
 * m_number, m_codes, m_names, and m_projections which are allocated globally
 * to keep track of projections that are available throughout all linked
 * libraries. To register a projection it is sufficient to add
 *
 *     const GWcsXXX      g_wcs_XXX_seed;
 *     const GWcsRegistry g_wcs_XXX_registry(&g_wcs_XXX_seed);
 *
 * at the top of the .cpp file of the projection. Here, XXX is a unique
 * code that describes the projection.
 ***************************************************************************/
class GWcsRegistry : public GRegistry {

public:
    // Constructors and destructors
    GWcsRegistry(void);
    explicit GWcsRegistry(const GWcs* wcs);
    GWcsRegistry(const GWcsRegistry& registry);
    virtual ~GWcsRegistry(void);

    // Operators
    GWcsRegistry& operator=(const GWcsRegistry& registry);

    // Methods
    std::string classname(void) const;
    int         size(void) const;
    GWcs*       alloc(const std::string& code) const;
    std::string code(const int& index) const;
    std::string name(const int& index) const;
    std::string print(const GChatter& chatter = NORMAL) const;

protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GWcsRegistry& registry);
    void free_members(void);

private:
    // Private members (the private members have been implement as static
    // methods to avoid the static initialization order fiasco of static
    // members; using static methods we follow the "construct on first use
    // idiom")
    // Number of projections in registry
    static int& number() {
        static int m_number = 0;
        return m_number;
    };
    // Projection codes
    static GRegistryPointer<std::string>& codes() {
        static GRegistryPointer<std::string> m_codes;
        return m_codes;
    };
    // Projection names
    static GRegistryPointer<std::string>& names() {
        static GRegistryPointer<std::string> m_names;
        return m_names;
    };
    // Pointer to seed projections
    static GRegistryPointer<const GWcs*>& projections() {
        static GRegistryPointer<const GWcs*> m_projections;
        return m_projections;
    };
};


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


/***********************************************************************//**
 * @brief Return number of registered models
 *
 * @return Number of registered models.
 *
 * Returns the number of registered model.
 ***************************************************************************/
inline
int GWcsRegistry::size(void) const
{
    return number();
}

#endif /* GWCSREGISTRY_HPP */