#include <MonteCarloRecover.hh>

Inheritance diagram for protocols::simple_moves::MonteCarloRecover:

Collaboration diagram for protocols::simple_moves::MonteCarloRecover:

Public Types
typedef core::Size	Size

typedef core::Real	Real

typedef core::pose::Pose	Pose

typedef core::pose::PoseOP	PoseOP

typedef utility::tag::TagPtr	TagPtr

typedef protocols::moves::DataMap	DataMap

typedef protocols::filters::Filters_map	Filters_map

typedef protocols::moves::Movers_map	Movers_map

typedef protocols::moves::MoverOP	MoverOP

Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagPtr	TagPtr

typedef core::pose::Pose	Pose

typedef core::pose::PoseCOP	PoseCOP

typedef protocols::filters::Filters_map	Filters_map

typedef std::list< std::string >	Strings

Public Member Functions
	MonteCarloRecover ()
	default constructor More...

	~MonteCarloRecover ()
	destructor More...

virtual MoverOP	clone () const
	create copy constructor More...

virtual MoverOP	fresh_instance () const
	create this type of objectt More...

std::string	get_name () const
	Each derived class must specify its name. The class name. More...

virtual void	apply (Pose &pose)
	apply MonteCarloRecover (Mover) More...

void	set_MC (GenericMonteCarloMoverOP mover)
	set mover More...

GenericMonteCarloMoverOP	get_MC () const

virtual void	parse_my_tag (TagPtr const tag, DataMap &data, Filters_map const &filters, Movers_map const &movers, Pose const &)
	Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...

bool	recover_low () const

void	recover_low (bool const recover)

Public Member Functions inherited from protocols::moves::Mover
	Mover ()

virtual	~Mover ()

virtual MoverSP	create ()

virtual void	apply (core::io::serialization::PipeMap &pmap)

virtual void	parse_state (SerializableState const &state)

virtual void	parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks, MoverCacheSP cache)

virtual void	save_state (SerializableState &state)

	Mover (std::string const &type_name)
	sets the type for a mover; name_ has been removed (2010/05/14) More...

	Mover (Mover const &other)

Mover &	operator= (Mover const &other)
	assignment operator More...

virtual core::Real	last_proposal_density_ratio ()

std::string const &	type () const

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...

void	set_current_tag (std::string const &new_tag)

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	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...

void	type (const std::string &type_in)

std::string	get_type () const

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...

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 Strings &	info ()
	non-const accessor More...

virtual Strings const &	info () const
	const accessor More...

virtual bool	reinitialize_for_each_job () const
	this function informs 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
	this function informs 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...

void	set_current_job (protocols::jobdist::BasicJobCOP job)

jobdist::BasicJobCOP	get_current_job () const

Private Attributes
bool	recover_low_

GenericMonteCarloMoverOP	MC_mover_
	mover More...

Additional Inherited Members
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. these options will end up in -help of your application if users of this mover call register_options. do this recursively! if you use movers within your mover, call their register_options in your register_options() method. More...

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

Definition at line 39 of file MonteCarloRecover.hh.

Member Typedef Documentation

typedef protocols::moves::DataMap protocols::simple_moves::MonteCarloRecover::DataMap

Definition at line 48 of file MonteCarloRecover.hh.

typedef protocols::filters::Filters_map protocols::simple_moves::MonteCarloRecover::Filters_map

Definition at line 49 of file MonteCarloRecover.hh.

typedef protocols::moves::MoverOP protocols::simple_moves::MonteCarloRecover::MoverOP

Definition at line 51 of file MonteCarloRecover.hh.

typedef protocols::moves::Movers_map protocols::simple_moves::MonteCarloRecover::Movers_map

Definition at line 50 of file MonteCarloRecover.hh.

typedef core::pose::Pose protocols::simple_moves::MonteCarloRecover::Pose

Definition at line 44 of file MonteCarloRecover.hh.

typedef core::pose::PoseOP protocols::simple_moves::MonteCarloRecover::PoseOP

Definition at line 45 of file MonteCarloRecover.hh.

typedef core::Real protocols::simple_moves::MonteCarloRecover::Real

Definition at line 43 of file MonteCarloRecover.hh.

typedef core::Size protocols::simple_moves::MonteCarloRecover::Size

Definition at line 42 of file MonteCarloRecover.hh.

typedef utility::tag::TagPtr protocols::simple_moves::MonteCarloRecover::TagPtr

Definition at line 47 of file MonteCarloRecover.hh.

Constructor & Destructor Documentation

protocols::simple_moves::MonteCarloRecover::MonteCarloRecover ( )

default constructor

Definition at line 70 of file MonteCarloRecover.cc.

Referenced by clone(), and fresh_instance().

protocols::simple_moves::MonteCarloRecover::~MonteCarloRecover ( )

destructor

Definition at line 78 of file MonteCarloRecover.cc.

Member Function Documentation

void protocols::simple_moves::MonteCarloRecover::apply ( Pose & pose)

virtual

apply MonteCarloRecover (Mover)

Implements protocols::moves::Mover.

Definition at line 120 of file MonteCarloRecover.cc.

References MC_mover_, and recover_low().

MoverOP protocols::simple_moves::MonteCarloRecover::clone ( ) const

virtual

create copy constructor

clone this object

Reimplemented from protocols::moves::Mover.

Definition at line 82 of file MonteCarloRecover.cc.

References MonteCarloRecover().

MoverOP protocols::simple_moves::MonteCarloRecover::fresh_instance ( ) const

virtual

create this type of objectt

create this type of object

Reimplemented from protocols::moves::Mover.

Definition at line 89 of file MonteCarloRecover.cc.

References MonteCarloRecover().

GenericMonteCarloMoverOP protocols::simple_moves::MonteCarloRecover::get_MC ( ) const

Definition at line 95 of file MonteCarloRecover.cc.

References MC_mover_.

Referenced by parse_my_tag().

std::string protocols::simple_moves::MonteCarloRecover::get_name ( ) const

virtual

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

Implements protocols::moves::Mover.

Definition at line 64 of file MonteCarloRecover.cc.

void protocols::simple_moves::MonteCarloRecover::parse_my_tag	(	TagPtr const	tag,
		DataMap &	data,
		Filters_map const &	filters,
		Movers_map const &	movers,
		Pose const &	pose
	)

virtual

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

Some movers need not be parsed, so we shouldn't stop executions. This, however, calls attention to the lack of this method, which could be due to something as silly as a wrong parameters definition.

Reimplemented from protocols::moves::Mover.

Definition at line 105 of file MonteCarloRecover.cc.

References get_MC(), recover_low(), set_MC(), and protocols::simple_moves::TR().

bool protocols::simple_moves::MonteCarloRecover::recover_low ( ) const

Definition at line 128 of file MonteCarloRecover.cc.

References recover_low_.

Referenced by apply(), and parse_my_tag().

void protocols::simple_moves::MonteCarloRecover::recover_low ( bool const recover)

Definition at line 133 of file MonteCarloRecover.cc.

References recover_low_.

void protocols::simple_moves::MonteCarloRecover::set_MC ( GenericMonteCarloMoverOP mover)

set mover