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::simple_moves::CopyRotamerMover Class Reference

A mover to copy a rotamer (residue identity and conformation) from one position in a pose to another. More...

#include <CopyRotamerMover.hh>

Inheritance diagram for protocols::simple_moves::CopyRotamerMover:
Inheritance graph
[legend]

Public Member Functions

 CopyRotamerMover ()
 Constructors ///. More...
 
 CopyRotamerMover (CopyRotamerMover const &src)
 Copy constructor (not needed unless you need deep copies) More...
 
 ~CopyRotamerMover () override
 Destructor (important for properly forward-declaring smart-pointer members) More...
 
void apply (core::pose::Pose &pose) override
 Mover Methods ///. More...
 
void apply_from_template_pose (core::pose::Pose &target_pose, core::pose::Pose const &template_pose, core::Size target_res_index, core::Size template_res_index)
 Apply the mover on another pose, not accessible from rosetta_scripts. 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
 Get the name of the Mover. 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...
 
void set_template_res_index (core::Size const index_in)
 Setters ///. More...
 
void set_target_res_index (core::Size const index_in)
 Set pose index of the residue TO which we're copying. More...
 
void set_copy_identity (bool const setting_in)
 Set whether we're copying the residue identity. More...
 
void set_copy_torsions (bool const setting_in)
 Set whether we're copying the residue side-chain torsions. More...
 
std::string get_name () const override
 Each derived class must specify its name. The class name. 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

core::Size template_res_index_
 Pose index of the residue FROM which we're copying. More...
 
core::Size target_res_index_
 Pose index of the residue TO which we're copying. More...
 
bool copy_identity_
 Are we copying the residue identity? More...
 
bool copy_torsions_
 Are we copying side-chain torsions? More...
 

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

A mover to copy a rotamer (residue identity and conformation) from one position in a pose to another.

Constructor & Destructor Documentation

protocols::simple_moves::CopyRotamerMover::CopyRotamerMover ( )

Constructors ///.

Default constructor

protocols::simple_moves::CopyRotamerMover::CopyRotamerMover ( CopyRotamerMover const &  src)
default

Copy constructor (not needed unless you need deep copies)

Copy constructor.

protocols::simple_moves::CopyRotamerMover::~CopyRotamerMover ( )
overridedefault

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

Member Function Documentation

void protocols::simple_moves::CopyRotamerMover::apply ( core::pose::Pose pose)
overridevirtual
void protocols::simple_moves::CopyRotamerMover::apply_from_template_pose ( core::pose::Pose target_pose,
core::pose::Pose const &  template_pose,
core::Size  target_res_index,
core::Size  template_res_index 
)
protocols::moves::MoverOP protocols::simple_moves::CopyRotamerMover::clone ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::moves::Mover.

moves::MoverOP protocols::simple_moves::CopyRotamerMover::fresh_instance ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::moves::Mover.

std::string protocols::simple_moves::CopyRotamerMover::get_name ( ) const
overridevirtual

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

Implements protocols::moves::Mover.

References mover_name().

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

Get the name of the Mover.

Rosetta Scripts Support ///.

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

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

Reimplemented from protocols::moves::Mover.

References copy_identity_, copy_torsions_, set_copy_identity(), set_copy_torsions(), set_target_res_index(), set_template_res_index(), template_res_index_, and protocols::simple_moves::TR().

void protocols::simple_moves::CopyRotamerMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::simple_moves::CopyRotamerMover::set_copy_identity ( bool const  setting_in)

Set whether we're copying the residue identity.

References copy_identity_, and protocols::simple_moves::TR().

Referenced by parse_my_tag().

void protocols::simple_moves::CopyRotamerMover::set_copy_torsions ( bool const  setting_in)

Set whether we're copying the residue side-chain torsions.

References copy_torsions_, and protocols::simple_moves::TR().

Referenced by parse_my_tag().

void protocols::simple_moves::CopyRotamerMover::set_target_res_index ( core::Size const  index_in)

Set pose index of the residue TO which we're copying.

References target_res_index_, and protocols::simple_moves::TR().

Referenced by parse_my_tag().

void protocols::simple_moves::CopyRotamerMover::set_template_res_index ( core::Size const  index_in)

Setters ///.

Set pose index of the residue FROM which we're copying.

References template_res_index_, and protocols::simple_moves::TR().

Referenced by parse_my_tag().

void protocols::simple_moves::CopyRotamerMover::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::simple_moves::operator<<().

Member Data Documentation

bool protocols::simple_moves::CopyRotamerMover::copy_identity_
private

Are we copying the residue identity?

Default true.

Referenced by apply(), apply_from_template_pose(), parse_my_tag(), and set_copy_identity().

bool protocols::simple_moves::CopyRotamerMover::copy_torsions_
private

Are we copying side-chain torsions?

Default true.

Referenced by apply(), apply_from_template_pose(), parse_my_tag(), and set_copy_torsions().

core::Size protocols::simple_moves::CopyRotamerMover::target_res_index_
private

Pose index of the residue TO which we're copying.

Referenced by apply(), apply_from_template_pose(), and set_target_res_index().

core::Size protocols::simple_moves::CopyRotamerMover::template_res_index_
private

Pose index of the residue FROM which we're copying.

Referenced by apply(), apply_from_template_pose(), parse_my_tag(), and set_template_res_index().


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