Location.h

Go to the documentation of this file.

#ifndef OSMSCOUT_LOCATION_H
#define OSMSCOUT_LOCATION_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 <vector>

#include <osmscout/ObjectRef.h>
#include <osmscout/TypeConfig.h>

namespace osmscout {
  class OSMSCOUT_API PostalArea
  {
  public:
    std::string name;         
    FileOffset  objectOffset; 
  };

  using PostalAreaRef = std::shared_ptr<PostalArea>;

  class OSMSCOUT_API AdminRegion
  {
  public:
    class OSMSCOUT_API RegionAlias
    {
    public:
      std::string name;         
      std::string altName;
      FileOffset  objectOffset; 
    };

    FileOffset               regionOffset;       
    FileOffset               dataOffset;         
    FileOffset               parentRegionOffset; 
    std::string              name;               
    std::string              altName;
    ObjectFileRef            object;             
    std::vector<RegionAlias> aliases;            
    std::vector<PostalArea>  postalAreas;        //<! The list of postal areas
    std::vector<FileOffset>  childrenOffsets;    

  public:
    bool Match(const ObjectFileRef& object) const;
  };

  using AdminRegionRef = std::shared_ptr<AdminRegion>;

  class OSMSCOUT_API AdminRegionVisitor
  {
  public:
    enum Action {
      skipChildren,
      visitChildren,
      stop,
      error
    };

  public:
    virtual ~AdminRegionVisitor() = default;

    virtual Action Visit(const AdminRegion& region) = 0;
  };

  class OSMSCOUT_API POI
  {
  public:
    FileOffset    regionOffset; 
    std::string   name;         
    ObjectFileRef object;       
  };

  using POIRef = std::shared_ptr<POI>;

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

    virtual bool Visit(const AdminRegion& adminRegion,
                       const POI &poi) = 0;
  };

  class OSMSCOUT_API Location
  {
  public:
    FileOffset                 locationOffset;  
    FileOffset                 regionOffset;    
    FileOffset                 addressesOffset; 
    std::string                name;            
    std::vector<ObjectFileRef> objects;         
  };

  using LocationRef = std::shared_ptr<Location>;

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

    virtual bool Visit(const AdminRegion& adminRegion,
                       const PostalArea& postalArea,
                       const Location &location) = 0;
  };

  class OSMSCOUT_API Address
  {
  public:
    FileOffset    addressOffset;  
    FileOffset    locationOffset; 
    FileOffset    regionOffset;   
    std::string   name;           
    ObjectFileRef object;         
  };

  using AddressRef = std::shared_ptr<Address>;

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

    virtual bool Visit(const AdminRegion& adminRegion,
                       const PostalArea& postalArea,
                       const Location& location,
                       const Address& address) = 0;
  };

  class OSMSCOUT_API AddressListVisitor : public AddressVisitor
  {
  public:
    class OSMSCOUT_API AddressResult
    {
    public:
      AdminRegionRef adminRegion; 
      PostalAreaRef  postalArea;  
      LocationRef    location;    
      AddressRef     address;     
    };

  private:
    size_t                   limit;

  public:
    std::list<AddressResult> results;
    bool                     limitReached;

  public:
    explicit AddressListVisitor(size_t limit);

    bool Visit(const AdminRegion& adminRegion,
               const PostalArea& postalArea,
               const Location& location,
               const Address& address) override;
  };

  class OSMSCOUT_API Place
  {
  private:
    ObjectFileRef         object;         
    FeatureValueBufferRef objectFeatures; 
    AdminRegionRef        adminRegion;    
    PostalAreaRef         postalArea;     
    POIRef                poi;            
    LocationRef           location;       
    AddressRef            address;        

  public:
    Place(const ObjectFileRef& object,
          const FeatureValueBufferRef& objectFeatureBuff,
          const AdminRegionRef& adminRegion,
          const PostalAreaRef& postalArea,
          const POIRef& poi,
          const LocationRef& location,
          const AddressRef& address);

    inline ObjectFileRef GetObject() const
    {
      return object;
    }

    inline FeatureValueBufferRef GetObjectFeatures() const
    {
      return objectFeatures;
    }

    inline AdminRegionRef GetAdminRegion() const
    {
      return adminRegion;
    }

    inline PostalAreaRef GetPostalArea() const
    {
      return postalArea;
    }

    inline POIRef GetPOI() const
    {
      return poi;
    }

    inline LocationRef GetLocation() const
    {
      return location;
    }


    inline AddressRef GetAddress() const
    {
      return address;
    }

    std::string GetDisplayString() const;
  };
}

#endif