RouteStep.h

Go to the documentation of this file.

#ifndef OSMSCOUT_CLIENT_QT_ROUTESTEP_H
#define OSMSCOUT_CLIENT_QT_ROUTESTEP_H

/*
 OSMScout - a Qt backend for libosmscout and libosmscout-map
 Copyright (C) 2010 Tim Teulings
 Copyright (C) 2017 Lukas Karas

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 */

#include <osmscout/ClientQtImportExport.h>

#include <osmscout/util/Time.h>
#include <osmscout/util/Distance.h>
#include <osmscout/GeoCoord.h>

#include <QObject>

namespace osmscout {

class OSMSCOUT_CLIENT_QT_API RouteStep : public QObject
{
  Q_OBJECT
  Q_PROPERTY(QString type             READ getType                NOTIFY update)
  Q_PROPERTY(double  lat              READ getLat()               NOTIFY update)
  Q_PROPERTY(double  lon              READ getLon()               NOTIFY update)
  Q_PROPERTY(double  distance         READ getDistance            NOTIFY update)
  Q_PROPERTY(double  distanceDelta    READ getDistanceDelta       NOTIFY update)
  Q_PROPERTY(double  distanceTo       READ getDistanceTo          NOTIFY update)
  Q_PROPERTY(double  time             READ getTime                NOTIFY update)
  Q_PROPERTY(double  timeDelta        READ getTimeDelta           NOTIFY update)
  Q_PROPERTY(QString description      READ getDescription         NOTIFY update)
  Q_PROPERTY(QString shortDescription READ getShortDescription    NOTIFY update)
  Q_PROPERTY(QStringList streetNames  READ getStreetNames         NOTIFY update)
  Q_PROPERTY(int roundaboutExit       READ getRoundaboutExit      NOTIFY update)
  Q_PROPERTY(bool roundaboutClockwise READ getRoundaboutClockwise NOTIFY update)

signals:
  void update();

public:
  enum Roles {
    ShortDescriptionRole = Qt::UserRole + 1,
    DescriptionRole = Qt::UserRole + 2,
    TypeRole = Qt::UserRole + 3,
    RoundaboutExitRole = Qt::UserRole + 4,
    RoundaboutClockwiseRole = Qt::UserRole + 5,
    latRole = Qt::UserRole + 6,
    lonRole = Qt::UserRole + 7,
    distanceRole = Qt::UserRole + 8,
    distanceDeltaRole = Qt::UserRole + 9,
    distanceToRole = Qt::UserRole + 10,
    timeRole = Qt::UserRole + 11,
    timeDeltaRole = Qt::UserRole + 12
  };
  Q_ENUM(Roles)

public:
  QString type;             
  GeoCoord coord;           
  Distance distance;        
  Distance distanceDelta;   
  Distance distanceTo;      
  Duration time;            
  Duration timeDelta;       
  QString description;      
  QString shortDescription; 
  QStringList streetNames;  
  int roundaboutExit{-1};   

  bool roundaboutClockwise{false};

public:
  inline RouteStep() : RouteStep("", GeoCoord(), Distance::Zero(), Distance::Zero(),
                                 Duration::zero(), Duration::zero(),
                                 QStringList())
  {};

  RouteStep(const QString &type,
            const GeoCoord &coord,
            const Distance &distance,
            const Distance &distanceDelta,
            const Duration &time,
            const Duration &timeDelta,
            const QStringList &streetNames);

  RouteStep(const RouteStep& other);

  RouteStep& operator=(const RouteStep& other);

  QString getType() const
  {
    return type;
  };

  GeoCoord GetCoord() const
  {
    return coord;
  }

  double getLat() const
  {
    return coord.GetLat();
  }

  double getLon() const
  {
    return coord.GetLon();
  }

  Distance GetDistance() const
  {
    return distance;
  }

  double getDistance() const
  {
    return distance.AsMeter();
  }

  double getDistanceDelta() const
  {
    return distanceDelta.AsMeter();
  }

  double getDistanceTo() const
  {
    return distanceTo.AsMeter();
  }

  double getTime() const
  {
    return DurationAsSeconds(time);
  }

  double getTimeDelta() const
  {
    return DurationAsSeconds(timeDelta);
  }

  QString getDescription() const
  {
    return description;
  }

  QString getShortDescription() const
  {
    return shortDescription;
  }

  QStringList getStreetNames() const
  {
    return streetNames;
  }

  int getRoundaboutExit() const
  {
    return roundaboutExit;
  }

  bool getRoundaboutClockwise() const
  {
    return roundaboutClockwise;
  }

  QVariant data(int role) const;

  static QHash<int, QByteArray> roleNames(QHash<int, QByteArray> roles);

private:
  void copyDynamicProperties(const RouteStep &other);
};

}

#endif //OSMSCOUT_CLIENT_QT_ROUTESTEP_H