GCOSPointing.cpp

Go to the documentation of this file.

/***************************************************************************
 *                 GCOSPointing.cpp - COSI pointing 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 GCOSPointing.cpp
 * @brief COSI pointing class implementation
 * @author Juergen Knoedlseder
 */
 
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GCOSPointing.hpp"
 
/* __ Method name definitions ____________________________________________ */
 
/* __ Macros _____________________________________________________________ */
 
/* __ Coding definitions _________________________________________________ */
 
/* __ Debug definitions __________________________________________________ */
 
 
 
/*==========================================================================
 =                                                                         =
 =                         Constructors/destructors                        =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Void constructor
 ***************************************************************************/
GCOSPointing::GCOSPointing(void)
{
    // Initialise class members
    init_members();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Copy constructor
 *
 * @param[in] pointing COSI pointing.
 ***************************************************************************/
GCOSPointing::GCOSPointing(const GCOSPointing& pointing)
{
    // Initialise class members
    init_members();
 
    // Copy members
    copy_members(pointing);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Destructor
 ***************************************************************************/
GCOSPointing::~GCOSPointing(void)
{
    // Free members
    free_members();
 
    // Return
    return;
}
 
 
/*==========================================================================
 =                                                                         =
 =                               Operators                                 =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Assignment operator
 *
 * @param[in] pointing COSI pointing.
 * @return COSI pointing.
 ***************************************************************************/
GCOSPointing& GCOSPointing::operator=(const GCOSPointing& pointing)
{
    // Execute only if object is not identical
    if (this != &pointing) {
 
        // Free members
        free_members();
 
        // Initialise private members
        init_members();
 
        // Copy members
        copy_members(pointing);
 
    } // endif: object was not identical
 
    // Return this object
    return *this;
}
 
 
/*==========================================================================
 =                                                                         =
 =                             Public methods                              =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Clear pointing
 ***************************************************************************/
void GCOSPointing::clear(void)
{
    // Free members
    free_members();
 
    // Initialise private members
    init_members();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Clone COSI pointing
 *
 * @return Pointer to deep copy of COSI pointing.
 ***************************************************************************/
GCOSPointing* GCOSPointing::clone(void) const
{
    return new GCOSPointing(*this);
}
 
 
/***********************************************************************//**
 * @brief Print pointing information
 *
 * @param[in] chatter Chattiness.
 * @return String containing pointing information.
 ***************************************************************************/
std::string GCOSPointing::print(const GChatter& chatter) const
{
    // Initialise result string
    std::string result;
 
    // Continue only if chatter is not silent
    if (chatter != SILENT) {
 
        // Append header
        result.append("=== GCOSPointing ===");
 
        // Append information
        result.append("\n"+gammalib::parformat("Time stamp"));
        result.append(m_time.print(gammalib::reduce(chatter)));
        result.append("\n"+gammalib::parformat("Space craft x-axis"));
        result.append(m_sc_x.print(gammalib::reduce(chatter)));
        result.append("\n"+gammalib::parformat("Space craft z-axis"));
        result.append(m_sc_z.print(gammalib::reduce(chatter)));
        result.append("\n"+gammalib::parformat("Space craft altitude"));
        result.append(gammalib::str(m_altitude) + " km");
        result.append("\n"+gammalib::parformat("Earth zenith direction"));
        result.append(m_earth_zenith.print(gammalib::reduce(chatter)));
 
    } // endif: chatter was not silent
 
    // Return result
    return result;
}
 
 
/*==========================================================================
 =                                                                         =
 =                             Private methods                             =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Initialise class members
 ***************************************************************************/
void GCOSPointing::init_members(void)
{
    // Initialise members
    m_time.clear();
    m_sc_x.clear();
    m_sc_z.clear();
    m_altitude = 0.0;
    m_earth_zenith.clear();
    m_earth_nadir.clear();
    m_livetime = 0.0;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Copy class members
 *
 * @param[in] pointing COSI pointing.
 ***************************************************************************/
void GCOSPointing::copy_members(const GCOSPointing& pointing)
{
    // Copy members
    m_time         = pointing.m_time;
    m_sc_x         = pointing.m_sc_x;
    m_sc_z         = pointing.m_sc_z;
    m_altitude     = pointing.m_altitude;
    m_earth_zenith = pointing.m_earth_zenith;
    m_earth_nadir  = pointing.m_earth_nadir;
    m_livetime     = pointing.m_livetime;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Delete class members
 ***************************************************************************/
void GCOSPointing::free_members(void)
{
    // Return
    return;
}