gSatWrapper.hpp

/***************************************************************************
 * Name: gSatStelWrapper.hpp
 *
 * Description: Wrapper over gSatTEME class.
 *              This class allow use Satellite orbit calculation module (gSAt) in
 *              Stellarium 'native' mode using Stellarium objects.
 *
 ***************************************************************************/
/***************************************************************************
 *   Copyright (C) 2006 by J.L. Canales                                    *
 *   jlcanales.gasco@gmail.com                                  *
 *                                                                         *
 *   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 2 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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.             *
 ***************************************************************************/

#ifndef _GSATWRAPPER_HPP_
#define _GSATWRAPPER_HPP_ 1

#include <QString>

#include "VecMath.hpp"

#include "gsatellite/gSatTEME.hpp"
#include "gsatellite/gTime.hpp"

class gSatWrapper
{

public:
    enum Visibility
    {
        //constants for visibility prediction
        UNKNOWN=0,
        RADAR_SUN=1,
        VISIBLE=2,
        RADAR_NIGHT=3,
        NOT_VISIBLE=4
    };
        gSatWrapper(QString designation, QString tle1,QString tle2);
        ~gSatWrapper();

    // Operation setEpoch
    void setEpoch(double ai_julianDaysEpoch);

    // Operation getTEMEPos
    Vec3d getTEMEPos() const;

    // Operation getSunECIPos
    static Vec3d getSunECIPos();

    // Operation getTEMEVel
    Vec3d getTEMEVel() const;

    // Operation:  getSubPoint
    Vec3d getSubPoint() const;

    // Operation getAltAz
    Vec3d getAltAz() const;

        // Operation getSlantRange
    void  getSlantRange(double &ao_slantRange, double &ao_slantRangeRate) const; //measured in km and km/s


        // Operation getVisibilityPredict
    Visibility getVisibilityPredict();

    double getPhaseAngle() const;
    gTime   getEpoch() const { return epoch; }


//private:
        // Operation calcObserverECIPosition
    static void calcObserverECIPosition(Vec3d& ao_position, Vec3d& ao_vel) ;


private:
    static void updateSunECIPos();

    gSatTEME *pSatellite;
    static gTime     epoch;

    // GZ We can avoid many computations (solar and observer positions for every satellite) by computing them only once for all objects.
    static gTime lastSunECIepoch; // store last time of computation to avoid all-1 computations.
    static Vec3d sunECIPos;       // enough to have these once.
    static Vec3d observerECIPos;
    static Vec3d observerECIVel;
    static gTime lastCalcObserverECIPosition;

};

#endif