IImportAny.hpp

#pragma once
 
//DM
#include "DM/config.hpp"
#include "DM/AutoLink.hpp" //enable autolink
 
#include "DM/ColumnTypes.hpp"
#include "DM/IO/IImport.hpp"
#include "DM/Any.hpp"
 
DM_NAMESPACE_BEGIN
 
/// \brief generic import for pretty much any ascii or binary original geometry data file
class DM_API IImportAny : public virtual IImport 
{
public:
  /// \brief creates new generic import object
  /**
    interface for importing point objects in a generic way. The import bascially supports (not to complex) ascii and binary formats.
    \param[in]  file                filename
    \param[in]  ascii               flag if import should read file in ascii mode (true) of in binary mode (false)
    \param[in]  filter              filter for subselecting/transforming objects during export
    \param[in]  control             control object for retrieving export progress information
    \param[in]  collectHdrContents  flag for explicitly collecting header information while exporting
    \param[in]  maxBulkPoints       chunk size for bulk points being imported at once
  */
  static IImportAny* New( const char *file, bool ascii, FilterHandle filter = FilterHandle(),
                          ControlObjectHandle control = ControlObjectHandle(), 
                          bool collectHdrContents = false, unsigned maxBulkPoints = 1000 );
 
protected:
  virtual ~IImportAny() {}
 
public:
  // ascii only
  virtual void setColumnSeparators( const char *separators ) = 0;     ///< set seperator character (ascii only)
  virtual void setCommentInitiator( const char *commentInit ) = 0;    ///< set comment initiator (ascii only)
  virtual void setDecimalSeparator( char decimalSeparator ) = 0;      ///< set decimal seperator (ascii only)
  virtual void skipWhiteSpace( bool skip ) = 0;                       ///< flag if white spaces should be skipped (ascii only)
  virtual void setHeaderLineCount( unsigned count ) = 0;              ///< set number of header lines that should be ignored (ascii only)
 
  // binary only
  virtual void setHeaderBytes( unsigned count ) = 0;                  ///< set header bytes that should be ignored (binary only)
  virtual void setEndianness( Endianness endian ) = 0;          ///< set endianness type (binary only)
 
  // ascii and binary
  virtual void setHeaderText( const char *text ) = 0;                 ///< set (optional) header text (ascii and binary)
  virtual void throwIfXYMissing( bool doThrow ) = 0;                  ///< flag to throw exception if x and y coordinates are not set (ascii and binary)
 
  /// \name data block
  /// specify the sequence of coordinates and attributes to be imported, and optionally, characters/bytes to be ignored. The order is important!
  //@{
  virtual void addCoordX( ColumnType externalType = ColumnType::count, const char* converterStr = 0 ) = 0;
  virtual void addCoordY( ColumnType externalType = ColumnType::count, const char* converterStr = 0 ) = 0;
  virtual void addCoordZ( ColumnType externalType = ColumnType::count, const char* converterStr = 0 ) = 0;
 
  // attrib: the attribute enum
  // externalType: use that type for reading, then convert to attribute's internal type. default: same as internal type
  // invalidValue: if specified, consider this value as invalid, generate no attribute. Must be of type externalType
  //void addAttrib( unsigned colPos, ColumnType externalType = ColumnType::count, const DM::Any &invalidValue = DM::Any() );
  virtual void addAttrib( ColumnSemantic attrib, ColumnType externalType = ColumnType::count, const DM::Any &invalidValue = DM::Any(), const char* converterStr = 0, const char *quoteStr = 0 ) = 0;
 
  virtual void addAttrib( const char *name, ColumnType internalType, ColumnType externalType = ColumnType::count, const DM::Any &invalidValue = DM::Any(), const char * converterStr = 0, const char *quoteStr = 0)  = 0;
  
  /// skip count columns (ascii) / bytes (binary)
  virtual void addSkip( unsigned count = 1 ) = 0;
 
  /// ascii only: if present, store the rest of each line following the specified coordinates/attributes as a custom attribute with name 'attrName' of type string
  virtual void storeRest( const char* attrName ) = 0;
  //}@
 
};
 
typedef Handle<IImportAny> ImportAnyHandle;
 
DM_NAMESPACE_END