Rosetta 3.4
Public Member Functions
protocols::simple_moves::MutateResidue Class Reference

A mover to mutate a single residue. More...

#include <MutateResidue.hh>

Inheritance diagram for protocols::simple_moves::MutateResidue:
Inheritance graph
[legend]
Collaboration diagram for protocols::simple_moves::MutateResidue:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 MutateResidue ()
 default ctor
 MutateResidue (MutateResidue const &dm)
 copy ctor
 MutateResidue (core::Size const target, std::string const new_res)
 Mutate a single residue to a new amino acid.
 MutateResidue (core::Size const target, char const new_res)
virtual ~MutateResidue ()
virtual void apply (core::pose::Pose &pose)
virtual std::string get_name () const
 Each derived class must specify its name. The class name.
virtual protocols::moves::MoverOP clone () const
 clone has to be overridden only if clone invocation is expected.
virtual protocols::moves::MoverOP fresh_instance () const
 this is like clone(), except it generates a new mover object freshly created with the default ctor. This function _should_ be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage).
void parse_my_tag (utility::tag::TagPtr const tag, protocols::moves::DataMap &, protocols::filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &)
 Reinitialize this protocols::moves::Mover with parameters from the specified tags.

Detailed Description

A mover to mutate a single residue.


Constructor & Destructor Documentation

protocols::simple_moves::MutateResidue::MutateResidue ( )

default ctor

protocols::simple_moves::MutateResidue::MutateResidue ( MutateResidue const &  dm)

copy ctor

protocols::simple_moves::MutateResidue::MutateResidue ( core::Size const  target,
std::string const  new_res 
)

Mutate a single residue to a new amino acid.

Parameters:
targetThe residue index to mutate
new_resThe name of the replacement residue
protocols::simple_moves::MutateResidue::MutateResidue ( core::Size const  target,
char const  new_res 
)
virtual protocols::simple_moves::MutateResidue::~MutateResidue ( ) [inline, virtual]

Member Function Documentation

void protocols::simple_moves::MutateResidue::apply ( core::pose::Pose pose) [virtual]
virtual protocols::moves::MoverOP protocols::simple_moves::MutateResidue::clone ( ) const [inline, virtual]

clone has to be overridden only if clone invocation is expected.

clone is meant to return an OP'ed deep copy of this object. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function.

Reimplemented from protocols::moves::Mover.

virtual protocols::moves::MoverOP protocols::simple_moves::MutateResidue::fresh_instance ( ) const [inline, virtual]

this is like clone(), except it generates a new mover object freshly created with the default ctor. This function _should_ be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage).

fresh_instance is meant to return a new object of this class, created with the default constructor. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function. This is used by the August 08 job distributor.

Reimplemented from protocols::moves::Mover.

std::string protocols::simple_moves::MutateResidue::get_name ( ) const [virtual]

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

Implements protocols::moves::Mover.

References protocols::simple_moves::MutateResidueCreator::mover_name().

void protocols::simple_moves::MutateResidue::parse_my_tag ( utility::tag::TagPtr const  tag,
protocols::moves::DataMap ,
protocols::filters::Filters_map const &  ,
protocols::moves::Movers_map const &  ,
core::pose::Pose const &  pose 
) [virtual]

Reinitialize this protocols::moves::Mover with parameters from the specified tags.

Parameters recognized:

  • target_pdb_num or target_res_num. A single target residue to form disulfides to
  • target_pdb_nums or target_res_nums. A list of possible target residues

Reimplemented from protocols::moves::Mover.

References protocols::rosetta_scripts::parse_resnum(), and protocols::simple_moves::TR().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines