writer.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */

/*
 *  Data reader class
 */
#ifndef AIMS_IO_WRITER_H
#define AIMS_IO_WRITER_H

#include <cartobase/object/object.h>


namespace aims
{

  class GenericWriter
  {
  public:
    inline GenericWriter() {};
    inline GenericWriter( const std::string& filename,
                          carto::Object options = carto::none() ) :
      _filename( filename ), _options( options ) {}
    virtual ~GenericWriter() {}

    template <typename T>
    bool write( const T & obj, bool ascii = false,
                const std::string* format = 0 );

    inline void setFileName( const std::string &fileName )
    {
      _filename = fileName;
    }
    inline const std::string &fileName() const { return _filename; }
    const carto::Object options() const { return _options; }
    void setOptions( carto::Object opt ) { _options = opt; }

    virtual std::string writtenObjectType() const = 0;
    virtual std::string writtenObjectDataType() const = 0;
    virtual std::string writtenObjectFullType() const = 0;

  protected:
    std::string _filename;
    carto::Object _options;

  };

  template<class T> class Writer : public GenericWriter
  {
  public:
    inline Writer() {};
    inline Writer( const std::string& filename,
                   carto::Object options = carto::none() ) :
      GenericWriter( filename, options ) {}
    virtual ~Writer() {}

    virtual bool write( const T & obj, bool ascii = false,
                        const std::string* format = 0 );

    virtual std::string writtenObjectType() const;
    virtual std::string writtenObjectDataType() const;
    virtual std::string writtenObjectFullType() const;
  };

  template <class T>
  inline aims::GenericWriter &
  operator << ( aims::GenericWriter & writer, const T & thing )
  {
    writer.write( thing );
    return writer;
  }


  template <class T>
  inline aims::Writer<T> &
  operator << ( aims::Writer<T> & writer, const T & thing )
  {
    writer.write( thing );
    return writer;
  }

}


#endif