Detailed Description

These objects are associated with a particular Model and have a callback that is called whenever the dependencies in the model change. This allows them to update internal state when that occurs.

Definition at line 24 of file kernel/ModelObject.h.

Public Member Functions
	ModelObject (kernel::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...

Model *	get_model () const

ModelObjectsTemp	get_outputs () const

const ScoreStatesTemp &	get_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::base::Object
virtual void	clear_caches ()

CheckLevel	get_check_level () const

LogLevel	get_log_level () const

virtual VersionInfo	get_version_info () const
	Get information about the module and version of the object. More...

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)

virtual std::string	get_type_name () const

Protected Member Functions
virtual ModelObjectsTemp	do_get_inputs () const =0

virtual ModelObjectsTemps	do_get_interactions () const

virtual ModelObjectsTemp	do_get_outputs () const =0

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

virtual void	do_destroy ()

Member Function Documentation

virtual ModelObjectsTemp IMP::kernel::ModelObject::do_get_inputs ( ) const

protectedpure virtual

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.

virtual ModelObjectsTemps IMP::kernel::ModelObject::do_get_interactions ( ) const

protectedvirtual

Override if this if not all inputs interact with all outputs. This is rarely something you want to do.

virtual ModelObjectsTemp IMP::kernel::ModelObject::do_get_outputs ( ) const

protectedpure virtual

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

Implemented in IMP::kernel::Restraint, IMP::kernel::Particle, IMP::kernel::OptimizerState, IMP::em2d::ProjectionParametersScoreState, IMP::core::MonteCarloMover, IMP::kernel::ScoringFunction, IMP::container::PairsConstraint, IMP::container::QuadsConstraint, IMP::container::SingletonsConstraint, IMP::container::TripletsConstraint, IMP::kernel::Container, IMP::core::PairConstraint, IMP::core::QuadConstraint, IMP::core::SingletonConstraint, IMP::core::TripletConstraint, IMP::kernel::Optimizer, IMP::container::DistributePairsScoreState, IMP::container::DistributeQuadsScoreState, IMP::container::DistributeSingletonsScoreState, IMP::container::DistributeTripletsScoreState, IMP::kinematics::KinematicForestScoreState, IMP::domino::DependencyScoreState, IMP::container::PairContainerStatistics, IMP::container::QuadContainerStatistics, IMP::container::SingletonContainerStatistics, IMP::container::TripletContainerStatistics, IMP::core::MoveStatisticsScoreState, IMP::core::NeighborsTable, IMP::example::ExampleConstraint, IMP::core::ChecksScoreState, and IMP::misc::StateAdaptor.

bool IMP::kernel::ModelObject::get_has_dependencies ( ) const

Return whether this object has dependencies computed.

bool IMP::kernel::ModelObject::get_has_required_score_states ( ) const

Return whether score states are computed.

ModelObjectsTemp IMP::kernel::ModelObject::get_inputs ( ) const

get_has_dependencies() must be true.

ModelObjectsTemps IMP::kernel::ModelObject::get_interactions ( ) const

Get the interacting sets induced by this ModelObject.

That is, the particles in each ModelObjectsTemp in the list have some sort of computed relation with one another and none with disjoint other sets in the list.

ModelObjectsTemp IMP::kernel::ModelObject::get_outputs ( ) const

get_has_dependencies() must be true.

const ScoreStatesTemp& IMP::kernel::ModelObject::get_required_score_states ( ) const

Get the score states that are ancestors of this in the dependency graph.

virtual void IMP::kernel::ModelObject::handle_set_has_required_score_states ( bool )

protectedvirtual

Called when set_has_required_score_states() is called.

Reimplemented in IMP::core::IncrementalScoringFunction.

Definition at line 69 of file kernel/ModelObject.h.

void IMP::kernel::ModelObject::set_has_dependencies ( bool tf )

Either invalidate the dependencies or ensure they are correct.

void IMP::kernel::ModelObject::set_has_required_score_states ( bool tf )

Compute the required score states.

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

kernel/ModelObject.h

Detailed Description

Public Member Functions

Protected Member Functions

Member Function Documentation