IExportShape.hpp

#pragma once
 
//DM
#include "DM/config.hpp"
#include "DM/AutoLink.hpp" //enable autolink
 
#include "DM/ColumnTypes.hpp"
#include "DM/IAddInfoLayout.hpp"
#include "DM/IO/IExport.hpp"
#include "DM/IO/IShapeTableDefinition.hpp"
 
DM_NAMESPACE_BEGIN
 
enum struct ShapeGeometry
{
  none       = 0,
 
  point2d    = 1,
  polyline2d = 3,
  polygon2d  = 5,
  pointSet2d = 8, 
 
  point      = 11,
  polyline   = 13,
  polygon    = 15,
  pointSet   = 18
 
  //SHPT_POINTM 21
  //SHPT_ARCM 23
  //SHPT_POLYGONM 25
  //SHPT_MULTIPOINTM 28
  //SHPT_MULTIPATCH 31
};
 
/// Specific import class for handling shape file imports
class DM_API IExportShape : public virtual IExport 
{
public:
  static IExportShape* New( const char *file, FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(), 
                            const AddInfoLayoutHandle &layout = AddInfoLayoutHandle(), 
                            ShapeTableDefinitionHandle dbfTable = ShapeTableDefinitionHandle(),
                            int idCountIdx = -1,
                            int semanticColIdx = -1,
                            unsigned mapSize = 0, std::pair<int, const char*> *translationMap = 0);
 
protected:
  virtual ~IExportShape() {}
 
public:
  /// \brief set shape geometry type (optional)
  /** The shape format only one geometry type. Setting the corresponding type is not necessary, since it is automatically determined
      based on the first geometry that is exported. Please note that point data are usually exported as pointsets using a default chunk 
      size of 1000 points. To force each point written as a separate object, set type ShapeGeometry::point (or ShapeGeometry::point2d).
      This allows exporting attributes (within the dbf file) for each point.
      NOTE: this function must be called before the first object is exported
  */
  virtual void setShapeGeometryType(ShapeGeometry type) = 0;
 
  /// \brief setting this flag prevents the export of throwing an exception if geometries that do not match the shape geometry type are tried to export 
  virtual void setSkipUnmatchTypesFlag(bool skipUnmatchTypes) = 0;
 
  /// \brief set a mapping between dbf attributes and an add info layout for importing the attribute information as well
  /** This is optional import definition must be set before the first element (and file header) is read. If nothing is set no
      dbf attributes will be imported. 
      \param[in] layout       layout that should be attached to each geometry object
      \param[in] dbfTable     size of the idxMap, which has to be a corresponding C array
      \param[in] idCounterIdx output a counter id at the given column index
   */
  virtual void setAttributeMapping(AddInfoLayoutHandle layout, ShapeTableDefinitionHandle dbfTable, int idCounterIdx = -1) = 0;
 
  /// \brief set a translation map between the scop sematic and dbf attribute value 
  /** This is optional import definition must be set before the first element (and file header) is read.
      \param[in] columnIdx      index of the dbf attribute to be used
      \param[in] mapSize        size of the idxMap, which has to be a corresponding C array
      \param[in] translationMap C array mapping string values (first value of std::pair) to the scop semantic (second value of std::pair)
   */
  virtual void setSemanticTranslation(unsigned columnIdx, unsigned mapSize, std::pair<int, const char*> *translationMap ) = 0;
 
};
 
typedef Handle<IExportShape> ExportShapeHandle;
 
DM_NAMESPACE_END