Maintain a set of perturbers to be executed together. More...

#include <PerturberSet.hh>

Inheritance diagram for protocols::kinematic_closure::perturbers::PerturberSet:

Public Member Functions
	PerturberSet ()
	Default constructor. More...

	~PerturberSet ()
	Destructor. More...

std::string	get_name () const
	Return the name of this perturber. More...

void	perturb_subset (Pose const &pose, IndexList const &residues, ClosureProblemOP problem)
	Perturb the given residues. More...

void	perturb_subset_with_balance (Pose const &pose, IndexList const &residues, ClosureProblemOP problem)
	Perturb the given residues such that detailed balance is obeyed. More...

void	add (PerturberOP perturber)
	Add a new perturber to the set. Any default perturbers are removed. More...

void	clear ()
	Remove all perturbers from this set. More...

void	mark_as_default ()
	Indicate that the current set of perturbers is meant as some sort of default, and should be cleared if a new perturber is manually added. More...

void	get_perturber_names (utility::vector1< std::string > &names, std::string indent="") const
	Add the names of all the perturbers contained in this set to the given list. Indentation is used to indicate hierarchy. More...

Public Member Functions inherited from protocols::kinematic_closure::perturbers::Perturber
void	perturb (Pose const &pose, ClosureProblemOP problem)
	Perturb all of the non-pivot residues. More...

void	perturb_with_balance (Pose const &pose, ClosureProblemOP problem)
	Perturb all of the non-pivot residues such that detailed balance is obeyed. More...

Detailed Description

Maintain a set of perturbers to be executed together.

Constructor & Destructor Documentation

protocols::kinematic_closure::perturbers::PerturberSet::PerturberSet ( )

Default constructor.

protocols::kinematic_closure::perturbers::PerturberSet::~PerturberSet ( )

default

Destructor.

void protocols::kinematic_closure::perturbers::PerturberSet::add ( PerturberOP perturber )

Add a new perturber to the set. Any default perturbers are removed.

void protocols::kinematic_closure::perturbers::PerturberSet::clear ( )

Remove all perturbers from this set.

std::string protocols::kinematic_closure::perturbers::PerturberSet::get_name ( ) const

inlinevirtual

Return the name of this perturber.

void protocols::kinematic_closure::perturbers::PerturberSet::get_perturber_names	(	utility::vector1< std::string > &	names,
		std::string	indent = `""`
	)		const

Add the names of all the perturbers contained in this set to the given list. Indentation is used to indicate hierarchy.

void protocols::kinematic_closure::perturbers::PerturberSet::mark_as_default ( )

Indicate that the current set of perturbers is meant as some sort of default, and should be cleared if a new perturber is manually added.

void protocols::kinematic_closure::perturbers::PerturberSet::perturb_subset	(	Pose const &	pose,
		IndexList const &	residues,
		ClosureProblemOP	problem
	)

virtual

Perturb the given residues.

void protocols::kinematic_closure::perturbers::PerturberSet::perturb_subset_with_balance	(	Pose const &	pose,
		IndexList const &	residues,
		ClosureProblemOP	problem
	)

virtual

Perturb the given residues such that detailed balance is obeyed.

If not reimplemented, this method will kill rosetta and complain that no balanced implementation of this algorithm exists.

bool protocols::kinematic_closure::perturbers::PerturberSet::is_default_

private

utility::vector1<PerturberOP> protocols::kinematic_closure::perturbers::PerturberSet::perturbers_

private

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