RoutingInstruction.h

Go to the documentation of this file.

//
// This file is part of the Marble Virtual Globe.
//
// This program is free software licensed under the GNU LGPL. You can
// find a copy of this license in LICENSE.txt in the top directory of
// the source code.
//
// Copyright 2010      Dennis Nienhüser <earthwings@gentoo.org>
//

#ifndef MARBLE_ROUTINGINSTRUCTION_H
#define MARBLE_ROUTINGINSTRUCTION_H

#include "RoutingWaypoint.h"
#include "RoutingPoint.h"
#include "marble_export.h"

#include <QTextStream>
#include <QVector>
#include <QVariant>

namespace Marble
{

class MARBLE_EXPORT RoutingInstruction
{
public:
    enum TurnType {
        Unknown = 0,
        Continue = 13 ,
        Merge = 14,
        Straight = 1,
        SlightRight = 2,
        Right = 3,
        SharpRight = 4,
        TurnAround = 5 ,
        SharpLeft = 6,
        Left = 7,
        SlightLeft = 8,
        RoundaboutFirstExit = 9 ,
        RoundaboutSecondExit = 10 ,
        RoundaboutThirdExit = 11 ,
        RoundaboutExit = 12 ,
        ExitLeft = 15,
        ExitRight = 16
    };

    explicit RoutingInstruction( const RoutingWaypoint &item = RoutingWaypoint() );

    bool append( const RoutingWaypoint &item, int angle );

    QString roadName() const;

    QString roadType() const;

    int secondsLeft() const;

    QVector<RoutingWaypoint> points() const;

    QVector<RoutingPoint> intersectionPoints() const;

    qreal angleToPredecssor() const;

    RoutingInstruction* predecessor();

    const RoutingInstruction* predecessor() const;

    void setPredecessor( RoutingInstruction* predecessor );

    RoutingInstruction* successor();

    const RoutingInstruction* successor() const;

    void setSuccessor( RoutingInstruction* successor );

    qreal distance() const;

    qreal distanceFromStart() const;

    qreal distanceToEnd() const;

    TurnType turnType() const;

    QString nextRoadInstruction() const;

    QString nextDistanceInstruction() const;

    QString totalDurationRemaining() const;

    QString instructionText() const;

    static QString generateRoadInstruction( TurnType turnType, const QString &roadName );

protected:
    int roundaboutExitNumber() const;

private:
    void calculateAngle();

    void calculateTurnType();

    QVector<RoutingWaypoint> m_points;

    QVector<RoutingPoint> m_intersectionPoints;

    QString m_roadName;

    QString m_roadType;

    int m_secondsLeft;

    qreal m_angleToPredecessor;

    TurnType m_turnType;

    int m_roundaboutExit;

    RoutingInstruction* m_predecessor;

    RoutingInstruction* m_successor;
};

QTextStream& operator<<( QTextStream& stream, const RoutingInstruction &i );

typedef QVector<RoutingInstruction> RoutingInstructions;

} // namespace Marble

Q_DECLARE_METATYPE( Marble::RoutingInstruction::TurnType )

#endif // MARBLE_ROUTINGINSTRUCTION_H