IMP::spb::NuisanceRangeModifier Class Reference

Ensure that a Nuisance stays within its set range. More...

#include <IMP/spb/NuisanceRangeModifier.h>

Inheritance diagram for IMP::spb::NuisanceRangeModifier:

Detailed Description

Ensure that a Nuisance stays within its set range.

Definition at line 19 of file NuisanceRangeModifier.h.

Public Member Functions
virtual void	apply_index (IMP::Model *m, IMP::ParticleIndex p) const override
virtual void	apply_indexes (Model *m, const ParticleIndexes &o, unsigned int lower_bound, unsigned int upper_bound) const overridefinal
virtual IMP::ModelObjectsTemp	do_get_inputs (IMP::Model *m, const IMP::ParticleIndexes &pis) const override
	Overload this method to specify the inputs. More...
virtual IMP::ModelObjectsTemp	do_get_outputs (IMP::Model *m, const IMP::ParticleIndexes &pis) const override
	Overload this method to specify the outputs. More...
virtual std::string	get_type_name () const override
virtual ::IMP::VersionInfo	get_version_info () const override
	Get information about the module and version of the object. More...
void	show (std::ostream &out=std::cout) const
Public Member Functions inherited from IMP::SingletonModifier
	SingletonModifier (std::string name="SingletonModifier %1%")
virtual void	apply_indexes_moved (Model *m, const ParticleIndexes &o, unsigned int lower_bound, unsigned int upper_bound, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const
Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp	get_inputs (Model *m, const ParticleIndexes &pis) const
	Get the ModelObjects read when the given list of particles is used. More...
Public Member Functions inherited from IMP::ParticleOutputs
ModelObjectsTemp	get_outputs (Model *m, const ParticleIndexes &pis) const
	Get the ModelObjects changed when the given list of particles is used. More...
Public Member Functions inherited from IMP::Object
virtual void	clear_caches ()
CheckLevel	get_check_level () const
LogLevel	get_log_level () const
void	set_check_level (CheckLevel l)
void	set_log_level (LogLevel l)
	Set the logging level used in this object. More...
void	set_was_used (bool tf) const
void	show (std::ostream &out=std::cout) const
const std::string &	get_name () const
void	set_name (std::string name)

Additional Inherited Members
Public Types inherited from IMP::SingletonModifier
typedef Particle *	Argument
typedef ParticleIndex	IndexArgument
Protected Member Functions inherited from IMP::Object
	Object (std::string name)
	Construct an object with the given name. More...
virtual void	do_destroy ()

Member Function Documentation

virtual void IMP::spb::NuisanceRangeModifier::apply_index ( IMP::Model *  m, IMP::ParticleIndex  v  ) const

overridevirtual

Apply the function to a single value

Implements IMP::SingletonModifier.

virtual void IMP::spb::NuisanceRangeModifier::apply_indexes ( Model *  m, const ParticleIndexes &  o, unsigned int  lower_bound, unsigned int  upper_bound  ) const

finaloverridevirtual

Apply the function to a collection of ParticlesTemp If bounds are passed, only apply to ones between the upper and lower bounds.

Reimplemented from IMP::SingletonModifier.

Definition at line 31 of file NuisanceRangeModifier.h.

virtual IMP::ModelObjectsTemp IMP::spb::NuisanceRangeModifier::do_get_inputs ( IMP::Model *  m, const IMP::ParticleIndexes &  pis  ) const

overridevirtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

virtual IMP::ModelObjectsTemp IMP::spb::NuisanceRangeModifier::do_get_outputs ( IMP::Model *  m, const IMP::ParticleIndexes &  pis  ) const

overridevirtual

Overload this method to specify the outputs.

Implements IMP::ParticleOutputs.

virtual ::IMP::VersionInfo IMP::spb::NuisanceRangeModifier::get_version_info ( ) const

overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 32 of file NuisanceRangeModifier.h.

---

The documentation for this class was generated from the following file:

• NuisanceRangeModifier.h