Rosetta  2020.46
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
protocols::simple_task_operations::RestrictToLoops Class Reference

#include <RestrictToLoops.hh>

Inheritance diagram for protocols::simple_task_operations::RestrictToLoops:
Inheritance graph
[legend]

Public Types

typedef
core::pack::task::operation::TaskOperation 
parent
 
- Public Types inherited from core::pack::task::operation::TaskOperation
typedef utility::tag::TagCOP TagCOP
 
typedef basic::datacache::DataMap DataMap
 
typedef pose::Pose Pose
 

Public Member Functions

 RestrictToLoops ()=default
 Default constructor. More...
 
core::pack::task::operation::TaskOperationOP clone () const override
 Return a deep-copied OP. More...
 
void parse_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
 Configure from a RosettaScripts XML tag. More...
 
void apply (core::pose::Pose const &pose, core::pack::task::PackerTask &task) const override
 Apply this operation to the packer task. More...
 
bool design_loop () const
 Return true if design is allowed. More...
 
void set_design_loop (bool design_loop)
 Specify whether or not design is allowed. More...
 
loops::LoopsCOP loops () const
 Return the loops allowed to pack. More...
 
void set_loops (loops::LoopsCOP loops)
 Specify the loops that will be allowed to pack. More...
 
void set_loops_from_file (std::string loops_file)
 Specify the loops that will be allowed to pack. More...
 
bool restrict_only_design_to_loops () const
 Return true if we are restricting to only design. AKA RestrictDesignToLoops. More...
 
void set_restrict_only_design_to_loops (bool restrict_only_design)
 Specify whether to restrict only design to loops/neighbors AKA RestrictDesignToLoops. Does not disable packing for any residue. Implies and sets design_loop to true. More...
 
- Public Member Functions inherited from core::pack::task::operation::TaskOperation
 ~TaskOperation () override
 
virtual void provide_citation_info (basic::citation_manager::CitationCollectionList &) const
 Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...
 

Static Public Member Functions

static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
static void provide_attributes (utility::tag::AttributeList &attributes)
 
static std::string keyname ()
 

Protected Member Functions

void apply_helper (core::pose::Pose const &pose, core::pack::task::PackerTask &task, bool include_neighbors, core::Real cutoff_distance, bool design_neighbors) const
 Helper function to prevent code duplication in subclasses. More...
 

Private Attributes

bool design_loops_ = false
 
bool restrict_only_design_ = false
 
utility::pointer::DeepCopyOP
< loops::Loops const > 
loops_
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::simple_task_operations::RestrictToLoops::RestrictToLoops ( )
default

Default constructor.

Member Function Documentation

void protocols::simple_task_operations::RestrictToLoops::apply ( core::pose::Pose const &  pose,
core::pack::task::PackerTask task 
) const
overridevirtual

Apply this operation to the packer task.

Implements core::pack::task::operation::TaskOperation.

Reimplemented in protocols::simple_task_operations::RestrictToLoopsAndNeighbors.

void protocols::simple_task_operations::RestrictToLoops::apply_helper ( core::pose::Pose const &  pose,
core::pack::task::PackerTask task,
bool  include_neighbors,
core::Real  cutoff_distance,
bool  design_neighbors 
) const
protected
TaskOperationOP protocols::simple_task_operations::RestrictToLoops::clone ( ) const
overridevirtual
bool protocols::simple_task_operations::RestrictToLoops::design_loop ( ) const

Return true if design is allowed.

static std::string protocols::simple_task_operations::RestrictToLoops::keyname ( )
inlinestatic
LoopsCOP protocols::simple_task_operations::RestrictToLoops::loops ( ) const

Return the loops allowed to pack.

void protocols::simple_task_operations::RestrictToLoops::parse_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &   
)
overridevirtual

Configure from a RosettaScripts XML tag.

Reimplemented from core::pack::task::operation::TaskOperation.

Reimplemented in protocols::simple_task_operations::RestrictToLoopsAndNeighbors.

void protocols::simple_task_operations::RestrictToLoops::provide_attributes ( utility::tag::AttributeList &  attributes)
static
void protocols::simple_task_operations::RestrictToLoops::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
bool protocols::simple_task_operations::RestrictToLoops::restrict_only_design_to_loops ( ) const

Return true if we are restricting to only design. AKA RestrictDesignToLoops.

void protocols::simple_task_operations::RestrictToLoops::set_design_loop ( bool  design_loop)

Specify whether or not design is allowed.

void protocols::simple_task_operations::RestrictToLoops::set_loops ( loops::LoopsCOP  loops)

Specify the loops that will be allowed to pack.

void protocols::simple_task_operations::RestrictToLoops::set_loops_from_file ( std::string  loops_file)

Specify the loops that will be allowed to pack.

void protocols::simple_task_operations::RestrictToLoops::set_restrict_only_design_to_loops ( bool  restrict_only_design)

Specify whether to restrict only design to loops/neighbors AKA RestrictDesignToLoops. Does not disable packing for any residue. Implies and sets design_loop to true.

Member Data Documentation

bool protocols::simple_task_operations::RestrictToLoops::design_loops_ = false
private
utility::pointer::DeepCopyOP< loops::Loops const > protocols::simple_task_operations::RestrictToLoops::loops_
private
bool protocols::simple_task_operations::RestrictToLoops::restrict_only_design_ = false
private

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