IImportRDB.hpp

#pragma once
 
//DM
#include "DM/config.hpp"
#include "DM/AutoLink.hpp" //enable autolink
 
#include "DM/ColumnTypes.hpp"
#include "DM/IO/IImport.hpp"
 
DM_NAMESPACE_BEGIN
 
/// Specific import class for handling shape file imports
class DM_API IImportRDB : public virtual IImport 
{
public:
  enum struct StorageClass
  {
    constant = 1, ///< value cannot be changed
    variable = 2, ///< value can change from time to time
    dynamic = 3   ///< value is likely to be changed often
  };
 
  enum struct CompressionOptions
  {
    default_ = 0,     ///< nothing special, just use default compression algorithm
    delta = 1,        ///< calculate differences between two consecutive values
    shuffle = 2,      ///< shuffle bytes of point attribute values
    delta_shuffle = 3 ///< calculate differences and shuffle bytes
  };
 
  struct Attribute {
    char        name[64];                   ///< unique attribute name (for queries) \see details of class PointAttribute
    char        title[64];                  ///< attribute title (for display)
    char        description[255];           ///< attribute description (for display)
    char        unitSymbol[16];             ///< physical unit symbol (e.g. "m", "rad", "K")
    uint32_t    length;                     ///< number of dimensions/elements (1: scalar, >1: vector, e.g. 3 for point coordinates)
    double      resolution;                 ///< expected value resolution
    double      minimumValue;               ///< theoretical minimum value
    double      maximumValue;               ///< theoretical maximum value
    double      defaultValue;               ///< default value (minimum <= default <= maximum)
    double      invalidValue;               ///< invalid value (minimum <= invalid <= maximum, use "not-a-number" if there is no invalid value)
    ColumnType  dataType;                   ///< data type
    StorageClass        storageClass;       ///< storage class \see enum StorageClass
    CompressionOptions  compressionOptions; ///< options additional to default compression
  };
 
  struct MappingEntry {
    char        rdbName[64];  
    char        toDM[1024];  
    char        toRDB[1024];
  };
  /// check if there is a default mapping with an DM column and an rdb attribute
  static bool columnToRDBAttribute(ColumnSemantic dmCol, MappingEntry &entry);
  static bool columnToRDBAttribute(const char*  dmColName, MappingEntry &entry);
 
  static IImportRDB* New( const char *file, RDBCoordSystem coordsys = RDBCoordSystem::default_,
                            FilterHandle filter = FilterHandle(), ControlObjectHandle control = ControlObjectHandle(),
                            bool collectHdrContents = false, unsigned maxBulkPoints = 1000, AddInfoLayoutHandle defaultLayout = AddInfoLayoutHandle() );
 
protected:
  virtual ~IImportRDB() {}
 
public:
  /// get number of attribute (available after header was read)
  virtual unsigned getAttributeCount() const = 0;
  /// get corresponding attribute record (available after header was read)
  virtual void     getAttribute(unsigned idx, Attribute &attr) const = 0;
 
  /// Specify a predefined NG-attribute by its enum. The rdb attribute's type will be converted to that of the predefined attribute
  virtual void importAttribute(int rdbAttrIndex, int arrayIdx = 0, ColumnSemantic ngCol = ColumnSemantic::null, const char* filterString = "") = 0;
  /// Specify the NG-attribute by name. By default, use the name and type of the rdb attribute
  virtual void importAttribute(int rdbAttrIndex, int arrayIdx = 0, const char* ngName = 0, ColumnType ngType = ColumnType::count, const char* filterString = "") = 0;
};
 
typedef Handle<IImportRDB> ImportRDBHandle;
 
DM_NAMESPACE_END