Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::constraint_generator::ConstraintGenerator Class Referenceabstract

pure virtual base class More...

#include <ConstraintGenerator.hh>

Inheritance diagram for protocols::constraint_generator::ConstraintGenerator:
Inheritance graph

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 ( )

◆ ConstraintGenerator() [2/2]

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

Member Function Documentation

◆ apply()

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

◆ 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

◆ 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

◆ provide_citation_info()

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

◆ set_id()

void protocols::constraint_generator::ConstraintGenerator::set_id ( std::string const &  id)

Member Data Documentation

◆ class_name_

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

Referenced by class_name().

◆ id_

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

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

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