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::moves::IteratedConvergenceMover Class Reference

A mover that repeatedly applies a sub-mover (up to a given maximum) until the given filter returns values within a certain delta for a given number of cycles. More...

#include <IteratedConvergenceMover.hh>

Inheritance diagram for protocols::moves::IteratedConvergenceMover:
Inheritance graph
[legend]

Public Member Functions

 IteratedConvergenceMover ()
 default constructor More...
 
 IteratedConvergenceMover (MoverOP submover, filters::FilterCOP filter, core::Real delta=0.1, core::Size cycles=1, core::Size maxcycles=1000)
 
 ~IteratedConvergenceMover () override
 
 IteratedConvergenceMover (IteratedConvergenceMover const &other)
 
void apply (Pose &pose) override
 Main Method. More...
 
void parse_my_tag (TagCOP, basic::datacache::DataMap &) override
 parse XML (specifically in the context of the parser/scripting scheme) More...
 
MoverOP fresh_instance () const override
 required in the context of the parser/scripting scheme More...
 
MoverOP clone () const override
 required in the context of the parser/scripting scheme More...
 
void submover (MoverOP mover)
 
void filter (filters::FilterCOP filter)
 
void delta (core::Real delta)
 
void cycles (core::Size cycles)
 
void maxcycles (core::Size maxcycles)
 
MoverOP submover () const
 
filters::FilterCOP filter () const
 
core::Real delta () const
 
core::Size cycles () const
 
core::Size maxcycles () const
 
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 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...
 
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

MoverOP submover_
 
filters::FilterCOP filter_
 
core::Real delta_
 
core::Size cycles_
 
core::Size maxcycles_
 

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 that repeatedly applies a sub-mover (up to a given maximum) until the given filter returns values within a certain delta for a given number of cycles.

Constructor & Destructor Documentation

protocols::moves::IteratedConvergenceMover::IteratedConvergenceMover ( )

default constructor

protocols::moves::IteratedConvergenceMover::IteratedConvergenceMover ( MoverOP  submover,
filters::FilterCOP  filter,
core::Real  delta = 0.1,
core::Size  cycles = 1,
core::Size  maxcycles = 1000 
)

References delta().

protocols::moves::IteratedConvergenceMover::~IteratedConvergenceMover ( )
overridedefault
protocols::moves::IteratedConvergenceMover::IteratedConvergenceMover ( IteratedConvergenceMover const &  other)
default

Member Function Documentation

void protocols::moves::IteratedConvergenceMover::apply ( Pose )
overridevirtual
MoverOP protocols::moves::IteratedConvergenceMover::clone ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::moves::Mover.

void protocols::moves::IteratedConvergenceMover::cycles ( core::Size  cycles)

References cycles(), and cycles_.

core::Size protocols::moves::IteratedConvergenceMover::cycles ( ) const

References cycles_.

Referenced by cycles(), and parse_my_tag().

void protocols::moves::IteratedConvergenceMover::delta ( core::Real  delta)

References delta(), and delta_.

core::Real protocols::moves::IteratedConvergenceMover::delta ( ) const

References delta_.

Referenced by delta(), IteratedConvergenceMover(), and parse_my_tag().

void protocols::moves::IteratedConvergenceMover::filter ( filters::FilterCOP  filter)

References filter(), and filter_.

filters::FilterCOP protocols::moves::IteratedConvergenceMover::filter ( ) const

References filter_.

Referenced by filter(), and parse_my_tag().

MoverOP protocols::moves::IteratedConvergenceMover::fresh_instance ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::moves::Mover.

std::string protocols::moves::IteratedConvergenceMover::get_name ( ) const
overridevirtual

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

Implements protocols::moves::Mover.

References mover_name().

void protocols::moves::IteratedConvergenceMover::maxcycles ( core::Size  maxcycles)

References maxcycles(), and maxcycles_.

core::Size protocols::moves::IteratedConvergenceMover::maxcycles ( ) const

References maxcycles_.

Referenced by maxcycles(), and parse_my_tag().

std::string protocols::moves::IteratedConvergenceMover::mover_name ( )
static
void protocols::moves::IteratedConvergenceMover::parse_my_tag ( TagCOP  tag,
basic::datacache::DataMap &  data 
)
overridevirtual

parse XML (specifically in the context of the parser/scripting scheme)

Reimplemented from protocols::moves::Mover.

References cycles(), delta(), filter(), maxcycles(), mover_name(), protocols::rosetta_scripts::parse_filter(), protocols::rosetta_scripts::parse_mover(), submover(), and protocols::moves::TR().

void protocols::moves::IteratedConvergenceMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::moves::IteratedConvergenceMover::submover ( MoverOP  mover)

References submover_.

MoverOP protocols::moves::IteratedConvergenceMover::submover ( ) const

References submover_.

Referenced by parse_my_tag().

Member Data Documentation

core::Size protocols::moves::IteratedConvergenceMover::cycles_
private

Referenced by apply(), and cycles().

core::Real protocols::moves::IteratedConvergenceMover::delta_
private

Referenced by apply(), and delta().

filters::FilterCOP protocols::moves::IteratedConvergenceMover::filter_
private

Referenced by apply(), and filter().

core::Size protocols::moves::IteratedConvergenceMover::maxcycles_
private

Referenced by apply(), and maxcycles().

MoverOP protocols::moves::IteratedConvergenceMover::submover_
private

Referenced by apply(), and submover().


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