protocols::constraint_generator::ConstraintGenerator Class Reference

pure virtual base class More...

#include <ConstraintGenerator.hh>

Inheritance diagram for protocols::constraint_generator::ConstraintGenerator:

Public Member Functions
	ConstraintGenerator (std::string const &class_name)
	~ConstraintGenerator () override
virtual ConstraintGeneratorOP	clone () const =0
virtual core::scoring::constraints::ConstraintCOPs	apply (core::pose::Pose const &pose) const =0
	generates constraints and adds them to the pose More...
virtual void	provide_citation_info (basic::citation_manager::CitationCollectionList &citations) const
	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	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

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

Private Member Functions
	ConstraintGenerator ()

Private Attributes
std::string	class_name_
std::string	id_

Detailed Description

pure virtual base class

Constructor & Destructor Documentation

ConstraintGenerator() [1/2]

protocols::constraint_generator::ConstraintGenerator::ConstraintGenerator

(

std::string const &

class_name

)

~ConstraintGenerator()

protocols::constraint_generator::ConstraintGenerator::~ConstraintGenerator ( )

overridedefault

ConstraintGenerator() [2/2]

protocols::constraint_generator::ConstraintGenerator::ConstraintGenerator ( )

private

Member Function Documentation

apply()

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

pure virtual

generates constraints and adds them to the pose

Implemented in protocols::trRosetta_protocols::constraint_generators::trRosettaConstraintGenerator, protocols::fold_from_loops::constraint_generator::SegmentedAtomPairConstraintGenerator, protocols::fold_from_loops::constraint_generator::AutomaticSheetConstraintGenerator, protocols::fldsgn::SheetConstraintGenerator, protocols::denovo_design::constraints::FileConstraintGenerator, protocols::constraint_generator::TerminiConstraintGenerator, protocols::constraint_generator::ResidueTypeConstraintGenerator, protocols::constraint_generator::MetalContactsConstraintGenerator, protocols::constraint_generator::MembraneSpanConstraintGenerator, protocols::constraint_generator::HydrogenBondConstraintGenerator, protocols::constraint_generator::DistanceConstraintGenerator, protocols::constraint_generator::DihedralConstraintGenerator, protocols::constraint_generator::CoordinateConstraintGenerator, and protocols::constraint_generator::AtomPairConstraintGenerator.

class_name()

std::string const & protocols::constraint_generator::ConstraintGenerator::class_name

(

)

const

References class_name_.

clone()

virtual ConstraintGeneratorOP protocols::constraint_generator::ConstraintGenerator::clone ( ) const

pure virtual

Implemented in protocols::trRosetta_protocols::constraint_generators::trRosettaConstraintGenerator, protocols::fold_from_loops::constraint_generator::SegmentedAtomPairConstraintGenerator, protocols::fold_from_loops::constraint_generator::AutomaticSheetConstraintGenerator, protocols::fldsgn::SheetConstraintGenerator, protocols::denovo_design::constraints::FileConstraintGenerator, protocols::constraint_generator::TerminiConstraintGenerator, protocols::constraint_generator::ResidueTypeConstraintGenerator, protocols::constraint_generator::MetalContactsConstraintGenerator, protocols::constraint_generator::MembraneSpanConstraintGenerator, protocols::constraint_generator::HydrogenBondConstraintGenerator, protocols::constraint_generator::DistanceConstraintGenerator, protocols::constraint_generator::DihedralConstraintGenerator, protocols::constraint_generator::CoordinateConstraintGenerator, and protocols::constraint_generator::AtomPairConstraintGenerator.

id()

std::string const & protocols::constraint_generator::ConstraintGenerator::id

(

)

const

References id_.

Referenced by set_id().

parse_my_tag()

void protocols::constraint_generator::ConstraintGenerator::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	data
	)

parses XML tag – calls protected parse_tag() function

This is called if this mover is instantiated from XML.

References id_, and parse_tag().

parse_tag()

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

protectedpure virtual

called by parse_my_tag – should not be used directly

Implemented in protocols::constraint_generator::MembraneSpanConstraintGenerator, protocols::trRosetta_protocols::constraint_generators::trRosettaConstraintGenerator, protocols::fold_from_loops::constraint_generator::SegmentedAtomPairConstraintGenerator, protocols::fldsgn::SheetConstraintGenerator, protocols::denovo_design::constraints::FileConstraintGenerator, protocols::constraint_generator::TerminiConstraintGenerator, protocols::constraint_generator::ResidueTypeConstraintGenerator, protocols::constraint_generator::MetalContactsConstraintGenerator, protocols::constraint_generator::HydrogenBondConstraintGenerator, protocols::constraint_generator::DistanceConstraintGenerator, protocols::constraint_generator::DihedralConstraintGenerator, protocols::constraint_generator::CoordinateConstraintGenerator, protocols::constraint_generator::AtomPairConstraintGenerator, and protocols::fold_from_loops::constraint_generator::AutomaticSheetConstraintGenerator.

Referenced by parse_my_tag().

provide_citation_info()

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

virtual

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

This base class version does nothing. It should be overridden by derived classes.

Author

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

Reimplemented in protocols::trRosetta_protocols::constraint_generators::trRosettaConstraintGenerator, protocols::constraint_generator::TerminiConstraintGenerator, protocols::constraint_generator::ResidueTypeConstraintGenerator, protocols::constraint_generator::MetalContactsConstraintGenerator, protocols::constraint_generator::MembraneSpanConstraintGenerator, protocols::constraint_generator::HydrogenBondConstraintGenerator, protocols::constraint_generator::DistanceConstraintGenerator, protocols::constraint_generator::DihedralConstraintGenerator, protocols::constraint_generator::CoordinateConstraintGenerator, and protocols::constraint_generator::AtomPairConstraintGenerator.

set_id()

void protocols::constraint_generator::ConstraintGenerator::set_id

(

std::string const &

id

)

References id(), and id_.

Referenced by protocols::fold_from_loops::constraint_generator::SegmentedAtomPairConstraintGenerator::apply().

Member Data Documentation

class_name_

std::string protocols::constraint_generator::ConstraintGenerator::class_name_

private

Referenced by class_name().

id_

std::string protocols::constraint_generator::ConstraintGenerator::id_

private

Referenced by id(), parse_my_tag(), and set_id().

---

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

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