IMP logo
IMP Reference Guide  develop.62cd6b8d93,2024/10/30
The Integrative Modeling Platform
IMP::core::SurfaceGeometryConstraint Class Reference

Constrain a SurfaceGeometry to a Surface. More...

#include <IMP/core/Surface.h>

+ Inheritance diagram for IMP::core::SurfaceGeometryConstraint:

Detailed Description

Constrain a SurfaceGeometry to a Surface.

Note
Use IMP.core.get_constrained_surface_geometry to create.

Definition at line 201 of file Surface.h.

Public Member Functions

 SurfaceGeometryConstraint (Surface s, SurfaceGeometry *g)
 
virtual void do_after_evaluate (DerivativeAccumulator *) override
 Do any necessary updates after the model score is calculated. More...
 
virtual void do_before_evaluate () override
 Update the state given the current state of the model. More...
 
virtual ModelObjectsTemp do_get_inputs () const override
 
virtual ModelObjectsTemp do_get_outputs () const override
 
virtual void do_update_attributes () override
 
virtual void do_update_derivatives (DerivativeAccumulator *) override
 
SurfaceGeometryget_geometry () const
 
Surface get_surface () const
 
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...
 
- Public Member Functions inherited from IMP::Constraint
 Constraint (Model *m, std::string name="Constraint %1%")
 
- Public Member Functions inherited from IMP::ScoreState
 ScoreState (Model *m, std::string name)
 
void after_evaluate (DerivativeAccumulator *accpt)
 Do post evaluation work if needed. More...
 
void before_evaluate ()
 Force update of the structure. More...
 
bool get_can_skip () const
 Get whether this state can be skipped if its inputs/outputs didn't move. More...
 
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
 
bool get_has_required_score_states () const
 Return whether score states are computed. More...
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
 
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
 
void set_has_required_score_states (bool tf)
 Compute the required score states. 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

- Protected Member Functions inherited from IMP::ScoreState
void set_can_skip (bool can_skip)
 Set whether we can skip during model evaluation if appropriate. More...
 
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- 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::core::SurfaceGeometryConstraint::do_after_evaluate ( DerivativeAccumulator accpt)
overridevirtual

Do any necessary updates after the model score is calculated.

Parameters
[in]accptThe object used to scale derivatives in the score calculation, or nullptr if derivatives were not requested.

Reimplemented from IMP::Constraint.

Definition at line 217 of file Surface.h.

virtual void IMP::core::SurfaceGeometryConstraint::do_before_evaluate ( )
overridevirtual

Update the state given the current state of the model.

This is also called prior to every calculation of the model score. It should be implemented by ScoreStates in order to provide functionality.

Reimplemented from IMP::Constraint.

Definition at line 216 of file Surface.h.

virtual ModelObjectsTemp IMP::core::SurfaceGeometryConstraint::do_get_inputs ( ) const
overridevirtual

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::ModelObject.

Definition at line 222 of file Surface.h.

virtual ModelObjectsTemp IMP::core::SurfaceGeometryConstraint::do_get_outputs ( ) const
overridevirtual

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

Implements IMP::ModelObject.

Definition at line 227 of file Surface.h.

virtual ::IMP::VersionInfo IMP::core::SurfaceGeometryConstraint::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 232 of file Surface.h.


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