Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::backbone_moves::local_backbone_mover::LocalBackboneMover Class Reference

LocalBackboneMover moves a stretch of backbone locally. More...

#include <LocalBackboneMover.hh>

Inheritance diagram for protocols::backbone_moves::local_backbone_mover::LocalBackboneMover:
Inheritance graph
[legend]

Public Member Functions

 LocalBackboneMover ()
 Constructors ///. More...
 
 LocalBackboneMover (LocalBackboneMover const &)=default
 Copy constructor (not needed unless you need deep copies) More...
 
 ~LocalBackboneMover () override
 Destructor (important for properly forward-declaring smart-pointer members) More...
 
void apply (core::pose::Pose &pose) override
 Mover Methods ///. More...
 
void show (std::ostream &output=std::cout) const override
 Show the contents of the Mover. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
 Rosetta Scripts Support ///. More...
 
protocols::moves::MoverOP fresh_instance () const override
 required in the context of the parser/scripting scheme More...
 
protocols::moves::MoverOP clone () const override
 required in the context of the parser/scripting scheme More...
 
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
 
void clear_free_peptide_movers ()
 Specific Methods ///. More...
 
void add_free_peptide_mover (free_peptide_movers::FreePeptideMoverOP free_peptide_mover)
 Add a free peptide mover. More...
 
void set_free_peptide (core::pose::Pose &pose, core::Size pivot1, core::Size pivot2)
 Set the free peptide. More...
 
void set_max_trial_num (core::Size max_trial_num)
 Set the maximum number of move trials. More...
 
- Public Member Functions inherited from protocols::moves::Mover
 Mover ()
 
virtual MoverOP create ()
 
MoverCOP get_self_ptr () const
 
MoverOP get_self_ptr ()
 
MoverCAP get_self_weak_ptr () const
 
MoverAP get_self_weak_ptr ()
 
 Mover (std::string const &type_name)
 sets the type for a mover; name_ has been removed (2010/05/14) More...
 
virtual void test_move (Pose &pose)
 : Unit test support function. Apply one move to a given pose. Allows extra test specific functions to be called before applying More...
 
virtual bool reinitialize_for_each_job () const
 Inform the Job Distributor (August '08 vintage) whether this object needs to be freshly regenerated on each use. More...
 
virtual bool reinitialize_for_new_input () const
 Inform the Job Distributor (August '08 vintage) whether this object needs to be regenerated when the input pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose). More...
 
MoverStatus get_last_move_status () const
 end parser interface, start Job Distributor interface///////////// More...
 
void reset_status ()
 resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s. More...
 
virtual core::pose::PoseOP get_additional_output ()
 Mechanism by which a mover may return multiple output poses from a single input pose. More...
 
void set_type (std::string const &setting)
 Set the 'type' string. More...
 
std::string get_type () const
 
void type (const std::string &type_in)
 Set the 'type' string. More...
 
std::string const & type () const
 Get the set 'type' string. More...
 
virtual void set_input_pose (PoseCOP pose)
 setter for poses contained for rms More...
 
virtual void set_native_pose (PoseCOP pose)
 setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...
 
PoseCOP get_input_pose () const
 
PoseCOP get_native_pose () const
 
void set_current_job (protocols::jobdist::BasicJobCOP job)
 
jobdist::BasicJobCOP get_current_job () const
 
virtual void set_current_tag (std::string const &new_tag)
 
std::string get_current_tag () const
 A tag is a unique identifier used to identify structures produced by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor. More...
 
virtual core::Real last_proposal_density_ratio ()
 
virtual void clear_info ()
 Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file. More...
 
virtual Stringsinfo ()
 non-const accessor More...
 
virtual Strings const & info () const
 const accessor More...
 
virtual bool mover_provides_citation_info () const
 Does this mover provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool mover_is_unpublished () const
 Does this mover indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. More...
 

Static Public Member Functions

static std::string mover_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
- Static Public Member Functions inherited from protocols::moves::Mover
static std::string name ()
 
static void register_options ()
 Overload this static method if you access options within the mover. More...
 

Private Attributes

GapCloserOP gap_closer_ = nullptr
 
vector1
< free_peptide_movers::FreePeptideMoverOP
free_peptide_movers_
 
FreePeptideOP free_peptide_
 
core::Size max_trial_num_ = 0
 
core::Size pivot1_ = 0
 
core::Size pivot2_ = 0
 

Additional Inherited Members

- Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagCOP TagCOP
 
typedef core::pose::Pose Pose
 
typedef core::pose::PoseCOP PoseCOP
 
typedef std::list< std::string > Strings
 
- Protected Member Functions inherited from protocols::moves::Mover
void set_last_move_status (MoverStatus status)
 nonvirtual setter for MoverStatus last_status_. Protected means that only the mover itself will be able to change its own status. The job distributor (august 08 vintage) is aware of status set with this function and will do what the MoverStatus says. More...
 

Detailed Description

LocalBackboneMover moves a stretch of backbone locally.

Constructor & Destructor Documentation

protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::LocalBackboneMover ( )

Constructors ///.

Default constructor

References gap_closer_, and set_max_trial_num().

protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::LocalBackboneMover ( LocalBackboneMover const &  )
default

Copy constructor (not needed unless you need deep copies)

protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::~LocalBackboneMover ( )
overridedefault

Destructor (important for properly forward-declaring smart-pointer members)

Member Function Documentation

void protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::add_free_peptide_mover ( free_peptide_movers::FreePeptideMoverOP  free_peptide_mover)
inline

Add a free peptide mover.

References free_peptide_movers_.

Referenced by parse_my_tag().

void protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::apply ( core::pose::Pose pose)
overridevirtual

Mover Methods ///.

Apply the mover

Implements protocols::moves::Mover.

References free_peptide_, free_peptide_movers_, gap_closer_, max_trial_num_, pivot1_, pivot2_, and set_free_peptide().

void protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::clear_free_peptide_movers ( )
inline

Specific Methods ///.

Clear all free peptide movers

References free_peptide_movers_.

Referenced by parse_my_tag().

protocols::moves::MoverOP protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::clone ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::moves::Mover.

moves::MoverOP protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::fresh_instance ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::moves::Mover.

std::string protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::get_name ( ) const
overridevirtual

Each derived class must specify its name. The class name.

Implements protocols::moves::Mover.

References mover_name().

std::string protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::mover_name ( )
static
void protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  data 
)
overridevirtual

Rosetta Scripts Support ///.

parse XML tag (to use this Mover in Rosetta Scripts)

Reimplemented from protocols::moves::Mover.

References add_free_peptide_mover(), clear_free_peptide_movers(), pivot1_, and pivot2_.

void protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::set_free_peptide ( core::pose::Pose pose,
core::Size  pivot1,
core::Size  pivot2 
)

Set the free peptide.

References free_peptide_, and core::pose::Pose::size().

Referenced by apply().

void protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::set_max_trial_num ( core::Size  max_trial_num)
inline

Set the maximum number of move trials.

References max_trial_num_.

Referenced by LocalBackboneMover().

void protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::show ( std::ostream &  output = std::cout) const
overridevirtual

Show the contents of the Mover.

Reimplemented from protocols::moves::Mover.

References protocols::moves::Mover::show().

Referenced by protocols::backbone_moves::local_backbone_mover::operator<<().

Member Data Documentation

FreePeptideOP protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::free_peptide_
private

Referenced by apply(), and set_free_peptide().

vector1<free_peptide_movers::FreePeptideMoverOP> protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::free_peptide_movers_
private
GapCloserOP protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::gap_closer_ = nullptr
private

Referenced by apply(), and LocalBackboneMover().

core::Size protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::max_trial_num_ = 0
private

Referenced by apply(), and set_max_trial_num().

core::Size protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::pivot1_ = 0
private

Referenced by apply(), and parse_my_tag().

core::Size protocols::backbone_moves::local_backbone_mover::LocalBackboneMover::pivot2_ = 0
private

Referenced by apply(), and parse_my_tag().


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