Public Types | Public Member Functions | Private Attributes | List of all members
protocols::relax::MiniRelax Class Reference

#include <MiniRelax.hh>

Inheritance diagram for protocols::relax::MiniRelax:
Inheritance graph

Public Types

typedef RelaxProtocolBase parent
- Public Types inherited from protocols::relax::RelaxProtocolBase
typedef moves::Mover parent
- 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

Public Member Functions

 MiniRelax (core::scoring::ScoreFunctionOP scorefxn_in)
 MiniRelax (MiniRelax const &other)
 ~MiniRelax () override
protocols::moves::MoverOP clone () const override
 Return a clone of the Mover object. More...
void apply (core::pose::Pose &pose) override
 Main Method. More...
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
- Public Member Functions inherited from protocols::relax::RelaxProtocolBase
 RelaxProtocolBase (core::scoring::ScoreFunctionOP)
 RelaxProtocolBase (std::string const &movername="RelaxProtocol")
 RelaxProtocolBase (std::string const &movername, core::scoring::ScoreFunctionOP)
 ~RelaxProtocolBase () override
protocols::moves::MoverOP fresh_instance () const override
 Generates a new Mover object freshly created with the default ctor. More...
void apply_disulfides (core::pose::Pose &pose)
void set_defaults ()
void set_default_minimization_settings ()
void set_default_coordinate_settings ()
void set_default_movemap ()
core::kinematics::MoveMapCOP get_movemap () const
core::kinematics::MoveMapOP get_movemap ()
const core::scoring::ScoreFunctionCOP get_scorefxn () const
core::pack::task::TaskFactoryOP const & get_task_factory () const
bool cartesian () const
std::string min_type () const
core::Size max_iter () const
bool dry_run () const
bool constrain_relax_to_native_coords () const
bool constrain_relax_to_start_coords () const
bool constrain_coords () const
bool coord_constrain_sidechains () const
bool ramp_down_constraints () const
bool constrain_relax_segments () const
bool minimize_bond_lengths () const
bool minimize_bond_angles () const
void set_movemap (core::kinematics::MoveMapOP movemap)
void set_movemap_factory (core::select::movemap::MoveMapFactoryOP mm_factory)
void set_scorefxn (core::scoring::ScoreFunctionOP scorefxn)
void set_task_factory (core::pack::task::TaskFactoryOP task_factory)
void cartesian (bool newval)
 Use cartesian (minimization step) More...
void min_type (std::string min_type)
void max_iter (core::Size max_iter)
void dry_run (bool setting)
void constrain_relax_to_native_coords (bool constrain_relax_to_native_coords)
void constrain_relax_to_start_coords (bool constrain_relax_to_start_coords)
void constrain_coords (bool constrain_coords)
void coord_constrain_sidechains (bool coord_constrain_sidechains)
void constrain_relax_segments (bool constrain_relax_segments)
void ramp_down_constraints (bool ramp_down_constraints)
void minimize_bond_lengths (bool minimize_bond_lengths)
void minimize_bond_angles (bool minimize_bond_angles)
void provide_citation_info (basic::citation_manager::CitationCollectionList &) const override
 Provide the citation. 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
virtual void parse_my_tag (TagCOP tag, basic::datacache::DataMap &data)
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
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 void show (std::ostream &output=std::cout) const
 Outputs details about the Mover, including current settings. 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...

Private Attributes

core::scoring::ScoreFunctionOP scorefxn_

Additional Inherited Members

- Static Public Member Functions inherited from protocols::relax::RelaxProtocolBase
static void register_options ()
- 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...
- Protected Member Functions inherited from protocols::relax::RelaxProtocolBase
core::scoring::ScoreFunctionOP get_scorefxn ()
bool fix_omega () const
int minimize_bondlength_subset () const
int minimize_bondangle_subset () const
bool limit_aroma_chi2 () const
std::string cst_files (core::Size const i) const
void fix_omega (bool fix_omega)
void minimize_bondangle_subset (int minimize_bondangle_subset)
void minimize_bondlength_subset (int minimize_bondlength_subset)
void initialize_movemap (core::pose::Pose const &pose, core::kinematics::MoveMap &movemap)
void set_up_constraints (core::pose::Pose &pose, core::kinematics::MoveMap &local_movemap)
void output_debug_structure (core::pose::Pose &pose, std::string prefix)
void add_cst_files (std::string const &cstfile)
- 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...

Member Typedef Documentation

◆ parent

Constructor & Destructor Documentation

◆ MiniRelax() [1/2]

protocols::relax::MiniRelax::MiniRelax ( core::scoring::ScoreFunctionOP  scorefxn_in)

◆ MiniRelax() [2/2]

protocols::relax::MiniRelax::MiniRelax ( MiniRelax const &  other)

◆ ~MiniRelax()

protocols::relax::MiniRelax::~MiniRelax ( )

Member Function Documentation

◆ apply()

void protocols::relax::MiniRelax::apply ( core::pose::Pose )

◆ clone()

protocols::moves::MoverOP protocols::relax::MiniRelax::clone ( ) const

Return a clone of the Mover object.

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.

◆ get_name()

std::string protocols::relax::MiniRelax::get_name ( ) const

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

Implements protocols::moves::Mover.

Member Data Documentation

◆ scorefxn_

core::scoring::ScoreFunctionOP protocols::relax::MiniRelax::scorefxn_

Referenced by apply().

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