protocols::denovo_design::components::CompoundPerturber Class Reference

"mutates" a set of mixed architects More...

#include <StructureDataPerturber.hh>

Inheritance diagram for protocols::denovo_design::components::CompoundPerturber:

Public Types
typedef utility::vector1 < Permutations >	PermutationsByPerturber
Public Types inherited from protocols::denovo_design::components::StructureDataPerturber
typedef SegmentCOPs	Permutation
typedef utility::vector1 < Permutation >	Permutations
typedef EnumeratedVectorSelector < Permutation >	PermutationSelector

Public Member Functions
	CompoundPerturber ()
	CompoundPerturber (CompoundPerturber const &other)
	copy constructor – necessary for deep copying of perturbers_ More...
	~CompoundPerturber () override
StructureDataPerturberOP	clone () const override
void	parse_my_tag (utility::tag::Tag const &tag, basic::datacache::DataMap &data) override
Permutations	enumerate (StructureData const &sd) const override
void	set_ignore_segments (SegmentNameSet const &ignore_set) override
	Sets list of segments that will be ignored by the perturber. More...
void	add_perturber (StructureDataPerturberOP perturber)
	Add a sub-perturber. Based on the mode, one or all of the perturbers will be called every time a perturbation is requested. More...
void	clear_perturbers ()
	Clears list of sub-perturber. More...
void	set_mode (CombinationMode const mode)
	Sets the mode which defines how the compound perturber uses the sub-perturbers. AND=run all perturbers, OR=choose a perturber randomly and run only that one. More...
Public Member Functions inherited from protocols::denovo_design::components::StructureDataPerturber
	StructureDataPerturber ()
virtual	~StructureDataPerturber ()
	Destructor. More...
void	apply (StructureData &sd)
bool	ignored (SegmentName const &segment_name) const

Static Public Member Functions
static std::string	class_name ()
Static Public Member Functions inherited from protocols::denovo_design::components::StructureDataPerturber
static StructureDataPerturberOP	create (utility::tag::Tag const &tag, basic::datacache::DataMap &data)
	creates a structuredata perturber from a tag More...

Private Types
enum	CombinationMode { AND = 1, OR, UNKNOWN }

Private Member Functions
Permutations	all_combinations (PermutationsByPerturber const &all_motifs) const

Private Attributes
CombinationMode	mode_
StructureDataPerturberOPs	perturbers_

Detailed Description

"mutates" a set of mixed architects

Member Typedef Documentation

typedef utility::vector1< Permutations > protocols::denovo_design::components::CompoundPerturber::PermutationsByPerturber

Member Enumeration Documentation

enum protocols::denovo_design::components::CompoundPerturber::CombinationMode

private

Enumerator
AND
OR
UNKNOWN

Constructor & Destructor Documentation

protocols::denovo_design::components::CompoundPerturber::CompoundPerturber

(

)

protocols::denovo_design::components::CompoundPerturber::CompoundPerturber

(

CompoundPerturber const &

other

)

copy constructor – necessary for deep copying of perturbers_

copy constructor – necessary because we want to deep copy perturbers_

References add_perturber(), and perturbers_.

protocols::denovo_design::components::CompoundPerturber::~CompoundPerturber ( )

overridedefault

Member Function Documentation

void protocols::denovo_design::components::CompoundPerturber::add_perturber

(

StructureDataPerturberOP

perturber

)

Add a sub-perturber. Based on the mode, one or all of the perturbers will be called every time a perturbation is requested.

References perturbers_.

Referenced by CompoundPerturber(), and parse_my_tag().

StructureDataPerturber::Permutations protocols::denovo_design::components::CompoundPerturber::all_combinations ( PermutationsByPerturber const &  all_motifs ) const

private

Referenced by enumerate().

static std::string protocols::denovo_design::components::CompoundPerturber::class_name ( )

inlinestatic

Referenced by protocols::denovo_design::components::StructureDataPerturber::create(), and parse_my_tag().

void protocols::denovo_design::components::CompoundPerturber::clear_perturbers

(

)

Clears list of sub-perturber.

References perturbers_.

Referenced by parse_my_tag().

StructureDataPerturberOP protocols::denovo_design::components::CompoundPerturber::clone ( ) const

overridevirtual

Implements protocols::denovo_design::components::StructureDataPerturber.

StructureDataPerturber::Permutations protocols::denovo_design::components::CompoundPerturber::enumerate ( StructureData const &  sd ) const

overridevirtual

Implements protocols::denovo_design::components::StructureDataPerturber.

References all_combinations(), and perturbers_.

void protocols::denovo_design::components::CompoundPerturber::parse_my_tag ( utility::tag::Tag const &  tag, basic::datacache::DataMap &  data  )

overridevirtual

Implements protocols::denovo_design::components::StructureDataPerturber.

References add_perturber(), AND, class_name(), clear_perturbers(), protocols::denovo_design::components::StructureDataPerturber::create(), OR, and set_mode().

void protocols::denovo_design::components::CompoundPerturber::set_ignore_segments ( SegmentNameSet const &  ignore_set )

overridevirtual

Sets list of segments that will be ignored by the perturber.

Reimplemented from protocols::denovo_design::components::StructureDataPerturber.

References perturbers_, and protocols::denovo_design::components::StructureDataPerturber::set_ignore_segments().

void protocols::denovo_design::components::CompoundPerturber::set_mode

(

CombinationMode const

mode

)

Sets the mode which defines how the compound perturber uses the sub-perturbers. AND=run all perturbers, OR=choose a perturber randomly and run only that one.

References mode_.

Referenced by parse_my_tag().

Member Data Documentation

CombinationMode protocols::denovo_design::components::CompoundPerturber::mode_

private

Referenced by set_mode().

StructureDataPerturberOPs protocols::denovo_design::components::CompoundPerturber::perturbers_

private

Referenced by add_perturber(), clear_perturbers(), CompoundPerturber(), enumerate(), and set_ignore_segments().

---

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

• src/protocols/denovo_design/components/StructureDataPerturber.hh
• src/protocols/denovo_design/components/StructureDataPerturber.cc