• Skip to content
• Skip to link menu

KDE 3.5 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

kstars

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 <qmap.h>
#include <qptrlist.h>
#include <qstring.h>

#include <kshortcut.h>

#include <iostream>

#include "fov.h"
#include "geolocation.h"
#include "colorscheme.h"
#include "objectnamelist.h"
#include "planetcatalog.h"
#include "tools/lcgenerator.h"
#include "kstarsdatetime.h"
#include "simclock.h"

#define NHIPFILES 127
#define NMWFILES  11
#define NNGCFILES 14
#define NTYPENAME 12
#define NCIRCLE 360   //number of points used to define equator, ecliptic and horizon

#define MINZOOM 200.
#define MAXZOOM 1000000.
#define DEFAULTZOOM 2000.
#define DZOOM 1.10
#define AU_KM 1.49605e8  //km in one AU

#define MINDRAWSTARMAG 6.5 // min. magnitude to load all stars which are needed for constellation lines

class QDataPump;
class QFile;
class QTimer;

class KStandardDirs;

class dms;
class SkyMap;
class SkyPoint;
class SkyObject;
class DeepSkyObject;
class StarObject;
class KSPlanet;
class KSAsteroid;
class KSComet;
class KSMoon;
class PlanetCatalog;
class JupiterMoons;

class TimeZoneRule;
class FileSource;
class StarDataSink;
class KSFileReader;
class INDIHostsInfo;
class ADVTreeData;
class CSegment;
class CustomCatalog;

class KStarsData : public QObject
{
    Q_OBJECT
public:
    //Friend classes can see the private data.
    friend class FindDialog;
    friend class KStars;
    friend class KSWizard;
    friend class LocationDialog;
    friend class FOVDialog;
    friend class MapCanvas;
    friend class SkyMap;
    friend class FileSource;
    friend class StarDataSink;
    friend class LCGenerator;
    friend class DetailDialog;
    friend class AltVsTime;
    friend class KSPopupMenu;
    friend class WUTDialog;
    friend class INDIDriver;
    friend class INDI_P;
    friend class INDIStdProperty;
    friend class PlanetViewer;
    friend class JMoonTool;
    friend class telescopeWizardProcess;
    friend class KSNewStuff;
    friend class ObservingList;
    friend class ObsListWizard;

    KStarsData();

  virtual ~KStarsData();

    bool readCityData( void );

    bool readTimeZoneRulebook( void );

    bool processCity( QString& line );

    bool readStarData( void );

    void processStar( QString *line, bool reloadMode = false );

    bool readDeepSkyData( void );

    bool readAsteroidData( void );

    bool readCometData( void );

    bool readCLineData( void );

    bool readCNameData( void );

    bool readCBoundData( void );

    bool readMWData( void );

    bool readVARData(void);

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

    bool readINDIHosts(void);

    //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(void);

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

    bool openURLFile(QString urlfile, QFile& file);

    bool readCustomCatalogs();

    bool addCatalog( QString filename );

    bool removeCatalog( int i );

    CustomCatalog* createCustomCatalog( QString filename, bool showerrs = false );

    bool parseCustomDataHeader( QStringList lines, QStringList &Columns, 
            QString &catName, QString &catPrefix, QString &catColor, float &catEpoch, int &iStart, 
            bool showerrs, QStringList &errs );

    bool processCustomDataLine( int num, QStringList d, QStringList Columns, 
            QString Prefix, QPtrList<SkyObject> &objList, bool showerrs, QStringList &errs );

    void setMagnitude( float newMagnitude, bool forceReload=false );

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

    bool isTimeRunningForward() { return TimeRunsForward; }

    KLocale *getLocale() { return locale; }

    KSPlanet *earth() { return PCat->earth(); }

    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();
    
    void setHourAngle( double ha ) { HourAngle->setH( ha ); }

    //Some members need to be accessed outside of the friend classes (i.e., in the main fcn).

    ColorScheme *colorScheme() { return &CScheme; }
    
    SimClock *clock() { return &Clock; }
    
    dms *lst() { return LST; }
    
    GeoLocation *geo() { return &Geo; }
    
    QPtrList<CustomCatalog>& customCatalogs() { return CustomCatalogs; }
 
    void setLocation( const GeoLocation &l );
    
    void setLocationFromOptions();

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

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

    void initGuides( KSNumbers *num );

    bool useDefaultOptions, startupComplete;

    void appendTelescopeObject(SkyObject * object);

signals:
    void progressText(QString);

    void initFinished(bool);

    void update();

    void clearCache();

public slots:

    void initialize();

    void slotConsoleMessage( QString s ) { std::cout << s.utf8() << std::endl; }

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

    void setTimeDirection( float scale );

    void saveTimeBoxShaded( bool b );

    void saveGeoBoxShaded( bool b );

    void saveFocusBoxShaded( bool b );

    void saveTimeBoxPos( QPoint p );

    void saveGeoBoxPos( QPoint p );

    void saveFocusBoxPos( QPoint p );

private slots:
    void slotInitialize();

    void checkDataPumpAction();

    void updateSkymap();

    void sendClearCache();

private:

    void initError(QString fn, bool required);

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

/*
    * Store the highest magnitude level at the current session and compare with current used
    * magnitude. If current magnitude is equal to maxSetMagnitude reload data on next increment
    * of magnitude level.
    */
    float maxSetMagnitude;
/*
    * Store the last position in star data file. Needed by reloading star data.
    */
    int lastFileIndex;

    bool reloadingData();  // is currently reloading of data in progress

/*  bool openSAOFile(int i);*/
    bool openStarFile(int i);

    static QPtrList<GeoLocation> geoList;
    QPtrList<SkyObject> objList;

    QPtrList<StarObject> starList;

    unsigned int StarCount;

    QPtrList<DeepSkyObject> deepSkyList;
    QPtrList<DeepSkyObject> deepSkyListMessier;
    QPtrList<DeepSkyObject> deepSkyListNGC;
    QPtrList<DeepSkyObject> deepSkyListIC;
    QPtrList<DeepSkyObject> deepSkyListOther;

    QPtrList<KSAsteroid> asteroidList;
    QPtrList<KSComet> cometList;

    QPtrList<SkyPoint> MilkyWay[NMWFILES];

    QPtrList<SkyPoint> clineList;
    QPtrList<CSegment> csegmentList;
    QPtrList<QChar> clineModeList;
    QPtrList<SkyObject> cnameList;
    QPtrList<SkyObject> ObjLabelList;

    QPtrList<SkyPoint> Equator;
    QPtrList<SkyPoint> Ecliptic;
    QPtrList<SkyPoint> Horizon;
    QPtrList<VariableStarInfo> VariableStarsList;
    QPtrList<ADVTreeData> ADVtreeList;
    QPtrList<INDIHostsInfo> INDIHostsList;
    QPtrList<SkyObject> INDITelescopeList;
    
    QPtrList<CustomCatalog> CustomCatalogs;

    ObjectNameList ObjNames;

    static QMap<QString, TimeZoneRule> Rulebook;
    static QStringList CustomColumns;
    
    GeoLocation Geo;
    SimClock Clock;
    ColorScheme CScheme;

    KStarsDateTime LTime;

    bool TimeRunsForward, temporaryTrail, snapToFocus;

    QString cnameFile;
    KStandardDirs *stdDirs;
    KLocale *locale;

    dms *LST, *HourAngle;

    QString TypeName[NTYPENAME];
    KKey resumeKey;

    PlanetCatalog *PCat;
    KSMoon *Moon;
    JupiterMoons *jmoons;

    KSFileReader *starFileReader;

    FOV fovSymbol;

    double Obliquity, dObliq, dEcLong;
    KStarsDateTime LastNumUpdate, LastSkyUpdate, LastPlanetUpdate, LastMoonUpdate;
    KStarsDateTime NextDSTChange;
    KStarsDateTime StoredDate;

    QTimer *initTimer;
    int initCounter;

    FileSource *source;
    StarDataSink *loader;
    QDataPump *pump;

    static int objects;
};


#endif // KSTARSDATA_H

kstars

Skip menu "kstars"

• Main Page
• Modules
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Class Members
• Related Pages

API Reference

Skip menu "API Reference"

• keduca
• kstars

Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal