protocols::constraint_generator::TerminiConstraintGenerator Class Reference

Generates distance constraints between the upper and lower termini. More...

#include <TerminiConstraintGenerator.hh>

Inheritance diagram for protocols::constraint_generator::TerminiConstraintGenerator:

Public Member Functions
	TerminiConstraintGenerator ()
	~TerminiConstraintGenerator () override
ConstraintGeneratorOP	clone () const override
core::scoring::constraints::ConstraintCOPs	apply (core::pose::Pose const &pose) const override
	generates constraints and adds them to the pose More...
void	provide_citation_info (basic::citation_manager::CitationCollectionList &citations) const override
	Provide citations to the passed CitationCollectionList. This allows the constraint generator to provide citations for itself and for any modules that it invokes. More...
void	set_min_distance (core::Real const dist)
void	set_max_distance (core::Real const dist)
void	set_sd (core::Real const sd)
void	set_weight (core::Real const weight)
core::Real	weight () const
core::Real	min_distance () const
core::Real	max_distance () const
Public Member Functions inherited from protocols::constraint_generator::ConstraintGenerator
	ConstraintGenerator (std::string const &class_name)
	~ConstraintGenerator () override
void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data)
	parses XML tag – calls protected parse_tag() function More...
std::string const &	id () const
void	set_id (std::string const &id)
std::string const &	class_name () const

Static Public Member Functions
static std::string	class_name ()
static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Protected Member Functions
void	parse_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
	called by parse_my_tag – should not be used directly More...

Private Attributes
core::Real	min_distance_
core::Real	max_distance_
core::Real	sd_
core::Real	weight_

Detailed Description

Generates distance constraints between the upper and lower termini.

Constructor & Destructor Documentation

protocols::constraint_generator::TerminiConstraintGenerator::TerminiConstraintGenerator

(

)

protocols::constraint_generator::TerminiConstraintGenerator::~TerminiConstraintGenerator ( )

overridedefault

Member Function Documentation

core::scoring::constraints::ConstraintCOPs protocols::constraint_generator::TerminiConstraintGenerator::apply ( core::pose::Pose const &  pose ) const

overridevirtual

generates constraints and adds them to the pose

Implements protocols::constraint_generator::ConstraintGenerator.

References core::chemical::ResidueType::atom_index(), protocols::constraint_generator::first_protein_residue(), core::conformation::Residue::has(), protocols::constraint_generator::last_protein_residue(), max_distance_, min_distance_, core::pose::Pose::residue(), core::pose::Pose::residue_type(), protocols::constraint_generator::scalar_weighted(), sd_, protocols::constraint_generator::TR(), and weight_.

Referenced by protocols::forge::constraints::NtoCConstraintGenerator::generate_remodel_constraints().

static std::string protocols::constraint_generator::TerminiConstraintGenerator::class_name ( )

inlinestatic

Referenced by protocols::constraint_generator::TerminiConstraintGeneratorCreator::keyname(), provide_citation_info(), and provide_xml_schema().

ConstraintGeneratorOP protocols::constraint_generator::TerminiConstraintGenerator::clone ( ) const

overridevirtual

Implements protocols::constraint_generator::ConstraintGenerator.

core::Real protocols::constraint_generator::TerminiConstraintGenerator::max_distance

(

)

const

References max_distance_.

Referenced by protocols::forge::constraints::NtoCConstraintGenerator::parse_my_tag().

core::Real protocols::constraint_generator::TerminiConstraintGenerator::min_distance

(

)

const

References min_distance_.

void protocols::constraint_generator::TerminiConstraintGenerator::parse_tag ( utility::tag::TagCOP  tag, basic::datacache::DataMap &  data  )

overrideprotectedvirtual

called by parse_my_tag – should not be used directly

Implements protocols::constraint_generator::ConstraintGenerator.

void protocols::constraint_generator::TerminiConstraintGenerator::provide_citation_info ( basic::citation_manager::CitationCollectionList &  citations ) const

overridevirtual

Provide citations to the passed CitationCollectionList. This allows the constraint generator to provide citations for itself and for any modules that it invokes.

Cites Tom Linsky, who created the constraint generator framework.

Author

Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org).

Reimplemented from protocols::constraint_generator::ConstraintGenerator.

References class_name().

void protocols::constraint_generator::TerminiConstraintGenerator::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

References class_name(), and protocols::constraint_generator::ConstraintGeneratorFactory::xsd_constraint_generator_type_definition_w_attributes().

Referenced by protocols::constraint_generator::TerminiConstraintGeneratorCreator::provide_xml_schema().

void protocols::constraint_generator::TerminiConstraintGenerator::set_max_distance

(

core::Real const

dist

)

References max_distance_.

Referenced by protocols::forge::constraints::NtoCConstraintGenerator::NtoCConstraintGenerator(), and protocols::forge::constraints::NtoCConstraintGenerator::parse_my_tag().

void protocols::constraint_generator::TerminiConstraintGenerator::set_min_distance

(

core::Real const

dist

)

References min_distance_.

void protocols::constraint_generator::TerminiConstraintGenerator::set_sd

(

core::Real const

sd

)

References sd_.

void protocols::constraint_generator::TerminiConstraintGenerator::set_weight

(

core::Real const

weight

)

References weight(), and weight_.

Referenced by protocols::forge::constraints::NtoCConstraintGenerator::NtoCConstraintGenerator(), and protocols::forge::constraints::NtoCConstraintGenerator::parse_my_tag().

core::Real protocols::constraint_generator::TerminiConstraintGenerator::weight

(

)

const

References weight_.

Referenced by protocols::forge::constraints::NtoCConstraintGenerator::parse_my_tag(), and set_weight().

Member Data Documentation

core::Real protocols::constraint_generator::TerminiConstraintGenerator::max_distance_

private

Referenced by apply(), max_distance(), and set_max_distance().

core::Real protocols::constraint_generator::TerminiConstraintGenerator::min_distance_

private

Referenced by apply(), min_distance(), and set_min_distance().

core::Real protocols::constraint_generator::TerminiConstraintGenerator::sd_

private

Referenced by apply(), and set_sd().

core::Real protocols::constraint_generator::TerminiConstraintGenerator::weight_

private

Referenced by apply(), set_weight(), and weight().

---

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

• src/protocols/constraint_generator/TerminiConstraintGenerator.hh
• src/protocols/constraint_generator/TerminiConstraintGenerator.cc