datasourcecapabilities.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_DATASOURCEINFO_DATASOURCECAPABILITIES_H
#define SOMAIO_DATASOURCEINFO_DATASOURCECAPABILITIES_H
//--- soma-io ----------------------------------------------------------------
#include <soma-io/config/soma_config.h>
//--- cartobase --------------------------------------------------------------
#include <cartobase/smart/rcptr.h>
//----------------------------------------------------------------------------

namespace soma
{
  class DataSource;

  class DataSourceCapabilities
  {
    public:
      DataSourceCapabilities();
      DataSourceCapabilities( const DataSourceCapabilities & );
      virtual ~DataSourceCapabilities();

      //======================================================================
      //   A C C E S S O R S
      //======================================================================
      bool  allowsMemoryMapping() const;
      bool  isThreadSafe()        const;
      bool  isOrdered()           const;
      bool  canSeekVoxel()  const;
      bool  canSeekLine()   const;
      bool  canSeekSlice()  const;
      bool  canSeekVolume() const;
      bool  isRandomAccessEfficient() const;
      bool  canHandleStrides() const;

      carto::rc_ptr<DataSource>  mappableDataSource() const;

      //======================================================================
      //   M U T A T O R S
      //======================================================================
      void  setMemoryMapping  ( const bool & boo = true );
      void  setThreadSafe     ( const bool & boo = true );
      void  setOrdered        ( const bool & boo = true );
      void  setSeekVoxel      ( const bool & boo = true );
      void  setSeekLine       ( const bool & boo = true );
      void  setSeekSlice      ( const bool & boo = true );
      void  setSeekVolume     ( const bool & boo = true );
      void  setRandomAccessEfficient( const bool & boo = true );
      void  setHandleStrides  ( const bool & boo = true );

      void  setDataSource( const carto::rc_ptr<DataSource> ds );

      //======================================================================
      //   I N I T I A L I Z E D
      //======================================================================
      bool  isInit() const;
      void  setInit( const bool & boo = true );
      void  reset();

    protected:
      unsigned int _capabilities;
      carto::rc_ptr<DataSource>  _mds;
  };

}

#endif