IMP  2.2.1
The Integrative Modeling Platform
IMP::core::SingletonConstraint Class Reference

Apply a SingletonFunction to a Singleton. More...

#include <IMP/core/SingletonConstraint.h>

+ Inheritance diagram for IMP::core::SingletonConstraint:

Public Member Functions

 SingletonConstraint (SingletonModifier *before, SingletonDerivativeModifier *after, kernel::Particle *vt, std::string name="SingletonConstraint %1%")
 
 SingletonConstraint (SingletonModifier *before, SingletonDerivativeModifier *after, kernel::Model *m, kernel::ParticleIndex vt, std::string name="SingletonConstraint %1%")
 
virtual std::string get_type_name () const
 
virtual ::IMP::base::VersionInfo get_version_info () const
 Get information about the module and version of the object.
 
- Public Member Functions inherited from IMP::kernel::Constraint
 Constraint (kernel::Model *m, std::string name="Constraint %1%")
 
virtual void do_after_evaluate (DerivativeAccumulator *da)
 
virtual void do_before_evaluate ()
 
- Public Member Functions inherited from IMP::kernel::ScoreState
 ScoreState (kernel::Model *m, std::string name)
 
void after_evaluate (DerivativeAccumulator *accpt)
 Do post evaluation work if needed.
 
void before_evaluate ()
 Force update of the structure.
 
- Public Member Functions inherited from IMP::kernel::ModelObject
 ModelObject (kernel::Model *m, std::string name)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed.
 
bool get_has_required_score_states () const
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 
void set_has_dependencies (bool tf)
 
void set_has_required_score_states (bool tf)
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual void do_destroy ()
 
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)
 

Protected Member Functions

virtual kernel::ModelObjectsTemp do_get_inputs () const
 
virtual kernel::ModelObjectsTemp do_get_outputs () const
 
void do_update_attributes ()
 
void do_update_derivatives (DerivativeAccumulator *da)
 
- Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 

Detailed Description

The score state is passed up to two SingletonModifiers, one to apply before evaluation and the other after. The one after should take a DerivativeAccumulator as its last argument for SingletonModifier::apply() and will only be called if the score was computed with derivatives.

See Also
container::SingletonsConstraint

Definition at line 30 of file SingletonConstraint.h.

Constructor & Destructor Documentation

IMP::core::SingletonConstraint::SingletonConstraint ( SingletonModifier before,
SingletonDerivativeModifier *  after,
kernel::Particle vt,
std::string  name = "SingletonConstraint %1%" 
)
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the model/index constructor.

Definition at line 42 of file SingletonConstraint.h.

Member Function Documentation

virtual kernel::ModelObjectsTemp IMP::core::SingletonConstraint::do_get_inputs ( ) const
protectedvirtual

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::kernel::ModelObject.

virtual kernel::ModelObjectsTemp IMP::core::SingletonConstraint::do_get_outputs ( ) const
protectedvirtual

Get any Particle, Container or other ModelObjects changed by this during evaluation. This is only useful for ScoreStates, at the moment.

Implements IMP::kernel::ModelObject.


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