kernel/PairModifier.h

Go to the documentation of this file.

/**
 *  \file IMP/kernel/PairModifier.h
 *  \brief A Modifier on kernel::ParticlePairsTemp
 *
 *  WARNING This file was generated from PairModifier.h
 *  in /tmp/nightly-build-29065/imp-2.3.1/tools/build/container_templates/kernel
 *  by tools/build/make_containers.py.
 *
 *  Copyright 2007-2014 IMP Inventors. All rights reserved.
 */

#ifndef IMPKERNEL_PAIR_MODIFIER_H
#define IMPKERNEL_PAIR_MODIFIER_H

#include <IMP/kernel/kernel_config.h>
#include "DerivativeAccumulator.h"
#include "base_types.h"
#include "ParticleTuple.h"
#include "internal/container_helpers.h"
#include "model_object_helpers.h"

IMPKERNEL_BEGIN_NAMESPACE

//! A base class for modifiers of kernel::ParticlePairsTemp
/** The primary function of such a class is to change
    the passed particles.

    \see IMP::PairFunctor

    Implementors should see IMP_PAIR_MODIFIER(). Also see
    PairDerivativeModifier.
 */
class IMPKERNELEXPORT PairModifier : public ParticleInputs,
                                          public ParticleOutputs,
                                          public base::Object {
 public:
  typedef kernel::ParticlePair Argument;
  typedef kernel::ParticleIndexPair IndexArgument;
  PairModifier(std::string name = "PairModifier %1%");

  /** \deprecated_at{2.1} use the index version instead*/
  IMPKERNEL_DEPRECATED_METHOD_DECL(2.1)
  virtual void apply(const kernel::ParticlePair& vt) const;

  /** Apply the function to a single value*/
  virtual void apply_index(kernel::Model *m, const kernel::ParticleIndexPair& v) const;

  /** Apply the function to a collection of kernel::ParticlePairsTemp */
  /** If bounds are passed, only apply to ones between the upper and
      lower bounds.*/
  virtual void apply_indexes(kernel::Model *m, const kernel::ParticleIndexPairs &o,
                             unsigned int lower_bound,
                             unsigned int upper_bound) const {
    for (unsigned int i = lower_bound; i < upper_bound; ++i) {
      apply_index(m, o[i]);
    }
  }
};

IMPKERNEL_END_NAMESPACE

#endif /* IMPKERNEL_PAIR_MODIFIER_H */