GPhotons.hpp

Go to the documentation of this file.

/***************************************************************************
 *                   GPhotons.hpp - Photon container class                 *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2012-2015 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 GPhotons.hpp
 * @brief Photon container class definition
 * @author Juergen Knoedlseder
 */

#ifndef GPHOTONS_HPP
#define GPHOTONS_HPP

/* __ Includes ___________________________________________________________ */
#include <string>
#include "GContainer.hpp"
#include "GPhoton.hpp"


/***********************************************************************//**
 * @class GPhotons
 *
 * @brief Photon container class
 *
 * This class is a container for photons. Photons are implemented by the
 * GPhoton class which stores the physical attributes of a photon such as the
 * photon arrival direction, its energy and its arrival time. 
 ***************************************************************************/
class GPhotons : public GContainer {

public:
    // Constructors and destructors
    GPhotons(void);
    GPhotons(const GPhotons& photons);
    virtual ~GPhotons(void);
 
    // Operators
    GPhotons&      operator=(const GPhotons& photons);
    GPhoton&       operator[](const int& index);
    const GPhoton& operator[](const int& index) const;

    // Methods
    void           clear(void);
    GPhotons*      clone(void) const;
    std::string    classname(void) const;
    int            size(void) const;
    bool           is_empty(void) const;
    void           append(const GPhoton& photon);
    void           insert(const int& index, const GPhoton& photon);
    void           remove(const int& index);
    void           reserve(const int& num);
    void           extend(const GPhotons& photons);
    std::string    print(const GChatter& chatter = NORMAL) const;
  
protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GPhotons& photons);
    void free_members(void);

    // Protected data members
    std::vector<GPhoton> m_photons;  //!< List of photons
};


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


/***********************************************************************//**
 * @brief Return number of photons
 *
 * @return Number of photons.
 ***************************************************************************/
inline
int GPhotons::size(void) const
{
    return (int)m_photons.size();
}


/***********************************************************************//**
 * @brief Signal if there are no photons
 *
 * @return True if there are no photons.
 ***************************************************************************/
inline
bool GPhotons::is_empty(void) const
{
    return m_photons.empty();
}

#endif /* GPHOTONS_HPP */