IMP::container::ListSingletonContainer Class Reference

Store a kernel::ParticleIndexes. More...

#include <IMP/container/ListSingletonContainer.h>

Inheritance diagram for IMP::container::ListSingletonContainer:

Detailed Description

Store a kernel::ParticleIndexes.

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 DynamicListSingletonContainer if you want to change the contents frequently (eg via a kernel::ScoreState).

Definition at line 33 of file ListSingletonContainer.h.

Public Member Functions
	ListSingletonContainer (kernel::Model *m, const kernel::ParticleIndexes &contents, std::string name="ListSingletonContainer%1%")
	ListSingletonContainer (const kernel::ParticlesTemp &ps, std::string name="ListSingletonContainer%1%")
virtual std::string	get_type_name () const
virtual ::IMP::base::VersionInfo	get_version_info () const
	Get information about the module and version of the object. More...
void	set_particles (const kernel::ParticlesTemp &ps)
void	set_particles (const kernel::ParticleIndexes &contents)
Public Member Functions inherited from IMP::kernel::SingletonContainer
void	apply (const SingletonModifier *sm) const
	Apply a SingletonModifier to the contents. More...
void	apply_generic (const SingletonModifier *m) const
	Just use apply() in the base class. More...
const kernel::ParticleIndexes &	get_contents () const
virtual kernel::ParticleIndexes	get_indexes () const =0
unsigned int	get_number_of_particles () const
kernel::Particle *	get_particle (unsigned int i) const
kernel::ParticlesTemp	get_particles () const
virtual kernel::ParticleIndexes	get_range_indexes () const =0
Public Member Functions inherited from IMP::kernel::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::kernel::ModelObject
	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
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::kernel::SingletonContainer
typedef kernel::ParticleIndex	ContainedIndexType
typedef kernel::ParticleIndexes	ContainedIndexTypes
typedef kernel::Particle *	ContainedType
typedef kernel::ParticlesTemp	ContainedTypes
typedef SingletonModifier	Modifier
typedef kernel::ParticleIndex	PassContainedIndexType
Protected Member Functions inherited from IMP::kernel::SingletonContainer
	SingletonContainer (kernel::Model *m, std::string name="SingletonContainer %1%")
virtual void	do_apply (const SingletonModifier *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%")
virtual std::size_t	do_get_contents_hash () const =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...
virtual void	do_destroy ()

Member Function Documentation

virtual ::IMP::base::VersionInfo IMP::container::ListSingletonContainer::get_version_info ( ) const

virtual

Get information about the module and version of the object.

Reimplemented from IMP::base::Object.

Definition at line 72 of file ListSingletonContainer.h.

---

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

• ListSingletonContainer.h