IFileHeader.hpp

#pragma once
 
#include "DM/config.hpp"
#include "DM/AutoLink.hpp" //enable autolink
#include "DM/Handle.hpp"
#include "DM/ObjectBase.hpp"
#include "DM/IBox.hpp"
#include "DM/IAddInfoLayout.hpp"
 
#include <memory>
 
DM_NAMESPACE_BEGIN
 
/// coordinate reference system type 
enum struct CoordRefSys
{
    none,             ///< not definied/unset
    internallyStored, ///< crs is stored internally
    separatePrjFile   ///< crs is stored in a separate prj file
};
 
enum struct RDBCoordSystem 
{
  proj, ///< application/project coordinate system (cartesian coordinates) -> default
  ecef, ///< earth-centered earth-fixed coordinate system (cartesian coordinates)
  scs,  ///< sensor coordinate system
  map,  ///< map coordinate system (not necessarily available)
  default_ = proj
};
 
/// interface for describung attributs of geometry objects
class DM_API IFileAttribute : public ObjectBase
{
protected:
  virtual ~IFileAttribute() {}
 
public:
  virtual const char* getName() const = 0;
  virtual const char* getDescription() const = 0;
  virtual uint32_t    getElementCount() const = 0;  ///< number of elements (typically 1)
  virtual ColumnType  getType() const = 0;
  
  virtual double      getScale()  const = 0;
  virtual double      getOffset() const = 0;
 
  virtual bool        hasInvalidValue() const = 0;
  virtual double      getInvalidValue() const = 0;
 
  /// get the index of attribute within the data layout 
  /**
      For import classes that provide configurable attribute import, the layout index can only be access AFTER prepareForReading was called, 
      since the actual data layout and the corresponding indices are typcially constructed/collected there.
  */
  virtual int32_t     getDataLayoutIndex() const = 0;
 
  //list of supported properties
  // ODM/LAS format:
  //    HasMinimumValue     bool
  //    MinimumValue        double
  //    HasMaximumValue     bool
  //    MaximumValue        double  
  //    
  // RDB format:
  //    Title                char
  //    UnitSymbol           char
  //    Scale/Resolution     double
  //    LowestPossibleValue  double
  //    HighestPossibleValue double
  //    DefaultValue         double
  //    InvalidValue         double
  //    StorageClass         unsigned
  //    CompressionOptions   unsigned
  //
  // Shape format:
  //    Width               unsigned
  //    Decimals            unsigned
  virtual bool getProperty(const char* name, bool &value) const = 0;
  virtual bool getProperty(const char* name, unsigned &value) const = 0;
  virtual bool getProperty(const char* name, long long &value) const = 0;
  virtual bool getProperty(const char* name, double &value) const = 0;
  virtual bool getProperty(const char* name, const char *&value) const = 0;
};
 
typedef Handle<IFileAttribute> FileAttributeHandle;
 
 
class DM_API IFileHeader : public ObjectBase 
{
protected:
  virtual ~IFileHeader() {}
 
public:
  virtual long long getPointCount()         const = 0;
  virtual long long getLineCount()          const = 0;
  virtual long long getLinePointCount()     const = 0;
  virtual long long getPolygonCount()       const = 0;
  virtual long long getPolygonPointCount()  const = 0;
 
  /// get the bounding box of the data set
  virtual BoxHandle getBoundingBox()  const = 0;
 
  /// The 'epsilon' of coordinates (e.g. coordinates with mm-precision: 0.001)
  /// Relevant only for ASCII files.
  virtual void getPrecision( double& precX, double& precY, double& precZ ) const = 0;
 
  /// The highest dimensionality of contained geometries (e.g. 0 for points)
  virtual int getDim() const = 0;
 
  /// Get coordinate reference system as WKT string (can be empty)
  virtual const char* getCRS() const = 0;
  /// Get coordinate reference system type (enum if stored internally or a separate ".prj" file)
  virtual CoordRefSys getCRSType() const = 0;
 
  /// Get the attribute layout of the data that will be returned by the import object
  /** 
      The returned layout is merged from the provided layout during import object creation and the actual import attribute layout. For
      import classes that provide configurable attribute import, the layout can only be access AFTER prepareForReading was called, since
      there the actual data layout is typcially constructed. 
  */
  virtual AddInfoLayoutHandle getDataLayout() const = 0;
  
  /// if the file format contains attribute information, the number of attribute can be accessed here
  virtual uint32_t getAttributeCount() const = 0;
  /// get the attribute object ( 0 <= idx < getAttributeCount() )
  virtual const IFileAttribute& getAttribute(uint32_t idx) const = 0;
 
  //list of supported properties
  // GDAL format:
  //    GridWidthX  double
  //    GridWidthY  double
  // LAS format:
  //    MajorVersion      unsigned
  //    MinorVersion      unsigned
  //    PointRecordFormat unsigned
  // RDB format:
  //    Pose              double[16]
 
  virtual bool getProperty(const char* name, unsigned &value) const = 0;
  virtual bool getProperty(const char* name, long long &value) const = 0;
  virtual bool getProperty(const char* name, double &value) const = 0;
  virtual bool getProperty(const char *name, const char *&value) const = 0;
  virtual bool getProperty(const char* name, unsigned arrayCount, double *value) const = 0;
};
 
typedef Handle<IFileHeader> FileHeaderHandle;
 
DM_NAMESPACE_END