IMP::kernel::ModelObject Class Reference

#include <IMP/kernel/ModelObject.h>

Inheritance diagram for IMP::kernel::ModelObject:

Public Member Functions
	ModelObject (kernel::Model *m, std::string name)
	ModelObject (std::string name)
virtual void	do_set_model (kernel::Model *)
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
bool	get_is_part_of_model () const
Model *	get_model () const
ModelObjectsTemp	get_outputs () const
const ScoreStatesTemp &	get_required_score_states () const
void	set_has_dependencies (bool tf)
void	set_has_required_score_states (bool tf)
virtual void	set_model (kernel::Model *m)
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
virtual VersionInfo	get_version_info () const
	Get information about the module and version of the object.
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...
	Object ()

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.

Constructor & Destructor Documentation

IMP::kernel::ModelObject::ModelObject

(

std::string

name

)

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the constructor that takes a Model.

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.

Implemented in IMP::atom::WritePDBOptimizerState, IMP::container::ExclusiveConsecutivePairContainer, IMP::em2d::Em2DRestraint, IMP::em2d::ProjectionParametersScoreState, IMP::kernel::OptimizerState, IMP::kernel::Particle, IMP::core::IncrementalScoringFunction, IMP::container::ClosePairContainer, IMP::container::PredicatePairsRestraint, IMP::container::PredicateQuadsRestraint, IMP::container::PredicateSingletonsRestraint, IMP::container::PredicateTripletsRestraint, IMP::isd::TALOSRestraint, IMP::isd::CysteineCrossLinkRestraint, IMP::em2d::ParticlesDummyRestraint, IMP::isd::FretRestraint, IMP::core::MSConnectivityRestraint, IMP::multifit::ComplementarityRestraint, IMP::isd::GaussianProcessInterpolationRestraint, IMP::core::ExcludedVolumeRestraint, IMP::core::ConnectivityRestraint, IMP::container::CloseBipartitePairContainer, IMP::isd::MarginalNOERestraint, IMP::isd::MarginalHBondRestraint, IMP::em::FitRestraint, IMP::em2d::Fine2DRegistrationRestraint, IMP::container::PairsConstraint, IMP::container::QuadsConstraint, IMP::container::SingletonsConstraint, IMP::container::TripletsConstraint, IMP::isd::GaussianRestraint, IMP::isd::LognormalRestraint, IMP::core::PairConstraint, IMP::core::QuadConstraint, IMP::core::SingletonConstraint, IMP::core::TripletConstraint, IMP::em2d::DummyRestraint, IMP::container::ConnectingPairContainer, IMP::core::BallMover, IMP::container::ConsecutivePairContainer, IMP::container::DistributePairsScoreState, IMP::container::DistributeQuadsScoreState, IMP::container::DistributeSingletonsScoreState, IMP::container::DistributeTripletsScoreState, IMP::core::RigidBodyMover, IMP::kernel::Optimizer, IMP::saxs::Restraint, IMP::em::EnvelopeFitRestraint, IMP::container::PairsRestraint, IMP::container::QuadsRestraint, IMP::container::SingletonsRestraint, IMP::container::TripletsRestraint, IMP::kinematics::KinematicForestScoreState, IMP::atom::CHARMMStereochemistryRestraint, IMP::isd::AmbiguousNOERestraint, IMP::isd::NOERestraint, IMP::domino::DependencyScoreState, IMP::em::PCAFitRestraint, IMP::example::ExampleComplexRestraint, IMP::core::NormalMover, IMP::isd::AmbiguousRestraint, IMP::atom::BondPairContainer, IMP::core::PairRestraint, IMP::core::QuadRestraint, IMP::core::SingletonRestraint, IMP::core::TripletRestraint, IMP::modeller::MultipleBinormalRestraint, IMP::core::DiameterRestraint, IMP::em::EnvelopePenetrationRestraint, IMP::multifit::WeightedExcludedVolumeRestraint, IMP::container::AllBipartitePairContainer, IMP::em::DensityFillingRestraint, IMP::container::AllPairContainer, IMP::core::SerialMover, IMP::container::PairContainerStatistics, IMP::container::QuadContainerStatistics, IMP::container::SingletonContainerStatistics, IMP::container::TripletContainerStatistics, IMP::container::MinimumPairRestraint, IMP::container::MinimumQuadRestraint, IMP::container::MinimumSingletonRestraint, IMP::container::MinimumTripletRestraint, IMP::isd::vonMisesKappaJeffreysRestraint, IMP::isd::vonMisesKappaConjugateRestraint, IMP::core::MinimumRestraint, IMP::saxs::RadiusOfGyrationRestraint, IMP::example::ExampleRestraint, IMP::isd::WeightRestraint, IMP::multifit::DummyRestraint, IMP::core::MoveStatisticsScoreState, IMP::multifit::RadiusOfGyrationRestraint, IMP::core::Mover, IMP::isd::MolecularDynamicsMover, IMP::symmetry::RigidBodyMover, IMP::core::DihedralRestraint, IMP::atom::EzRestraint, IMP::core::ChecksScoreState, IMP::core::NeighborsTable, IMP::symmetry::BallMover, IMP::core::ConstantRestraint, IMP::isd::WeightMover, IMP::example::ExampleConstraint, IMP::core::VolumeRestraint, IMP::isd::JeffreysRestraint, and IMP::misc::StateAdaptor.

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::em2d::ProjectionParametersScoreState, IMP::kernel::OptimizerState, IMP::kernel::Particle, IMP::core::MonteCarloMover, IMP::kernel::Container, IMP::container::PairsConstraint, IMP::container::QuadsConstraint, IMP::container::SingletonsConstraint, IMP::container::TripletsConstraint, IMP::kernel::ScoringFunction, 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::core::ChecksScoreState, IMP::example::ExampleConstraint, and IMP::misc::StateAdaptor.

virtual void IMP::kernel::ModelObject::do_set_model ( kernel::Model *  )

virtual

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. As it should always be part of a model.

Reimplemented in IMP::isd::GaussianProcessInterpolationRestraint.

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

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

bool IMP::kernel::ModelObject::get_is_part_of_model

(

)

const

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Should always be true.

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 67 of file kernel/ModelObject.h.

void IMP::kernel::ModelObject::set_has_dependencies

(

bool

tf

)

Either invalidate the dependncies or ensure they are correct.

void IMP::kernel::ModelObject::set_has_required_score_states

(

bool

tf

)

Compute the required score states.

virtual void IMP::kernel::ModelObject::set_model ( kernel::Model *  m )

virtual

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the constructor that takes a Model.

Reimplemented in IMP::core::MinimumRestraint.

---

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

• kernel/ModelObject.h