IMP  2.0.1
The Integrative Modeling Platform
Public Member Functions | Related Functions | List of all members
IMP::atom::BondPairContainer Class Reference
Creating and restraining bonds

A container that returns pairs of the endpoints of the bonds. More...

#include <IMP/atom/BondPairContainer.h>

+ Inheritance diagram for IMP::atom::BondPairContainer:

Public Member Functions

 BondPairContainer (SingletonContainer *sc)
 The container containing the bonds.
 
template<class F >
void apply_generic (F *f) const
 
virtual void do_before_evaluate ()
 
virtual ModelObjectsTemp do_get_inputs () const
 
virtual ParticleIndexPairs get_indexes () const
 
virtual ParticleIndexPairs get_range_indexes () const
 
 IMP_IMPLEMENT_PAIR_CONTAINER (BondPairContainer)
 
- Public Member Functions inherited from IMP::kernel::PairContainer
void apply (const PairModifier *sm) const
 Apply a SingletonModifier to the contents.
 
void apply_generic (const PairModifier *m) const
 Just use apply() in the base class.
 
bool get_contains_particle_pair (ParticlePair v) const
 This function is very slow and you should think hard about using it. More...
 
unsigned int get_number_of_particle_pairs () const
 
ParticlePair get_particle_pair (unsigned int i) const
 
ParticlePairsTemp get_particle_pairs () const
 
- Public Member Functions inherited from IMP::kernel::Container
virtual void do_after_evaluate (DerivativeAccumulator *accpt)
 Reset changed status.
 
ModelObjectsTemp do_get_outputs () const
 containers don't have outputs
 
virtual ParticleIndexes get_all_possible_indexes () const =0
 Get contained particles. More...
 
ParticlesTemp get_all_possible_particles () const
 
bool get_is_changed () const
 
virtual bool get_is_decomposable () const
 
- Public Member Functions inherited from IMP::kernel::ScoreState
 ScoreState (Model *m, std::string name="ScoreState %1%")
 
void after_evaluate (DerivativeAccumulator *accpt)
 Do post evaluation work if needed.
 
void before_evaluate ()
 Force update of the structure.
 
ContainersTemp get_input_containers () const
 
ParticlesTemp get_input_particles () const
 
ContainersTemp get_output_containers () const
 
ParticlesTemp get_output_particles () const
 
- Public Member Functions inherited from IMP::kernel::ModelObject
 ModelObject (Model *m, std::string name)
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 
Model * get_model () const
 
ModelObjectsTemp get_outputs () const
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual IMP::base::VersionInfo get_version_info () const =0
 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)
 

Related Functions

(Note that these are not member functions.)

typedef IMP::base::Vector
< IMP::base::WeakPointer
< BondPairContainer > > 		BondPairContainersTemp
 
- Related Functions inherited from IMP::kernel::PairContainer
typedef IMP::base::Vector
< IMP::base::WeakPointer
< PairContainer > > 		PairContainersTemp
 
- Related Functions inherited from IMP::kernel::Container
typedef IMP::base::Vector
< IMP::base::WeakPointer
< Container > > 		ContainersTemp
 
- Related Functions inherited from IMP::kernel::ScoreState
typedef IMP::base::Vector
< IMP::base::WeakPointer
< ScoreState > > 		ScoreStatesTemp
 
- Related Functions inherited from IMP::kernel::ModelObject
typedef IMP::base::Vector
< IMP::base::WeakPointer
< ModelObject > > 		ModelObjectsTemp
 
- Related Functions inherited from IMP::base::Object
typedef IMP::base::Vector
< IMP::base::WeakPointer
< Object > > 		ObjectsTemp
 

Additional Inherited Members

- Public Types inherited from IMP::kernel::PairContainer
typedef ParticleIndexPair ContainedIndexType
 
typedef ParticleIndexPairs ContainedIndexTypes
 
typedef ParticlePair ContainedType
 
typedef ParticlePairsTemp ContainedTypes
 
- Protected Member Functions inherited from IMP::kernel::PairContainer
 PairContainer (Model *m, std::string name="PairContainer %1%")
 
virtual void do_apply (const PairModifier *sm) const =0
 
virtual bool do_get_provides_access () const
 

Detailed Description

Turn a container of Bond particles into a container of ParticlePair objects of the endpoints.

See Also
Bonded

Definition at line 30 of file BondPairContainer.h.

Member Function Documentation

virtual ModelObjectsTemp IMP::atom::BondPairContainer::do_get_inputs ( ) const
virtual

Override if this reads other objects during evaluate.

Implements IMP::kernel::ModelObject.

Definition at line 51 of file BondPairContainer.h.

virtual ParticleIndexPairs IMP::atom::BondPairContainer::get_indexes ( ) const
virtual

Get all the indexes contained in the container.

Implements IMP::kernel::PairContainer.

virtual ParticleIndexPairs IMP::atom::BondPairContainer::get_range_indexes ( ) const
virtual

Get all the indexes that might possibly be contained in the container, useful with dynamic containers. For example, with a container::ClosePairContainer, this is the list of all pairs taken from input list (those that are far apart in addition to those that are close).

Implements IMP::kernel::PairContainer.

Friends And Related Function Documentation

typedef IMP::base::Vector<IMP::base::WeakPointer< BondPairContainer > > BondPairContainersTemp
related

Pass a set of objects.

Definition at line 59 of file BondPairContainer.h.

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