Detailed Description

Store a list of 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 ScoreState).

Definition at line 35 of file ListSingletonContainer.h.

Public Member Functions
	ListSingletonContainer (Model *m, const ParticleIndexes &contents, std::string name="ListSingletonContainer%1%")

void	add (ParticleIndex vt)
	Add a single ParticleIndex to the container. More...

void	add (const ParticleIndexes &c)
	Add ParticleIndexes to the container. More...

void	clear ()
	Clear the contents of the container. More...

virtual std::string	get_type_name () const override

virtual ::IMP::VersionInfo	get_version_info () const override
	Get information about the module and version of the object. More...

template<class Archive >
void	serialize (Archive &ar)

void	set (ParticleIndexes cp)
	Set the contents of the container to the given ParticleIndexes. More...

Public Member Functions inherited from IMP::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...

void	apply_generic_moved (const SingletonModifier *m, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const
	Just use apply_moved() in the base class. More...

void	apply_moved (const SingletonModifier *sm, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const
	Apply a SingletonModifier to the contents. More...

const ParticleIndexes &	get_contents () const

virtual ParticleIndexes	get_indexes () const =0

virtual ParticleIndexes	get_range_indexes () const =0

Public Member Functions inherited from IMP::Container
ModelObjectsTemp	do_get_outputs () const override
	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...

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::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::SingletonContainer
typedef ParticleIndex	ContainedIndexType

typedef ParticleIndexes	ContainedIndexTypes

typedef Particle *	ContainedType

typedef ParticlesTemp	ContainedTypes

typedef SingletonModifier	Modifier

typedef ParticleIndex	PassContainedIndexType

Protected Member Functions inherited from IMP::SingletonContainer
	SingletonContainer (Model *m, std::string name="SingletonContainer %1%")

virtual void	do_apply (const SingletonModifier *sm) const =0

virtual void	do_apply_moved (const SingletonModifier *sm, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const

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::ListSingletonContainer::add ( ParticleIndex vt )

Add a single ParticleIndex to the container.

void IMP::container::ListSingletonContainer::add ( const ParticleIndexes & c )

Add ParticleIndexes to the container.

void IMP::container::ListSingletonContainer::clear ( )

Clear the contents of the container.

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

overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 82 of file ListSingletonContainer.h.

void IMP::container::ListSingletonContainer::set ( ParticleIndexes cp )

Set the contents of the container to the given ParticleIndexes.

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

ListSingletonContainer.h

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation