TableRefiner.h

Go to the documentation of this file.

/**
 *  \file IMP/core/TableRefiner.h
 *  \brief A lookup based particle refiner
 *
 *  Copyright 2007-2013 IMP Inventors. All rights reserved.
 */

#ifndef IMPCORE_TABLE_REFINER_H
#define IMPCORE_TABLE_REFINER_H

#include <IMP/core/core_config.h>

#include <IMP/Refiner.h>
#include <IMP/refiner_macros.h>
#include <IMP/base/map.h>
IMPCORE_BEGIN_NAMESPACE

//! A lookup based particle refiner
/** Each particle is refined by returning the list
    of particles stored for it in a table.
 */
class IMPCOREEXPORT TableRefiner : public Refiner {
  IMP::base::map<kernel::Particle *, kernel::Particles> map_;

 public:
  //! Initialize it with an empty table
  TableRefiner();

  //! Add a mapping to the table
  void add_particle(kernel::Particle *p, const kernel::ParticlesTemp &ps);

  //! Remove a mapping from the table
  void remove_particle(kernel::Particle *p);

  //! Set the mapping for a particular particle
  void set_particle(kernel::Particle *p, const kernel::ParticlesTemp &ps);

  virtual bool get_can_refine(kernel::Particle *) const IMP_OVERRIDE;
  virtual const kernel::ParticlesTemp get_refined(kernel::Particle *) const
      IMP_OVERRIDE;
#ifndef SWIG
  using Refiner::get_refined;
#endif
  virtual kernel::ModelObjectsTemp do_get_inputs(
      kernel::Model *m, const kernel::ParticleIndexes &pis) const IMP_OVERRIDE;
  IMP_OBJECT_METHODS(TableRefiner);
};

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_TABLE_REFINER_H */