Satellite.hpp

/*
 * Stellarium
 * Copyright (C) 2009, 2012 Matthew Gates
 *
 * 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 _SATELLITE_HPP_
#define _SATELLITE_HPP_ 1

#include <QDateTime>
#include <QFont>
#include <QList>
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <QVariant>

#include "StelObject.hpp"
#include "StelTextureTypes.hpp"
#include "StelSphereGeometry.hpp"
#include "gSatWrapper.hpp"


class StelPainter;
class StelLocation;

typedef struct
{
    double frequency; 
    QString modulation; 
    QString description; 
} CommLink;

enum SatelliteDataRole {
    SatIdRole = Qt::UserRole,
    SatDescriptionRole,
    SatFlagsRole,
    SatGroupsRole,
    FirstLineRole,
    SecondLineRole
};

typedef QSet<QString> GroupSet;

enum SatFlag
{
    SatNoFlags = 0x0,
    SatDisplayed = 0x1,
    SatNotDisplayed = 0x2,
    SatUser = 0x4,
    SatOrbit = 0x8,
    SatNew = 0x10,
    SatError = 0x20
};
typedef QFlags<SatFlag> SatFlags;
Q_DECLARE_OPERATORS_FOR_FLAGS(SatFlags)

// Allows the type to be used by QVariant
Q_DECLARE_METATYPE(GroupSet)
Q_DECLARE_METATYPE(SatFlags)

class Satellite : public StelObject
{
    friend class Satellites;
    friend class SatellitesDialog;
    friend class SatellitesListModel;

    Q_ENUMS(OptStatus)
public:
    enum OptStatus
    {
        StatusOperational       = 1,
        StatusNonoperational        = 2,
        StatusPartiallyOperational  = 3,
        StatusStandby           = 4,
        StatusSpare         = 5,
        StatusExtendedMission       = 6,
        StatusDecayed           = 7,
        StatusUnknown           = 0
    };

    Satellite(const QString& identifier, const QVariantMap& data);
    ~Satellite();

    QVariantMap getMap(void);

    virtual QString getType(void) const
    {
        return "Satellite";
    }
    virtual float getSelectPriority(const StelCore* core) const;

    virtual QString getInfoString(const StelCore *core, const InfoStringGroup& flags) const;
    virtual QVariantMap getInfoMap(const StelCore *core) const;
    virtual Vec3f getInfoColor(void) const;
    virtual Vec3d getJ2000EquatorialPos(const StelCore*) const;
    virtual float getVMagnitude(const StelCore* core) const;
    virtual double getAngularSize(const StelCore* core) const;
    virtual QString getNameI18n(void) const;
    virtual QString getEnglishName(void) const
    {
        return name;
    }
    QString getCatalogNumberString() const {return id;}

    void setNewTleElements(const QString& tle1, const QString& tle2);

    // calculate faders, new position
    void update(double deltaTime);

    double getDoppler(double freq) const;
    static float showLabels;
    static double roundToDp(float n, int dp);

    // when the observer location changes we need to
    void recalculateOrbitLines(void);
    
    void setNew() {newlyAdded = true;}
    bool isNew() const {return newlyAdded;}
    
    SatFlags getFlags();
    void setFlags(const SatFlags& flags);
    
    void parseInternationalDesignator(const QString& tle1);
    
    bool operator<(const Satellite& another) const;

    float calculateIlluminatedFraction() const;

    QString getOperationalStatus() const;

private:
    //draw orbits methods
    void computeOrbitPoints();
    void drawOrbit(StelPainter& painter);
    float calculateOrbitSegmentIntensity(int segNum);

private:
    bool initialized;
    bool displayed;
    bool orbitDisplayed;  // draw orbit enabled/disabled
    bool userDefined;
    bool newlyAdded;
    bool orbitValid;

    QString id;
    QString name;
    QString description;
    QString internationalDesignator;
    double jdLaunchYearJan1;
    double stdMag;
    int status;
    Vec3d XYZ;
    QPair< QByteArray, QByteArray > tleElements;
    double height, range, rangeRate;
    QList<CommLink> comms;
    Vec3f hintColor;    
    GroupSet groups;
    QDateTime lastUpdated;

    static StelTextureSP hintTexture;
    static SphericalCap  viewportHalfspace;
    static float hintBrightness;
    static float hintScale;
    static int   orbitLineSegments;
    static int   orbitLineFadeSegments;
    static int   orbitLineSegmentDuration; //measured in seconds
    static bool  orbitLinesFlag;
    static bool  realisticModeFlag;
    static StelObject::InfoStringGroupFlags flagsMask;
    static Vec3f invisibleSatelliteColor;

    void draw(StelCore *core, StelPainter& painter, float maxMagHints);

    //Satellite Orbit Position calculation
    gSatWrapper *pSatWrapper;
    Vec3d   position;
    Vec3d   velocity;
    Vec3d   latLongSubPointPosition;
    Vec3d   elAzPosition;

#ifdef IRIDIUM_SAT_TEXT_DEBUG
    static QString myText;
#endif

    int visibility;
    double  phaseAngle; // phase angle for the satellite
    static double sunReflAngle; // for Iridium satellites
    static double timeShift; // for Iridium satellites

    //Satellite Orbit Draw
    QFont     font;
    Vec3f    orbitColor;
    double    lastEpochCompForOrbit; //measured in Julian Days
    double    epochTime;  //measured in Julian Days
    QList<Vec3d> orbitPoints; //orbit points represented by ElAzPos vectors
    QList<int> visibilityPoints; //orbit visibility points
};

typedef QSharedPointer<Satellite> SatelliteP;
bool operator<(const SatelliteP& left, const SatelliteP& right);

#endif // _SATELLITE_HPP_