Rosetta 3.4
Public Member Functions
protocols::simple_moves::symmetry::SymMinMover Class Reference

#include <SymMinMover.hh>

Inheritance diagram for protocols::simple_moves::symmetry::SymMinMover:
Inheritance graph
[legend]
Collaboration diagram for protocols::simple_moves::symmetry::SymMinMover:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SymMinMover ()
 SymMinMover (std::string const &)
 ~SymMinMover ()
 SymMinMover (core::kinematics::MoveMapOP movemap_in, ScoreFunctionCOP scorefxn_in, std::string const &min_type_in, Real tolerance_in, bool use_nb_list_in, bool deriv_check_in=false, bool deriv_check_verbose_in=false)
virtual void apply (core::pose::Pose &pose_)
 Minimizes the DOFs of <pose_> specified in the MoveMap using the ScoreFunction.
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).
virtual void parse_my_tag (utility::tag::TagPtr const tag, moves::DataMap &data, filters::Filters_map const &filters, moves::Movers_map const &movers, core::pose::Pose const &pose)
 Called by protocols::moves::MoverFactory when constructing new protocols::moves::Movers. Takes care of the specific mover's parsing.

Constructor & Destructor Documentation

protocols::simple_moves::symmetry::SymMinMover::SymMinMover ( )

Referenced by clone(), and fresh_instance().

protocols::simple_moves::symmetry::SymMinMover::SymMinMover ( std::string const &  name)
protocols::simple_moves::symmetry::SymMinMover::~SymMinMover ( )
protocols::simple_moves::symmetry::SymMinMover::SymMinMover ( core::kinematics::MoveMapOP  movemap_in,
ScoreFunctionCOP  scorefxn_in,
std::string const &  min_type_in,
Real  tolerance_in,
bool  use_nb_list_in,
bool  deriv_check_in = false,
bool  deriv_check_verbose_in = false 
)

Member Function Documentation

void protocols::simple_moves::symmetry::SymMinMover::apply ( core::pose::Pose pose_) [virtual]
protocols::moves::MoverOP protocols::simple_moves::symmetry::SymMinMover::clone ( ) const [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::simple_moves::MinMover.

References SymMinMover().

protocols::moves::MoverOP protocols::simple_moves::symmetry::SymMinMover::fresh_instance ( ) const [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::simple_moves::MinMover.

References SymMinMover().

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

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

Reimplemented from protocols::simple_moves::MinMover.

References protocols::simple_moves::symmetry::SymMinMoverCreator::mover_name().

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

Called by protocols::moves::MoverFactory when constructing new protocols::moves::Movers. Takes care of the specific mover's parsing.

Reimplemented from protocols::simple_moves::MinMover.


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