IImportAny.hpp

#ifndef DM_IO_IMPORT_ANY_HPP_INCLUDED
#define DM_IO_IMPORT_ANY_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

//DM
#include "DM/config.hpp"
#include "DM/AutoLink.hpp" //enable autolink

#include "DM/ColumnTypes.hpp"
#include "DM/IO/IImport.hpp"

//boost
#include <boost/any.hpp>

DM_NAMESPACE_BEGIN

class DM_API IImportAny : public virtual IImport 
{
public:
  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;
  virtual void setCommentInitiator( const char *commentInit ) = 0;
  virtual void setDecimalSeparator( char decimalSeparator ) = 0;
  virtual void skipWhiteSpace( bool skip ) = 0;
  virtual void setHeaderLineCount( unsigned count ) = 0;

  // binary only
  virtual void setHeaderBytes( unsigned count ) = 0;
  virtual void setEndianness( Endianness::Type endian ) = 0;

  // ascii and binary
  virtual void setHeaderText( const char *text ) = 0;
  virtual void throwIfXYMissing( bool doThrow ) = 0;

  /// \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::Type externalType = ColumnType::count, const char* converterStr = 0 ) = 0;
  virtual void addCoordY( ColumnType::Type externalType = ColumnType::count, const char* converterStr = 0 ) = 0;
  virtual void addCoordZ( ColumnType::Type 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::Type externalType = ColumnType::count, const boost::any &invalidValue = boost::any() );
  virtual void addAttrib( ColumnSemantic::Type attrib, ColumnType::Type externalType = ColumnType::count, const boost::any &invalidValue = boost::any(), const char* converterStr = 0 ) = 0;

  virtual void addAttrib( const char *name, ColumnType::Type internalType, ColumnType::Type externalType = ColumnType::count, const boost::any &invalidValue = boost::any(), const char * converterStr = 0 )  = 0;
  
  // ascii:  skip count columns
  // binary: skip count bytes
  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

#endif //DM_IO_IMPORT_BASE_HPP_INCLUDED