otbOSMDataToVectorDataGenerator.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
 
#ifndef otbOSMDataToVectorDataGenerator_h
#define otbOSMDataToVectorDataGenerator_h
 
// store the nodes (points) coordinates
#include <map>
#include <string>
 
#include "OTBCartoExport.h"
#include "itkMacro.h"
#include "otbVectorData.h"
#include "otbVectorDataSource.h"
 
#include "otbCurlHelper.h"
 
namespace otb
{
 
class OTBCarto_EXPORT OSMDataToVectorDataGenerator : public VectorDataSource<otb::VectorData<>>
{
public:
  typedef OSMDataToVectorDataGenerator        Self;
  typedef VectorDataSource<otb::VectorData<>> Superclass;
  typedef itk::SmartPointer<Self>             Pointer;
  typedef itk::SmartPointer<const Self>       ConstPointer;
 
  typedef Superclass::OutputVectorDataType VectorDataType;
  typedef VectorDataType::DataNodeType     DataNodeType;
  typedef DataNodeType::LineType           LineType;
  typedef DataNodeType::PolygonType        PolygonType;
  typedef LineType::VertexType             VertexType;
 
  // typedefs for objects to store results
  typedef std::map<int, VertexType> ContainerType;
 
  // Vector to store <Key, value>
  typedef std::pair<std::string, std::string> ElementPairType;
 
  // Coordinates of the nodes
  typedef std::vector<VertexType> PointTypeList;
  typedef std::pair<ElementPairType, PointTypeList> VectorDataElementType;
  typedef std::vector<VectorDataElementType> VectorDataElementListType;
 
  // Map to store all the keys found and their relative types
  typedef std::vector<std::string> StringVectorType;
  typedef std::map<std::string, StringVectorType> KeyMapType;
 
  itkTypeMacro(OSMDataToVectorDataGenerator, VectorDataSource);
 
  itkNewMacro(Self);
 
  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);
 
  itkSetMacro(North, double);
  itkSetMacro(South, double);
  itkSetMacro(East, double);
  itkSetMacro(West, double);
 
  itkGetMacro(North, double);
  itkGetMacro(South, double);
  itkGetMacro(East, double);
  itkGetMacro(West, double);
 
  itkGetConstMacro(ClassKey, std::string);
  itkSetMacro(ClassKey, std::string);
 
  itkGetConstMacro(ClassKeyValue, int);
  itkSetMacro(ClassKeyValue, int);
 
  /* flag to choose between requesting the url using curl or a file
   in the disk */
  itkSetMacro(UseUrl, bool);
 
  void AddKey(const std::string& key)
  {
    if (!this->IsKeyPresent(key))
      m_KeyList.push_back(key);
  }
 
  const KeyMapType GetKeysMap() const
  {
    return m_KeysMap;
  }
 
  const VectorDataType* GetVectorDataByName(const std::string& key);
 
  const VectorDataType* GetVectorDataByName(const std::string& key, const std::string& value);
 
protected:
  void GenerateData() override;
 
  void ParseXmlFile();
 
  void ProcessVectorData(const std::string& key, const std::string& value);
 
  bool IsKeyPresent(const std::string& key);
 
 
  OSMDataToVectorDataGenerator();
  ~OSMDataToVectorDataGenerator() override;
 
private:
  OSMDataToVectorDataGenerator(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  // Private method to add the key, type to the map
  void AddKeyTypeToMap(const std::string& key, const std::string& value);
 
  // Extent of the region to get from OSM
  double m_North;
  double m_South;
  double m_East;
  double m_West;
 
  std::string m_Url;
  bool        m_UseUrl;
 
  std::vector<std::string> m_KeyList;
 
  std::string               m_FileName;
  ContainerType             m_GeoPointContainer;
  VectorDataElementListType m_VectorDataElementList;
 
  CurlHelper::Pointer m_Curl;
 
  VectorDataType::Pointer m_OutputVectorData;
 
  KeyMapType m_KeysMap;
 
  std::string m_ClassKey;
  int         m_ClassKeyValue;
 
}; // end of class
 
} // end of namespace otb
 
#endif