IMP logo
IMP Reference Guide  2.6.1
The Integrative Modeling Platform
IMP::container::ListTripletContainer Class Reference

Store a list of ParticleIndexTriplets. More...

#include <IMP/container/ListTripletContainer.h>

+ Inheritance diagram for IMP::container::ListTripletContainer:

Detailed Description

Store a list of ParticleIndexTriplets.

Note
The order may change when particles are inserted as the list is maintained in sorted order.
Changing the contents of the container is a fairly heavy weight operation as it resets part of the dependency graph. Use a DynamicListTripletContainer if you want to change the contents frequently (eg via a ScoreState).

Definition at line 33 of file ListTripletContainer.h.

Public Member Functions

 ListTripletContainer (Model *m, const ParticleIndexTriplets &contents, std::string name="ListTripletContainer%1%")
 
 ListTripletContainer (const ParticleTripletsTemp &ps, std::string name="ListTripletContainer%1%")
 
void add (const ParticleIndexTriplet &vt)
 Add a single const ParticleIndexTriplet& to the container. More...
 
void add (const ParticleIndexTriplets &c)
 Add ParticleIndexTriplets to the container. More...
 
void clear ()
 Clear the contents of the container. More...
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
void set (ParticleIndexTriplets cp)
 Set the contents of the container to the given ParticleIndexTriplets. More...
 
void set_particle_triplets (const ParticleTripletsTemp &ps)
 
void set_particle_triplets (const ParticleIndexTriplets &contents)
 
- Public Member Functions inherited from IMP::TripletContainer
void apply (const TripletModifier *sm) const
 Apply a SingletonModifier to the contents. More...
 
void apply_generic (const TripletModifier *m) const
 Just use apply() in the base class. More...
 
const ParticleIndexTripletsget_contents () const
 
virtual ParticleIndexTriplets get_indexes () const =0
 
ParticleTriplet get_particle_triplet (unsigned int i) const
 
ParticleTripletsTemp get_particle_triplets () const
 
virtual ParticleIndexTriplets get_range_indexes () const =0
 
- Public Member Functions inherited from IMP::Container
ModelObjectsTemp do_get_outputs () const
 containers don't have outputs More...
 
virtual ParticleIndexes get_all_possible_indexes () const =0
 Get contained particles. More...
 
std::size_t get_contents_hash () const
 
virtual bool get_is_decomposable () const
 
- 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

- Public Types inherited from IMP::TripletContainer
typedef ParticleIndexTriplet ContainedIndexType
 
typedef ParticleIndexTriplets ContainedIndexTypes
 
typedef ParticleTriplet ContainedType
 
typedef ParticleTripletsTemp ContainedTypes
 
typedef TripletModifier Modifier
 
typedef const
ParticleIndexTriplet
PassContainedIndexType
 
- Protected Member Functions inherited from IMP::TripletContainer
 TripletContainer (Model *m, std::string name="TripletContainer %1%")
 
virtual void do_apply (const TripletModifier *sm) const =0
 
virtual bool do_get_provides_access () const
 
- Protected Member Functions inherited from IMP::Container
 Container (Model *m, std::string name="Container %1%")
 
virtual std::size_t do_get_contents_hash () const =0
 
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemp do_get_inputs () const =0
 
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

void IMP::container::ListTripletContainer::add ( const ParticleIndexTriplet vt)

Add a single const ParticleIndexTriplet& to the container.

void IMP::container::ListTripletContainer::add ( const ParticleIndexTriplets c)

Add ParticleIndexTriplets to the container.

void IMP::container::ListTripletContainer::clear ( )

Clear the contents of the container.

virtual ::IMP::VersionInfo IMP::container::ListTripletContainer::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 97 of file ListTripletContainer.h.

void IMP::container::ListTripletContainer::set ( ParticleIndexTriplets  cp)

Set the contents of the container to the given ParticleIndexTriplets.

void IMP::container::ListTripletContainer::set_particle_triplets ( const ParticleTripletsTemp ps)
Deprecated:
As of IMP release 2.5. See the IMP Deprecation Policy for more information about deprecation in IMP. Use set() with indexes instead
void IMP::container::ListTripletContainer::set_particle_triplets ( const ParticleIndexTriplets contents)
Deprecated:
As of IMP release 2.5. See the IMP Deprecation Policy for more information about deprecation in IMP. Use set() instead

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