kstarsdata.h

Go to the documentation of this file.

/***************************************************************************
                          kstarsdata.h  -  K Desktop Planetarium
                             -------------------
    begin                : Sun Jul 29 2001
    copyright            : (C) 2001 by Heiko Evermann
    email                : heiko@evermann.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef KSTARSDATA_H_
#define KSTARSDATA_H_

#include <iostream>

#include "ksnumbers.h"
#include "ksuserdb.h"
#include "datahandlers/catalogdb.h"

#include <QList>
#include <QMap>
#include <QKeySequence>

#include "geolocation.h"
#include "colorscheme.h"
#include "kstarsdatetime.h"
#include "simclock.h"
#include "oal/oal.h"
#include "oal/log.h"

#define MINZOOM 250.
#define MAXZOOM 5000000.
#define DEFAULTZOOM 2000.
#define DZOOM 1.189207115  // 2^(1/4)
#define AU_KM 1.49605e8    //km in one AU


class QFile;

class dms;
class SkyMap;
class SkyMapComposite;
class SkyObject;
class FOV;

class TimeZoneRule;
struct ADVTreeData;


class KStarsData : public QObject
{
    Q_OBJECT

protected:
    KStarsData();

public:
    //Friend classes can see the private data.
    //FIXME: can we avoid having so many friend classes?
    //
    //FIXME: Yes we can. Moreover we should

    // FIXME: It uses temporary trail. There must be way to
    //        this better. And resumeKey in DBUS code
    friend class KStars;
    // FIXME: it uses temporary trail and resumeKey
    friend class SkyMap;
    // FIXME: uses ADVTreeData and only user
    friend class DetailDialog;
    // FIXME: uses geoList and changes it.
    friend class LocationDialog;

    static KStarsData* Create( );

    static inline KStarsData* Instance() { return pinstance; }

    bool initialize();

    virtual ~KStarsData();

    void setNextDSTChange( const KStarsDateTime &dt ) { NextDSTChange = dt; }

    bool isTimeRunningForward() { return TimeRunsForward; }

    KLocale *getLocale() { return locale; }

    SkyObject* objectNamed( const QString &name );

    void setFullTimeUpdate();

    void changeDateTime( const KStarsDateTime &newDate );

    const KStarsDateTime& lt() const { return LTime; }

    const KStarsDateTime& ut() const { return Clock.utc(); }

    void syncLST();

    SkyMapComposite* skyComposite() { return m_SkyComposite; }

    ColorScheme *colorScheme() { return &CScheme; }

    KSUserDB *userdb() { return &m_ksuserdb; }

    CatalogDB *catalogdb() { return &m_catalogdb; }

    SimClock *clock() { return &Clock; }

    dms *lst() { return &LST; }

    GeoLocation *geo() { return &m_Geo; }

    QList<GeoLocation*> getGeoList() { return geoList; }

    GeoLocation *locationNamed( const QString &city, const QString &province=QString(), const QString &country= QString() );

    void setLocation( const GeoLocation &l );

    void setLocationFromOptions();

    const QMap<QString, TimeZoneRule>& getRulebook() { return Rulebook; }

    bool snapNextFocus() const { return snapToFocus; }

    void setSnapNextFocus(bool b=true) { snapToFocus = b; }

    bool executeScript( const QString &name, SkyMap *map );

    void syncFOV();

    inline const QList<FOV*> getVisibleFOVs() const { return visibleFOVs; }

    inline const QList<FOV*> getAvailableFOVs() const { return availFOVs; }

    OAL::Log *logObject() { return m_logObject; }

    /*@short Increments the updateID, forcing a recomputation of star positions as well */
    unsigned int incUpdateID();

    unsigned int updateID()    { return m_updateID; }
    unsigned int updateNumID() { return m_updateNumID; }
    KSNumbers* updateNum()     { return &m_updateNum; }
    void syncUpdateIDs();

signals:
    void progressText( const QString& );

    void update();

    void clearCache();

    void geoChanged();

public slots:
    void slotConsoleMessage( QString s ) { std::cout << (const char*)(s.toLocal8Bit()) << std::endl; }

    void updateTime(GeoLocation *geo, SkyMap * skymap, const bool automaticDSTchange = true);

    void setTimeDirection( float scale );

private:
    bool readCityData();

    bool readTimeZoneRulebook();

    bool processCity( const QString& line );

    //TODO JM: ADV tree should use XML instead
    bool readADVTreeData();

    bool readINDIHosts();

    //TODO JM: Use XML instead; The logger should have more features
    // that allow users to enter details about their observation logs
    // objects observed, eye pieces, telescope, conditions, mag..etc
    bool readUserLog();

    bool readURLData( const QString &url, int type=0, bool deepOnly=false );

    bool openUrlFile(const QString &urlfile, QFile& file);

    void resetToNewDST(GeoLocation *geo, const bool automaticDSTchange);

    QList<ADVTreeData*> ADVtreeList;
    SkyMapComposite* m_SkyComposite;

    GeoLocation m_Geo;
    SimClock Clock;
    KStarsDateTime LTime;
    KSUserDB m_ksuserdb;
    CatalogDB m_catalogdb;
    ColorScheme CScheme;
    OAL::Log *m_logObject;

    bool TimeRunsForward, temporaryTrail;
    // FIXME: Used in SkyMap only. Check!
    bool snapToFocus;

    KLocale *locale;

    dms LST;

    QKeySequence resumeKey;

    QList<FOV*> availFOVs;   // List of all available FOVs
    QList<FOV*> visibleFOVs; // List of visible FOVs. Cached from Options::FOVNames

    KStarsDateTime LastNumUpdate, LastSkyUpdate, LastPlanetUpdate, LastMoonUpdate;
    KStarsDateTime NextDSTChange;
    // FIXME: Used in kstarsdcop.cpp only
    KStarsDateTime StoredDate;

    QList<GeoLocation*> geoList;
    QMap<QString, TimeZoneRule> Rulebook;

    quint32   m_preUpdateID,    m_updateID;
    quint32   m_preUpdateNumID, m_updateNumID;
    KSNumbers m_preUpdateNum,   m_updateNum;

    static KStarsData* pinstance;
};


#endif // KSTARSDATA_H_