IExportAny.hpp

#ifndef DM_IO_EXPORT_ANY_HPP_INCLUDED
#define DM_IO_EXPORT_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/IExport.hpp"

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

DM_NAMESPACE_BEGIN

class DM_API IExportAny : public virtual IExport
{
public:
  static IExportAny* New( const char *file, bool ascii, FilterHandle filter = FilterHandle(), 
                          ControlObjectHandle control = ControlObjectHandle(), 
                          bool collectHdrContents = false, double invalidHeight = DBL_MAX );

protected:
  virtual ~IExportAny() {}

public:
  // ascii only
  virtual void setColumnSeparator( char separator ) = 0;
  virtual void setDecimalSeparator( char decimalSeparator ) = 0;

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

  virtual void setHeader( const char* text ) = 0;

  /// \name data block
  /// specify the sequence of coordinates and attributes to be imported, and optionally, characters/bytes to be ignored. Order matters!
  //@{
  virtual void addCoordX( ColumnType::Type externalType = ColumnType::count, const char* converterStr = 0, int width = -1, int precision = -1, bool alignRight = true ) = 0;
  virtual void addCoordY( ColumnType::Type externalType = ColumnType::count, const char* converterStr = 0, int width = -1, int precision = -1, bool alignRight = true ) = 0;
  virtual void addCoordZ( ColumnType::Type externalType = ColumnType::count, const char* converterStr = 0, int width = -1, int precision = -1, bool alignRight = true ) = 0;

  // (possibly) fast access to predefined attributes using enum
  // attrib: the attribute, e.g. eCOL_SIGMA_X
  // externalType: convert the attribute value to that type during export
  //               Default: use the internal data type of attrib
  // invalidValue: export that value in case attrib is not defined in the layout of the current point, of if it is null (not set).
  //               Default: the default-constructed (zero-) value for externalType.
  //               Must be of type externalType.
  // width, precision, alignRight: relevant for export to ascii-files only.
  virtual void addAttrib( ColumnSemantic::Type attrib, ColumnType::Type externalType = ColumnType::count, const boost::any &invalidValue = boost::any(), const char* converterStr = 0, 
                  int width = -1, int precision = -1, bool alignRight = true ) = 0;
  
  // not-so-fast access based on attribute name, which is the only alternative for the export of custom attributes.
  // Must specify an external type (the same for all points, while the internal type may differ between the attribute layouts of different points)
  virtual void addAttrib( const char *name, ColumnType::Type externalType, const boost::any &invalidValue = boost::any(), const char* converterStr = 0, 
                  int width = -1, int precision = -1, bool alignRight = true ) = 0;
  
  // Export a column/memory block of constant value at this point.
  virtual void addFill( const boost::any &value ) = 0;
  //}@

};

typedef Handle<IExportAny> ExportAnyHandle;

DM_NAMESPACE_END

#endif //DM_IO_EXPORT_ANY_HPP_INCLUDED