Basic mover used primarily for setting up atomic protocols, especially in generator functions. More...

#include <ChangeAndResetFoldTreeMover.hh>

Inheritance diagram for protocols::simple_moves::ChangeAndResetFoldTreeMover:

[legend]

Public Member Functions
	ChangeAndResetFoldTreeMover ()
	Basic Constructor. More...

	ChangeAndResetFoldTreeMover (protocols::moves::MoverOP main_mover)

	ChangeAndResetFoldTreeMover (protocols::moves::MoverOP main_mover, protocols::moves::ChangeFoldTreeMoverOP ft_mover)

	ChangeAndResetFoldTreeMover (protocols::moves::MoverOP main_mover, protocols::moves::ChangeFoldTreeMoverOP ft_mover, core::scoring::ScoreFunctionCOP scorefxn)
	Constructor with all needed classes as well as the optional scorefxn. Note that the scorefxn is ONLY used for printing score information in apply. More...

	ChangeAndResetFoldTreeMover (ChangeAndResetFoldTreeMover const &src)

	~ChangeAndResetFoldTreeMover () override

void	set_mover (protocols::moves::MoverOP main_mover) override
	Set the main mover to apply. More...

protocols::moves::MoverOP	mover () const override
	Get the main mover. More...

void	set_ft_mover (protocols::moves::ChangeFoldTreeMoverOP ft_mover)
	Set the ChangeFoldTreeMover. More...

protocols::moves::ChangeFoldTreeMoverOP	ft_mover () const
	Get the ChangeFoldTreeMover. More...

void	apply (core::pose::Pose &pose) override

void	set_scorefxn (core::scoring::ScoreFunctionCOP scorefxn)
	Set the ScoreFunction. Used ONLY for printing score information before and after the move!! More...

core::scoring::ScoreFunctionCOP	scorefxn () const
	Get the set ScoreFunction. More...

protocols::moves::MoverOP	clone () const override
	Return a clone of the Mover object. More...

protocols::moves::MoverOP	fresh_instance () const override
	Generates a new Mover object freshly created with the default ctor. More...

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

Public Member Functions inherited from protocols::moves::MoverApplyingMover
	MoverApplyingMover (std::string const &name)

	MoverApplyingMover (MoverApplyingMover const &)=default

	~MoverApplyingMover () override=default

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

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

virtual void	provide_citation_info (basic::citation_manager::CitationCollectionList &) const
	Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. 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
protocols::moves::MoverOP	main_mover_

protocols::moves::ChangeFoldTreeMoverOP	ft_mover_

core::scoring::ScoreFunctionCOP	scorefxn_

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

Basic mover used primarily for setting up atomic protocols, especially in generator functions.

As the Topology Broker system includes more claims and is more widely adopted, This should not be used in favor of the Broker system.

1) Holds the Pose's original FoldTree 2) Applies its ChangeFoldTreeMover 3) Applies its Main mover 4) Returns the Pose's original FoldTree

Constructor & Destructor Documentation

◆ ChangeAndResetFoldTreeMover() [1/5]

protocols::simple_moves::ChangeAndResetFoldTreeMover::ChangeAndResetFoldTreeMover ( )

Basic Constructor.

◆ ChangeAndResetFoldTreeMover() [2/5]

protocols::simple_moves::ChangeAndResetFoldTreeMover::ChangeAndResetFoldTreeMover ( protocols::moves::MoverOP main_mover )

◆ ChangeAndResetFoldTreeMover() [3/5]

protocols::simple_moves::ChangeAndResetFoldTreeMover::ChangeAndResetFoldTreeMover	(	protocols::moves::MoverOP	main_mover,
		protocols::moves::ChangeFoldTreeMoverOP	ft_mover
	)

◆ ChangeAndResetFoldTreeMover() [4/5]

protocols::simple_moves::ChangeAndResetFoldTreeMover::ChangeAndResetFoldTreeMover	(	protocols::moves::MoverOP	main_mover,
		protocols::moves::ChangeFoldTreeMoverOP	ft_mover,
		core::scoring::ScoreFunctionCOP	scorefxn
	)

Constructor with all needed classes as well as the optional scorefxn. Note that the scorefxn is ONLY used for printing score information in apply.

◆ ChangeAndResetFoldTreeMover() [5/5]

protocols::simple_moves::ChangeAndResetFoldTreeMover::ChangeAndResetFoldTreeMover ( ChangeAndResetFoldTreeMover const & src )

default

◆ ~ChangeAndResetFoldTreeMover()

protocols::simple_moves::ChangeAndResetFoldTreeMover::~ChangeAndResetFoldTreeMover ( )

overridedefault

Member Function Documentation

◆ apply()

void protocols::simple_moves::ChangeAndResetFoldTreeMover::apply ( core::pose::Pose & pose )

overridevirtual

1) Holds the Pose's original FoldTree 2) Applies the ChangeFoldTreeMover 3) Applies the Main mover 4) Returns the Pose's original FoldTree

Implements protocols::moves::Mover.

References core::pose::Pose::fold_tree(), ft_mover_, main_mover_, scorefxn_, and protocols::simple_moves::TR().

◆ clone()

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

overridevirtual

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.

◆ fresh_instance()

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

overridevirtual

Generates a new Mover object freshly created with the default ctor.

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::moves::Mover.