MapReaderWriter.h

Go to the documentation of this file.

/**
 *  \file IMP/em/MapReaderWriter.h
 *  \brief An abstract class for reading a map
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPEM_MAP_READER_WRITER_H
#define IMPEM_MAP_READER_WRITER_H

#include <IMP/em/em_config.h>
#include <IMP/Object.h>
#include "DensityHeader.h"
#include <IMP/object_macros.h>

IMPEM_BEGIN_NAMESPACE

/** \brief The base class to handle reading and writing of density maps.

    They should never be stored, only created immediately and passed to
    the read or write function.
 */
class IMPEMEXPORT MapReaderWriter : public IMP::Object {
 public:
  MapReaderWriter() : Object("MapReaderWriter%1%") {}
#if !defined(DOXYGEN) && !defined(SWIG)
  // since swig can't see these methods, it wants to create a wrapper
  // for the class
  virtual void read(const char *filename, float **data, DensityHeader &) {
    IMP_UNUSED(filename);
    IMP_UNUSED(data);
    IMP_FAILURE("Don't use the base class");
  };
  virtual void write(const char *filename, const float *data,
                     const DensityHeader &) {
    IMP_UNUSED(filename);
    IMP_UNUSED(data);
    IMP_FAILURE("Don't use the base class");
  };
#endif

  IMP_OBJECT_METHODS(MapReaderWriter);
};

IMPEM_END_NAMESPACE

#endif /* IMPEM_MAP_READER_WRITER_H */