formatreader.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.
 */

#ifndef SOMAIO_READER_FORMATREADER_H
#define SOMAIO_READER_FORMATREADER_H
//--- soma-io ----------------------------------------------------------------
#include <soma-io/config/soma_config.h>
//--- cartobase --------------------------------------------------------------
#include <cartobase/object/object.h>
//--- system -----------------------------------------------------------------
#include <string>
//----------------------------------------------------------------------------

namespace carto {
  template<typename T> class rc_ptr;
  class Object;
}

namespace soma
{
  class DataSource;
  class DataSourceInfo;
  class AllocatorContext;
  
  template<typename T>
  class FormatReader
  {
  public:
    virtual ~FormatReader();

    //========================================================================
    //   N E W   M E T H O D S
    //========================================================================
    virtual void setupAndRead( T & obj, carto::rc_ptr<DataSourceInfo> dsi,
                               const AllocatorContext & context,
                               carto::Object options );

    virtual T* createAndRead( carto::rc_ptr<DataSourceInfo> dsi,
                              const AllocatorContext & context,
                              carto::Object options );

    virtual void read( T & obj, 
                       carto::rc_ptr<DataSourceInfo> dsi, 
                       const AllocatorContext & context, 
                       carto::Object options );

    virtual FormatReader<T>* clone() const = 0;

    virtual std::string formatID() const = 0;

    virtual carto::rc_ptr<DataSourceInfo> checkDataSourceInfo(
      carto::rc_ptr<DataSourceInfo> dsi, carto::Object options );

    //========================================================================
    //   S T I L L   U S E D
    //========================================================================
    virtual T* create( carto::Object header, 
                       const AllocatorContext & context, 
                       carto::Object options );
    virtual void setup( T & obj, carto::Object header, 
                        const AllocatorContext & context, 
                        carto::Object options );

  };

  extern template class FormatReader<carto::GenericObject>;
  extern template class FormatReader<carto::Object>;
}

#endif