GCOSEventAtom.hpp

Go to the documentation of this file.

/***************************************************************************
 *                GCOSEventAtom.hpp - COSI event atom class                *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2026 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 GCOSEventAtom.hpp
 * @brief COSI event atom class definition
 * @author Juergen Knoedlseder
 */
 
#ifndef GCOSEVENTATOM_HPP
#define GCOSEVENTATOM_HPP
 
/* __ Includes ___________________________________________________________ */
#include <iostream>
#include "GEventAtom.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
#include "GCOSInstDir.hpp"
 
/* __ Forward declarations _______________________________________________ */
 
/* __ Constants __________________________________________________________ */
 
 
/***********************************************************************//**
 * @class GCOSEventAtom
 *
 * @brief COSI event atom class
 ***************************************************************************/
class GCOSEventAtom : public GEventAtom {
 
    // Operator friends
    friend bool operator<(const GCOSEventAtom& a, const GCOSEventAtom& b);
 
public:
    // Constructors and destructors
    GCOSEventAtom(void);
    GCOSEventAtom(const GCOSEventAtom& atom);
    GCOSEventAtom(const GCOSInstDir& dir, const GEnergy& energy, const GTime& time);
    virtual ~GCOSEventAtom(void);
 
    // Operators
    GCOSEventAtom& operator=(const GCOSEventAtom& atom);
 
    // Implemented pure virtual base class methods
    void               clear(void);
    GCOSEventAtom*     clone(void) const;
    std::string        classname(void) const;
    const GCOSInstDir& dir(void) const;
    const GEnergy&     energy(void) const;
    const GTime&       time(void) const;
    std::string        print(const GChatter& chatter = NORMAL) const;
 
    // Other methods
    void dir(const GCOSInstDir& dir);
    void energy(const GEnergy& energy);
    void time(const GTime& time);
 
protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GCOSEventAtom& atom);
    void free_members(void);
 
    // Protected members
    GCOSInstDir m_dir;    //!< Event direction
    GEnergy     m_energy; //!< Event energy
    GTime       m_time;   //!< Event time
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOSEventAtom").
 ***************************************************************************/
inline
std::string GCOSEventAtom::classname(void) const
{
    return ("GCOSEventAtom");
}
 
 
/***********************************************************************//**
 * @brief Return event instrument direction
 *
 * @return Event instrument direction.
 *
 * Returns the instrument direction of the event. The instrument direction
 * is the event location in the three-dimensional COSI data space, spanned
 * by the scattering angles Chi and Psi and the Compton scatter angle Phi.
 ***************************************************************************/
inline
const GCOSInstDir& GCOSEventAtom::dir(void) const
{
    return (m_dir);
}
 
 
/***********************************************************************//**
 * @brief Set event instrument direction
 *
 * @param[in] dir Event instrument direction.
 *
 * Sets the event instrument direction.
 ***************************************************************************/
inline
void GCOSEventAtom::dir(const GCOSInstDir& dir)
{
    m_dir = dir;
    return;
}
 
 
/***********************************************************************//**
 * @brief Return event energy
 *
 * @return Event energy.
 *
 * Returns the measured energy of the photon on the sky.
 ***************************************************************************/
inline
const GEnergy& GCOSEventAtom::energy(void) const
{
    return (m_energy);
}
 
 
/***********************************************************************//**
 * @brief Set event energy
 *
 * @param[in] energy Event energy.
 *
 * Sets the event energy.
 ***************************************************************************/
inline
void GCOSEventAtom::energy(const GEnergy& energy)
{
    m_energy = energy;
    return;
}
 
 
/***********************************************************************//**
 * @brief Return event time
 *
 * @return Event time.
 *
 * Returns the event triggering time.
 ***************************************************************************/
inline
const GTime& GCOSEventAtom::time(void) const
{
    return (m_time);
}
 
 
/***********************************************************************//**
 * @brief Set event time
 *
 * @param[in] time Event time.
 *
 * Sets the event time.
 ***************************************************************************/
inline
void GCOSEventAtom::time(const GTime& time)
{
    m_time = time;
    return;
}
 
 
/***********************************************************************//**
 * @brief Check if time of one event atom is smaller than time of another
 * event atom
 *
 * @param[in] a First event atom.
 * @param[in] b Second event atom.
 * @return True if time of @p a is smaller than time of @p b.
 ***************************************************************************/
inline
bool operator<(const GCOSEventAtom& a, const GCOSEventAtom& b)
{
    return (a.time() < b.time());
}
 
#endif /* GCOSEVENTATOM_HPP */