GCOSPointing.hpp

Go to the documentation of this file.

/***************************************************************************
 *                 GCOSPointing.hpp - 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.hpp
 * @brief COSI pointing class definition
 * @author Juergen Knoedlseder
 */
 
#ifndef GCOSPOINTING_HPP
#define GCOSPOINTING_HPP
 
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
#include "GTime.hpp"
#include "GSkyDir.hpp"
 
/* __ Forward declaration ________________________________________________ */
 
/* __ Constants __________________________________________________________ */
 
 
/***********************************************************************//**
 * @class GCOSPointing
 *
 * @brief COSI pointing class
 *
 * The COSI pointing class provides spacecraft attitude information for a
 * given time tag.
 ***************************************************************************/
class GCOSPointing : public GBase {
 
public:
    // Constructors and destructors
    GCOSPointing(void);
    GCOSPointing(const GCOSPointing& pointing);
    virtual ~GCOSPointing(void);
 
    // Operators
    GCOSPointing& operator=(const GCOSPointing& pointing);
 
    // Class methods
    void           clear(void);
    GCOSPointing*  clone(void) const;
    std::string    classname(void) const;
    const GTime&   time(void) const;
    const GSkyDir& sc_x(void) const;
    const GSkyDir& sc_z(void) const;
    const double&  altitude(void) const;
    const GSkyDir& earth_zenith(void) const;
    const GSkyDir& earth_nadir(void) const;
    const double&  livetime(void) const;
    void           time(const GTime& time);
    void           sc_x(const GSkyDir& sc_x);
    void           sc_z(const GSkyDir& sc_z);
    void           altitude(const double& altitude);
    void           earth_zenith(const GSkyDir& earth_zenith);
    void           earth_nadir(const GSkyDir& earth_nadir);
    void           livetime(const double& livetime);
    std::string    print(const GChatter& chatter = NORMAL) const;
 
protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GCOSPointing& pointing);
    void free_members(void);
 
    // Protected members
    GTime   m_time;         //!< Time stamp in UNIX seconds
    GSkyDir m_sc_x;         //!< Space craft x-axis
    GSkyDir m_sc_z;         //!< Space craft z-axis
    double  m_altitude;     //!< Altitude above from Earth's ellipsoid (km)
    GSkyDir m_earth_zenith; //!< Direction of Earth's zenith at SC location
    GSkyDir m_earth_nadir;  //!< Direction of Earth's nadir at SC location
    double  m_livetime;     //!< Lifetime (sec)
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOSPointing").
 ***************************************************************************/
inline
std::string GCOSPointing::classname(void) const
{
    return ("GCOSPointing");
}
 
 
/***********************************************************************//**
 * @brief Return time stamp
 *
 * @return Time stamp.
 ***************************************************************************/
inline
const GTime& GCOSPointing::time(void) const
{
    return (m_time);
}
 
 
/***********************************************************************//**
 * @brief Return space craft X-axis
 *
 * @return Space craft X-axis.
 ***************************************************************************/
inline
const GSkyDir& GCOSPointing::sc_x(void) const
{
    return (m_sc_x);
}
 
 
/***********************************************************************//**
 * @brief Return space craft Z-axis
 *
 * @return Space craft Z-axis.
 ***************************************************************************/
inline
const GSkyDir& GCOSPointing::sc_z(void) const
{
    return (m_sc_z);
}
 
 
/***********************************************************************//**
 * @brief Return space craft altitude in km
 *
 * @return Space craft altitude (km).
 ***************************************************************************/
inline
const double& GCOSPointing::altitude(void) const
{
    return (m_altitude);
}
 
 
/***********************************************************************//**
 * @brief Return direction of Earth's zenith at space craft location
 *
 * @return Earth's zenith direction.
 ***************************************************************************/
inline
const GSkyDir& GCOSPointing::earth_zenith(void) const
{
    return (m_earth_zenith);
}
 
 
/***********************************************************************//**
 * @brief Return direction of Earth's nadir at space craft location
 *
 * @return Earth's nadir direction.
 ***************************************************************************/
inline
const GSkyDir& GCOSPointing::earth_nadir(void) const
{
    return (m_earth_nadir);
}
 
 
/***********************************************************************//**
 * @brief Return livetime
 *
 * @return Livetime (sec).
 ***************************************************************************/
inline
const double& GCOSPointing::livetime(void) const
{
    return (m_livetime);
}
 
 
/***********************************************************************//**
 * @brief Set time stamp
 *
 * @param[in] time Time stamp.
 ***************************************************************************/
inline
void GCOSPointing::time(const GTime& time)
{
    m_time = time;
    return;
}
 
 
/***********************************************************************//**
 * @brief Set space craft X-axis
 *
 * @param[in] sc_x Space craft X-axis.
 ***************************************************************************/
inline
void GCOSPointing::sc_x(const GSkyDir& sc_x)
{
    m_sc_x = sc_x;
    return;
}
 
 
/***********************************************************************//**
 * @brief Set space craft Z-axis
 *
 * @param[in] sc_z Space craft Z-axis.
 ***************************************************************************/
inline
void GCOSPointing::sc_z(const GSkyDir& sc_z)
{
    m_sc_z = sc_z;
    return;
}
 
 
/***********************************************************************//**
 * @brief Set space craft altitude (km)
 *
 * @param[in] altitude Space craft altitude (km).
 ***************************************************************************/
inline
void GCOSPointing::altitude(const double& altitude)
{
    m_altitude = altitude;
    return;
}
 
 
/***********************************************************************//**
 * @brief Set direction Earth's zenith at space craft location
 *
 * @param[in] earth_zenith Earth's zenith direction.
 ***************************************************************************/
inline
void GCOSPointing::earth_zenith(const GSkyDir& earth_zenith)
{
    m_earth_zenith = earth_zenith;
    return;
}
 
 
/***********************************************************************//**
 * @brief Set direction Earth's nadir at space craft location
 *
 * @param[in] earth_nadir Earth's nadir direction.
 ***************************************************************************/
inline
void GCOSPointing::earth_nadir(const GSkyDir& earth_nadir)
{
    m_earth_nadir = earth_nadir;
    return;
}
 
 
/***********************************************************************//**
 * @brief Set livetime
 *
 * @param[in] livetime Livetime (sec).
 ***************************************************************************/
inline
void GCOSPointing::livetime(const double& livetime)
{
    m_livetime = livetime;
    return;
}
 
#endif /* GCOSSPACECRAFT_HPP */