GCOSEventAtom.cpp

Go to the documentation of this file.

/***************************************************************************
 *                GCOSEventAtom.cpp - 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.cpp
 * @brief COSI event atom class implementation
 * @author Juergen Knoedlseder
 */
 
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string>
#include "GCOSEventAtom.hpp"
 
/* __ Method name definitions ____________________________________________ */
 
/* __ Macros _____________________________________________________________ */
 
/* __ Coding definitions _________________________________________________ */
 
/* __ Debug definitions __________________________________________________ */
 
 
/*==========================================================================
 =                                                                         =
 =                        Constructors/destructors                         =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Void constructor
 *
 * Creates an empty COSI event atom.
 ***************************************************************************/
GCOSEventAtom::GCOSEventAtom(void) : GEventAtom()
{
    // Initialise class members for clean destruction
    init_members();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Copy constructor
 *
 * @param[in] atom COSI event atom.
 ***************************************************************************/
GCOSEventAtom::GCOSEventAtom(const GCOSEventAtom& atom) : GEventAtom(atom)
{
    // Initialise class members for clean destruction
    init_members();
 
    // Copy members
    copy_members(atom);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Event constructor
 *
 * @param[in] dir COSI instrument direction.
 * @param[in] energy Event energy.
 * @param[in] time Event trigger time.
 *
 * Constructs a COSI event from the instrument direction, event energy and
 * event trigger time.
 ***************************************************************************/
GCOSEventAtom::GCOSEventAtom(const GCOSInstDir& dir,
                             const GEnergy&     energy,
                             const GTime&       time) : GEventAtom()
{
    // Initialise class members for clean destruction
    init_members();
 
    // Set members
    this->dir(dir);
    this->energy(energy);
    this->time(time);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Destructor
 ***************************************************************************/
GCOSEventAtom::~GCOSEventAtom(void)
{
    // Free members
    free_members();
 
    // Return
    return;
}
 
 
/*==========================================================================
 =                                                                         =
 =                                Operators                                =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Assignment operator
 *
 * @param[in] atom COSI event atom.
 * @return COSI event atom.
 ***************************************************************************/
GCOSEventAtom& GCOSEventAtom::operator=(const GCOSEventAtom& atom)
{
    // Execute only if object is not identical
    if (this != &atom) {
 
        // Copy base class members
        this->GEventAtom::operator=(atom);
 
        // Free members
        free_members();
 
        // Initialise private members for clean destruction
        init_members();
 
        // Copy members
        copy_members(atom);
 
    } // endif: object was not identical
 
    // Return this object
    return *this;
}
 
 
/*==========================================================================
 =                                                                         =
 =                            Public methods                               =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Clear event atom
 *
 * Clears COSI event atom by resetting all class members to an
 * initial state. Any information that was present before will be lost.
 ***************************************************************************/
void GCOSEventAtom::clear(void)
{
    // Free class members (base and derived classes, derived class first)
    free_members();
    this->GEventAtom::free_members();
    this->GEvent::free_members();
 
    // Initialise members
    this->GEvent::init_members();
    this->GEventAtom::init_members();
    init_members();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Clone event atom
 *
 * @return Pointer to deep copy of COSI event atom.
 ***************************************************************************/
GCOSEventAtom* GCOSEventAtom::clone(void) const
{
    return new GCOSEventAtom(*this);
}
 
 
/***********************************************************************//**
 * @brief Print event information
 *
 * @param[in] chatter Chattiness.
 * @return String containing event information.
 ***************************************************************************/
std::string GCOSEventAtom::print(const GChatter& chatter) const
{
    // Initialise result string
    std::string result;
 
    // Continue only if chatter is not silent
    if (chatter != SILENT) {
 
        // Append event attributes
        result.append("Dir="+m_dir.print(gammalib::reduce(chatter)));
        result.append(" Energy="+m_energy.print(gammalib::reduce(chatter)));
        result.append(" Time="+m_time.print(gammalib::reduce(chatter)));
 
    } // endif: chatter was not silent
 
    // Return result
    return result;
}
 
 
/*==========================================================================
 =                                                                         =
 =                            Private methods                              =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Initialise class members
 ***************************************************************************/
void GCOSEventAtom::init_members(void)
{
    // Initialise members
    m_dir.clear();
    m_time.clear();
    m_energy.clear();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Copy class members
 *
 * @param[in] atom COSI event atom.
 ***************************************************************************/
void GCOSEventAtom::copy_members(const GCOSEventAtom& atom)
{
    // Copy members
    m_dir    = atom.m_dir;
    m_time   = atom.m_time;
    m_energy = atom.m_energy;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Delete class members
 ***************************************************************************/
void GCOSEventAtom::free_members(void)
{
    // Return
    return;
}