GModelSpatialDiffuse.i 3.35 KB
/***************************************************************************
 *    GModelSpatialDiffuse.i - Abstract diffuse spatial model base class   *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2013-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 GModelSpatialDiffuse.i
 * @brief Abstract diffuse spatial model base class interface definition
 * @author Juergen Knoedlseder
 */
%{
/* Put headers and other declarations here that are needed for compilation */
#include "GModelSpatialDiffuse.hpp"
%}


/***********************************************************************//**
 * @class GModelSpatialDiffuse
 *
 * @brief Abstract diffuse spatial model base class
 ***************************************************************************/
class GModelSpatialDiffuse : public GModelSpatial {
public:
    // Constructors and destructors
    GModelSpatialDiffuse(void);
    GModelSpatialDiffuse(const GModelSpatialDiffuse& model);
    virtual ~GModelSpatialDiffuse(void);

    // Pure virtual base class methods
    virtual void                  clear(void) = 0;
    virtual GModelSpatialDiffuse* clone(void) const = 0;
    virtual std::string           classname(void) const = 0;
    virtual double                eval(const GPhoton& photon,
                                       const bool& gradients = false) const = 0;
    virtual GSkyDir               mc(const GEnergy& energy, const GTime& time,
                                     GRan& ran) const = 0;
    virtual double                mc_norm(const GSkyDir& dir,
                                          const double&  radius) const = 0;
    virtual bool                  contains(const GSkyDir& dir,
                                           const double&  margin = 0.0) const = 0;
    virtual void                  read(const GXmlElement& xml) = 0;
    virtual void                  write(GXmlElement& xml) const = 0;
};


/***********************************************************************//**
 * @brief GModelSpatialDiffuse class extension
 ***************************************************************************/
%extend GModelSpatialDiffuse {
};