Rosetta 3.4
Public Member Functions
protocols::moves::CycleMover Class Reference

CycleMover iterates through its vector of Movers one at a time over many calls to apply(). More...

#include <MoverContainer.hh>

Inheritance diagram for protocols::moves::CycleMover:
Inheritance graph
[legend]
Collaboration diagram for protocols::moves::CycleMover:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 CycleMover ()
 CycleMover (CycleMover const &source)
virtual MoverOP clone () const
 clone has to be overridden only if clone invocation is expected.
virtual void apply (core::pose::Pose &pose)
void reset_cycle_index ()
virtual std::string get_name () const
 Each derived class must specify its name. The class name.

Detailed Description

CycleMover iterates through its vector of Movers one at a time over many calls to apply().

Each time CycleMover.apply() is called, it calls apply() on the next Mover in its sequence, until reaching the end of the list and starting over. Useful for things like doing a full repack one out of every eight cycles, and a rotamer trials on the other seven.


Constructor & Destructor Documentation

protocols::moves::CycleMover::CycleMover ( ) [inline]

Referenced by clone().

protocols::moves::CycleMover::CycleMover ( CycleMover const &  source)

Member Function Documentation

void protocols::moves::CycleMover::apply ( core::pose::Pose pose) [virtual]
MoverOP protocols::moves::CycleMover::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::moves::Mover.

References CycleMover().

std::string protocols::moves::CycleMover::get_name ( ) const [virtual]

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

Implements protocols::moves::Mover.

void protocols::moves::CycleMover::reset_cycle_index ( )

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