StelLocation.hpp

/*
 * Copyright (C) 2008 Fabien Chereau
 *
 * 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 _STELLOCATION_HPP_
#define _STELLOCATION_HPP_

#include <QString>
#include <QMetaType>

class StelLocation
{
public:
    StelLocation() : longitude(0.f), latitude(0.f), altitude(0), bortleScaleIndex(2.f), population(0.f), role('X'), isUserLocation(true) {;}

    QString getID() const;

    bool isValid() const {return role!='!';}

    QString serializeToLine() const;

    QString name;
    QString country;
    QString state;
    QString planetName;
    float longitude;
    float latitude;
    int altitude;
    float bortleScaleIndex;
    QString landscapeKey;
    int population;
    QChar role;
    //  See LP:1662132
    // GZ renamed to more clearly indicate these are IANA names.
    QString ianaTimeZone;

    static StelLocation createFromLine(const QString& line);

    static float distanceDegrees(const float long1, const float lat1, const float long2, const float lat2);

    bool isUserLocation;

    static const int DEFAULT_BORTLE_SCALE_INDEX;
private:
    //Register with Qt
    static int metaTypeId;
    static int initMetaType();
};

Q_DECLARE_METATYPE(StelLocation)

QDataStream& operator<<(QDataStream& out, const StelLocation& loc);
QDataStream& operator>>(QDataStream& in, StelLocation& loc);

#endif // _STELLOCATION_HPP_