RouteDescriptionPostprocessor.h

Go to the documentation of this file.

#ifndef LIBOSMSCOUT_ROUTEDESCRIPTIONPOSTPROCESSOR_H
#define LIBOSMSCOUT_ROUTEDESCRIPTIONPOSTPROCESSOR_H

/*
  This source is part of the libosmscout library
  Copyright (C) 2009-2018  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/routing/RouteDescription.h>
#include <osmscout/util/Distance.h>
#include <osmscout/util/Time.h>

namespace osmscout {

  class OSMSCOUT_API RouteDescriptionPostprocessor
  {
  public:
    struct OSMSCOUT_API Callback
    {
      virtual ~Callback() = default;

      virtual void BeforeRoute();

      virtual void OnStart(const RouteDescription::StartDescriptionRef& startDescription,
                           const RouteDescription::TypeNameDescriptionRef& typeNameDescription,
                           const RouteDescription::NameDescriptionRef& nameDescription);

      virtual void OnTargetReached(const RouteDescription::TargetDescriptionRef& targetDescription);

      virtual void OnTurn(const RouteDescription::TurnDescriptionRef& turnDescription,
                          const RouteDescription::CrossingWaysDescriptionRef& crossingWaysDescription,
                          const RouteDescription::DirectionDescriptionRef& directionDescription,
                          const RouteDescription::TypeNameDescriptionRef& typeNameDescription,
                          const RouteDescription::NameDescriptionRef& nameDescription);

      virtual void OnRoundaboutEnter(const RouteDescription::RoundaboutEnterDescriptionRef& roundaboutEnterDescription,
                                     const RouteDescription::CrossingWaysDescriptionRef& crossingWaysDescription);

      virtual void OnRoundaboutLeave(const RouteDescription::RoundaboutLeaveDescriptionRef& roundaboutLeaveDescription,
                                     const RouteDescription::NameDescriptionRef& nameDescription);

      virtual void OnMotorwayEnter(const RouteDescription::MotorwayEnterDescriptionRef& motorwayEnterDescription,
                                   const RouteDescription::CrossingWaysDescriptionRef& crossingWaysDescription);
      virtual void OnMotorwayChange(const RouteDescription::MotorwayChangeDescriptionRef& motorwayChangeDescription,
                                    const RouteDescription::MotorwayJunctionDescriptionRef& motorwayJunctionDescription,
                                    const RouteDescription::DestinationDescriptionRef& crossingDestinationDescription);
      virtual void OnMotorwayLeave(const RouteDescription::MotorwayLeaveDescriptionRef& motorwayLeaveDescription,
                                   const RouteDescription::MotorwayJunctionDescriptionRef& motorwayJunctionDescription,
                                   const RouteDescription::DirectionDescriptionRef& directionDescription,
                                   const RouteDescription::NameDescriptionRef& nameDescription);

      virtual void OnPathNameChange(const RouteDescription::NameChangedDescriptionRef& nameChangedDescription);

      virtual void OnMaxSpeed(const RouteDescription::MaxSpeedDescriptionRef& maxSpeedDescription);

      virtual void OnPOIAtRoute(const RouteDescription::POIAtRouteDescriptionRef& poiAtRouteDescription);

      virtual void BeforeNode(const RouteDescription::Node& node);
      virtual void AfterNode(const RouteDescription::Node& node);

      virtual bool Continue() const;
    };

  public:
    void GenerateDescription(const RouteDescription& description,
                             Callback& callback) const;

    void GenerateDescription(const RouteDescription::NodeIterator &first,
                             const RouteDescription::NodeIterator &last,
                             Callback& callback) const;
  };

}

#endif //LIBOSMSCOUT_ROUTEDESCRIPTIONPOSTPROCESSOR_H