RouteDescription.h

Go to the documentation of this file.

#ifndef OSMSCOUT_ROUTE_DESCRIPTION_H
#define OSMSCOUT_ROUTE_DESCRIPTION_H

/*
  This source is part of the libosmscout library
  Copyright (C) 2009  Tim Teulings

  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 <list>
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
#include <map>

#include <osmscout/ObjectRef.h>
#include <osmscout/Path.h>
#include <osmscout/GeoCoord.h>
#include <osmscout/routing/DBFileOffset.h>
#include <osmscout/util/Distance.h>
#include <osmscout/util/Time.h>

namespace osmscout {

  class OSMSCOUT_API RouteDescription
  {
  public:
    static const char* const NODE_START_DESC;
    static const char* const NODE_TARGET_DESC;
    static const char* const WAY_NAME_DESC;
    static const char* const WAY_NAME_CHANGED_DESC;
    static const char* const CROSSING_WAYS_DESC;
    static const char* const DIRECTION_DESC;
    static const char* const TURN_DESC;
    static const char* const ROUNDABOUT_ENTER_DESC;
    static const char* const ROUNDABOUT_LEAVE_DESC;
    static const char* const MOTORWAY_ENTER_DESC;
    static const char* const MOTORWAY_CHANGE_DESC;
    static const char* const MOTORWAY_LEAVE_DESC;
    static const char* const MOTORWAY_JUNCTION_DESC;
    static const char* const CROSSING_DESTINATION_DESC;
    static const char* const WAY_MAXSPEED_DESC;
    static const char* const WAY_TYPE_NAME_DESC;
    static const char* const POI_AT_ROUTE_DESC;
    static const char* const LANES_DESC;
    static const char* const SUGGESTED_LANES_DESC;

  public:
    class OSMSCOUT_API Description
    {
    public:
      virtual ~Description() = default;

      virtual std::string GetDebugString() const = 0;
    };

    using DescriptionRef = std::shared_ptr<Description>;

    class OSMSCOUT_API StartDescription : public Description
    {
    private:
      std::string description;

    public:
      explicit StartDescription(const std::string& description);

      std::string GetDebugString() const override;

      std::string GetDescription() const;
    };

    using StartDescriptionRef = std::shared_ptr<StartDescription>;

    class OSMSCOUT_API TargetDescription : public Description
    {
    private:
      std::string description;

    public:
      explicit TargetDescription(const std::string& description);

      std::string GetDebugString() const override;

      std::string GetDescription() const;
    };

    using TargetDescriptionRef = std::shared_ptr<TargetDescription>;

    class OSMSCOUT_API NameDescription : public Description
    {
    private:
      std::string name;
      std::string ref;

    public:
      explicit NameDescription(const std::string& name);

      NameDescription(const std::string& name,
                      const std::string& ref);

      std::string GetDebugString() const override;

      bool HasName() const;

      std::string GetName() const;
      std::string GetRef() const;

      std::string GetDescription() const;
    };

    using NameDescriptionRef = std::shared_ptr<NameDescription>;

    class OSMSCOUT_API NameChangedDescription : public Description
    {
      NameDescriptionRef originDescription;
      NameDescriptionRef targetDescription;

    public:
      NameChangedDescription(const NameDescriptionRef& originDescription,
                             const NameDescriptionRef& targetDescription);

      std::string GetDebugString() const override;

      NameDescriptionRef GetOriginDescription() const
      {
        return originDescription;
      }

      NameDescriptionRef GetTargetDescription() const
      {
        return targetDescription;
      }
    };

    using NameChangedDescriptionRef = std::shared_ptr<NameChangedDescription>;

    class OSMSCOUT_API CrossingWaysDescription : public Description
    {
    private:
      size_t                        exitCount;
      NameDescriptionRef            originDescription;
      NameDescriptionRef            targetDescription;
      std::list<NameDescriptionRef> descriptions;

    public:
      CrossingWaysDescription(size_t exitCount,
                              const NameDescriptionRef& originDescription,
                              const NameDescriptionRef& targetDescription);

      void AddDescription(const NameDescriptionRef& description);

      std::string GetDebugString() const override;

      size_t GetExitCount() const
      {
        return exitCount;
      }

      bool HasMultipleExits() const
      {
        return exitCount>1;
      }

      NameDescriptionRef GetOriginDesccription() const
      {
        return originDescription;
      }

      NameDescriptionRef GetTargetDesccription() const
      {
        return targetDescription;
      }

      const std::list<NameDescriptionRef>& GetDescriptions() const
      {
        return descriptions;
      }
    };

    using CrossingWaysDescriptionRef = std::shared_ptr<CrossingWaysDescription>;

    class OSMSCOUT_API DirectionDescription : public Description
    {
    public:
      enum Move {
        sharpLeft,
        left,
        slightlyLeft,
        straightOn,
        slightlyRight,
        right,
        sharpRight
      };

    private:
      double turnAngle;
      double curveAngle;
      Move   turn;
      Move   curve;

    private:
      Move ConvertAngleToMove(double angle) const;
      std::string ConvertMoveToString(Move move) const;

    public:
      DirectionDescription(double turnAngle,
                      double curveAngle);

      std::string GetDebugString() const override;

      double GetTurnAngle() const
      {
        return turnAngle;
      }

      double GetCurveAngle() const
      {
        return curveAngle;
      }

      Move GetTurn() const
      {
        return turn;
      }

      Move GetCurve() const
      {
        return curve;
      }
    };

    using DirectionDescriptionRef = std::shared_ptr<DirectionDescription>;

    class OSMSCOUT_API TurnDescription : public Description
    {
    public:
      std::string GetDebugString() const override;
    };

    using TurnDescriptionRef = std::shared_ptr<TurnDescription>;

    class OSMSCOUT_API RoundaboutEnterDescription : public Description
    {
    private:
      bool clockwise;

    public:
      explicit RoundaboutEnterDescription(bool clockwise);

      std::string GetDebugString() const override;

      bool IsClockwise() const
      {
        return clockwise;
      }
    };

    using RoundaboutEnterDescriptionRef = std::shared_ptr<RoundaboutEnterDescription>;

    class OSMSCOUT_API RoundaboutLeaveDescription : public Description
    {
    private:
      size_t exitCount;
      bool clockwise;

    public:
      RoundaboutLeaveDescription(size_t exitCount, bool clockwise);

      std::string GetDebugString() const override;

      size_t GetExitCount() const
      {
        return exitCount;
      }

      bool IsClockwise() const
      {
        return clockwise;
      }
    };

    using RoundaboutLeaveDescriptionRef = std::shared_ptr<RoundaboutLeaveDescription>;

    class OSMSCOUT_API MotorwayEnterDescription : public Description
    {
    private:
      NameDescriptionRef toDescription;

    public:
      explicit MotorwayEnterDescription(const NameDescriptionRef& toDescription);

      std::string GetDebugString() const override;

      NameDescriptionRef GetToDescription() const
      {
        return toDescription;
      }
    };

    using MotorwayEnterDescriptionRef = std::shared_ptr<MotorwayEnterDescription>;

    class OSMSCOUT_API MotorwayChangeDescription : public Description
    {
    private:
      NameDescriptionRef fromDescription;
      NameDescriptionRef toDescription;

    public:
      MotorwayChangeDescription(const NameDescriptionRef& fromDescription,
                                const NameDescriptionRef& toDescription);

      std::string GetDebugString() const override;

      NameDescriptionRef GetFromDescription() const
      {
        return fromDescription;
      }

      NameDescriptionRef GetToDescription() const
      {
        return toDescription;
      }
    };

    using MotorwayChangeDescriptionRef = std::shared_ptr<MotorwayChangeDescription>;

    class OSMSCOUT_API MotorwayLeaveDescription : public Description
    {
    private:
      NameDescriptionRef fromDescription;

    public:
      explicit MotorwayLeaveDescription(const NameDescriptionRef& fromDescription);

      std::string GetDebugString() const override;

      NameDescriptionRef GetFromDescription() const
      {
        return fromDescription;
      }
    };

    using MotorwayLeaveDescriptionRef = std::shared_ptr<MotorwayLeaveDescription>;

    class OSMSCOUT_API MotorwayJunctionDescription : public Description
    {
    private:
      NameDescriptionRef junctionDescription;

    public:
      explicit MotorwayJunctionDescription(const NameDescriptionRef& junctionDescription);

      std::string GetDebugString() const override;

      NameDescriptionRef GetJunctionDescription() const
      {
        return junctionDescription;
      }
    };

    using MotorwayJunctionDescriptionRef = std::shared_ptr<MotorwayJunctionDescription>;

    class OSMSCOUT_API DestinationDescription : public Description
    {
    private:
      std::string description;

    public:
      explicit DestinationDescription(const std::string& description);

      std::string GetDebugString() const override;

      std::string GetDescription() const;
    };

    using DestinationDescriptionRef = std::shared_ptr<DestinationDescription>;

    class OSMSCOUT_API MaxSpeedDescription : public RouteDescription::Description
    {
    private:
      uint8_t maxSpeed;

    public:
      explicit MaxSpeedDescription(uint8_t speed);

      std::string GetDebugString() const override;

      uint8_t GetMaxSpeed() const
      {
        return maxSpeed;
      }
    };

    using MaxSpeedDescriptionRef = std::shared_ptr<MaxSpeedDescription>;

    class OSMSCOUT_API TypeNameDescription : public Description
    {
    private:
      std::string name;

    public:
      explicit TypeNameDescription(const std::string& name);

      std::string GetDebugString() const override;

      bool HasName() const;

      std::string GetName() const;

      std::string GetDescription() const;
    };

    using TypeNameDescriptionRef = std::shared_ptr<TypeNameDescription>;

    class OSMSCOUT_API POIAtRouteDescription : public RouteDescription::Description
    {
    private:
      DatabaseId         databaseId;
      ObjectFileRef      object;
      NameDescriptionRef name;
      Distance           distance;

    public:
      explicit POIAtRouteDescription(DatabaseId databaseId,
                                     const ObjectFileRef& object,
                                     const NameDescriptionRef& name,
                                     const Distance& distance);

      std::string GetDebugString() const override;

      DatabaseId GetDatabaseId() const
      {
        return databaseId;
      }

      ObjectFileRef GetObject() const
      {
        return object;
      }

      NameDescriptionRef GetName() const
      {
        return name;
      }

      Distance GetDistance() const
      {
        return distance;
      }
    };

    using POIAtRouteDescriptionRef = std::shared_ptr<POIAtRouteDescription>;

    class OSMSCOUT_API LaneDescription : public RouteDescription::Description
    {
    private:
      bool oneway{false};
      uint8_t laneCount{1}; 

      std::vector<std::string> laneTurns;

    public:
      LaneDescription(bool oneway,
                      uint8_t laneCount,
                      const std::vector<std::string> &laneTurns);

      std::string GetDebugString() const override;

      bool IsOneway() const
      {
        return oneway;
      }

      uint8_t GetLaneCount() const
      {
        return laneCount;
      }

      const std::vector<std::string>& GetLaneTurns() const
      {
        return laneTurns;
      }

      bool operator==(const LaneDescription &o) const;
      bool operator!=(const LaneDescription &o) const;
    };

    using LaneDescriptionRef = std::shared_ptr<LaneDescription>;

    class OSMSCOUT_API SuggestedLaneDescription : public RouteDescription::Description
    {
    private:
      uint8_t from = uint8_t(-1); 
      uint8_t to = uint8_t(-1); 

    public:
      SuggestedLaneDescription(uint8_t from, uint8_t to);

      std::string GetDebugString() const override;

      uint8_t GetFrom() const
      {
        return from;
      }

      uint8_t GetTo() const
      {
        return to;
      }
    };

    using SuggestedLaneDescriptionRef = std::shared_ptr<SuggestedLaneDescription>;

    class OSMSCOUT_API Node
    {
    private:
      DatabaseId                                     database; 
      size_t                                         currentNodeIndex; 
      std::vector<ObjectFileRef>                     objects; 
      ObjectFileRef                                  pathObject; 
      size_t                                         targetNodeIndex; 
      Distance                                       distance; 
      Duration                                       time; 
      GeoCoord                                       location; 
      std::unordered_map<std::string,DescriptionRef> descriptionMap;
      std::list<DescriptionRef>                      descriptions;

    public:
      Node(DatabaseId database,
           size_t currentNodeIndex,
           const std::vector<ObjectFileRef>& objects,
           const ObjectFileRef& pathObject,
           size_t targetNodeIndex);

      size_t GetCurrentNodeIndex() const
      {
        return currentNodeIndex;
      }

      const std::vector<ObjectFileRef>& GetObjects() const
      {
        return objects;
      }

      const std::list<DescriptionRef>& GetDescriptions() const
      {
        return descriptions;
      }

      bool HasPathObject() const
      {
        return pathObject.Valid();
      }

      DatabaseId GetDatabaseId() const
      {
        return database;
      }

      DBFileOffset GetDBFileOffset() const
      {
        return DBFileOffset(GetDatabaseId(),GetPathObject().GetFileOffset());
      }

      ObjectFileRef GetPathObject() const
      {
        return pathObject;
      }

      size_t GetTargetNodeIndex() const
      {
        return targetNodeIndex;
      }

      Distance GetDistance() const
      {
        return distance;
      }

      Duration GetTime() const
      {
        return time;
      }

      GeoCoord GetLocation() const
      {
        return location;
      }

      bool HasDescription(const char* name) const;
      DescriptionRef GetDescription(const char* name) const;

      void SetDistance(Distance distance);
      void SetTime(const Timestamp::duration &time);
      void SetLocation(const GeoCoord &coord);

      void AddDescription(const char* name,
                          const DescriptionRef& description);
    };

    using NodeIterator = std::list<RouteDescription::Node>::const_iterator;

  private:
    std::list<Node> nodes;
    std::map<DatabaseId, std::string> databaseMapping;

  public:
    RouteDescription() = default;
    virtual ~RouteDescription() = default;

    void SetDatabaseMapping(std::map<DatabaseId, std::string> databaseMapping);

    std::map<DatabaseId, std::string> GetDatabaseMapping() const;

    void Clear();

    bool Empty() const;

    void AddNode(DatabaseId database,
                 size_t currentNodeIndex,
                 const std::vector<ObjectFileRef>& objects,
                 const ObjectFileRef& pathObject,
                 size_t targetNodeIndex);

    std::list<Node>& Nodes()
    {
      return nodes;
    }

    const std::list<Node>& Nodes() const
    {
      return nodes;
    }
  };

  using RouteDescriptionRef = std::shared_ptr<RouteDescription>;
}

#endif