protocols::kinematic_closure::perturbers::PerturberSet Class Reference

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

#include <PerturberSet.hh>

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...
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...

Private Attributes
utility::vector1< PerturberOP >	perturbers_
bool	is_default_

Detailed Description

Maintain a set of perturbers to be executed together.

Constructor & Destructor Documentation

protocols::kinematic_closure::perturbers::PerturberSet::PerturberSet

(

)

Default constructor.

References is_default_.

protocols::kinematic_closure::perturbers::PerturberSet::~PerturberSet

(

)

Destructor.

Member Function Documentation

void protocols::kinematic_closure::perturbers::PerturberSet::add

(

PerturberOP

perturber

)

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

References clear(), is_default_, and perturbers_.

Referenced by protocols::kinematic_closure::BalancedKicMover::BalancedKicMover(), and protocols::kinematic_closure::KicMover::KicMover().

void protocols::kinematic_closure::perturbers::PerturberSet::clear

(

)

Remove all perturbers from this set.

References perturbers_.

Referenced by add().

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

inlinevirtual

Return the name of this perturber.

Implements protocols::kinematic_closure::perturbers::Perturber.

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.

References is_default_.

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

virtual

Perturb the given residues.

Implements protocols::kinematic_closure::perturbers::Perturber.

References perturbers_.

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.

Reimplemented from protocols::kinematic_closure::perturbers::Perturber.

References perturbers_.

Member Data Documentation

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

private

Referenced by add(), mark_as_default(), and PerturberSet().

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

private

Referenced by add(), clear(), perturb_subset(), and perturb_subset_with_balance().

---

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

• src/protocols/kinematic_closure/perturbers/PerturberSet.hh
• src/protocols/kinematic_closure/perturbers/PerturberSet.cc