IMP  2.1.0
The Integrative Modeling Platform
IMP::kernel::TripletContainer Class Referenceabstract

A shared container for Triplets. More...

#include <IMP/kernel/TripletContainer.h>

+ Inheritance diagram for IMP::kernel::TripletContainer:

Public Types

typedef ParticleIndexTriplet ContainedIndexType
 
typedef ParticleIndexTriplets ContainedIndexTypes
 
typedef ParticleTriplet ContainedType
 
typedef ParticleTripletsTemp ContainedTypes
 

Public Member Functions

void apply (const TripletModifier *sm) const
 Apply a SingletonModifier to the contents.
 
void apply_generic (const TripletModifier *m) const
 Just use apply() in the base class.
 
bool get_contains_particle_triplet (ParticleTriplet v) const
 This function is very slow and you should think hard about using it. More...
 
virtual ParticleIndexTriplets get_indexes () const =0
 
unsigned int get_number_of_particle_triplets () const
 
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::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
 
int get_contents_version () const
 
bool get_is_changed () const
 
virtual bool get_is_decomposable () const
 
- Public Member Functions inherited from IMP::kernel::ScoreState
 ScoreState (kernel::Model *m, std::string name)
 
 ScoreState (kernel::Model *m)
 
 ScoreState (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 (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
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_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

 TripletContainer (kernel::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::kernel::Container
 Container (kernel::Model *m, std::string name="Container %1%")
 
void set_is_changed (bool tf)
 Call this with true when the contents of the container change. More...
 
- Protected Member Functions inherited from IMP::kernel::ScoreState
virtual void do_before_evaluate ()=0
 
- Protected Member Functions inherited from IMP::kernel::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::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
 Object ()
 

Detailed Description

Stores a shared collection of Triplets.

Definition at line 37 of file kernel/TripletContainer.h.

Member Function Documentation

bool IMP::kernel::TripletContainer::get_contains_particle_triplet ( ParticleTriplet  v) const
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. This is slow and dependent on the order of elements in the tuple.

Return whether the container has the given element.

virtual ParticleIndexTriplets IMP::kernel::TripletContainer::get_indexes ( ) const
pure virtual

Get all the indexes contained in the container.

unsigned int IMP::kernel::TripletContainer::get_number_of_particle_triplets ( ) const
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. This can be very slow and is probably not useful
ParticleTriplet IMP::kernel::TripletContainer::get_particle_triplet ( unsigned int  i) const
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP.Use get_indexes() instead and thing about using the IMP_CONTAINER_FOREACH() macro.
ParticleTripletsTemp IMP::kernel::TripletContainer::get_particle_triplets ( ) const
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_indexes() instead.
virtual ParticleIndexTriplets IMP::kernel::TripletContainer::get_range_indexes ( ) const
pure 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).


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