A Mover that iterates through a vector of Movers, applying each one sequentially. More...

#include <MoverContainer.hh>

Inheritance diagram for protocols::moves::SequenceMover:

Public Member Functions
	SequenceMover (bool ms=false)
	Constructs a SequenceMover, optionally setting to use mover status. seqmover = SequenceMover() More...

	SequenceMover (MoverOP mover1, MoverOP mover2)
	Convenience constructor: initial sequence of 2 movers seqmover = SequenceMover( mover1 , mover2 ) More...

	SequenceMover (MoverOP mover1, MoverOP mover2, MoverOP mover3)
	Convenience constructor: initial sequence of 3 movers seqmover = SequenceMover( mover1 , mover2 , mover3 ) More...

	SequenceMover (SequenceMover const &)
	Copy constructor – performs a deep copy of all contained movers. Invoked by clone() More...

MoverOP	clone () const override
	deep copy of all contained movers. More...

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

void	use_mover_status (bool const flag)
	MoverStatus of the mover will be evaluated after each mover. More...

bool	use_mover_status ()

void	apply (core::pose::Pose &pose) override
	Applies a series of movers sequentially on a Pose. 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::MoverContainer
	MoverContainer ()

	MoverContainer (MoverContainer const &source)
	to be called by derived-class clone() methods; copy all data from the source MoverContainer More...

void	add_mover (MoverOP mover_in, core::Real weight_in=1.0)
	Adds a mover to the end of this container. More...

std::string	get_mover (core::Size index) const

void	clear ()

void	set_input_pose (PoseCOP pose) override
	Sets the input Pose for both the container and the contained movers, for rmsd. More...

void	set_native_pose (PoseCOP pose) override
	setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...

void	set_current_tag (std::string const &new_tag) override

Size	nr_moves ()

Size	size () const

MoverOP	front ()

utility::vector0< core::Real > const &	weights () const

utility::vector0< MoverOP > const &	movers () const

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

	~Mover () override

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

void	set_type (std::string const &setting)

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

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)

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

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

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

jobdist::BasicJobCOP	get_current_job () const

virtual void	show (std::ostream &output=std::cout) const
	Outputs details about the Mover, including current settings. More...

Private Attributes
bool	use_mover_status_
	use mover status ( default false ) More...

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 protocols::filters::Filters_map	Filters_map

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

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

Protected Attributes inherited from protocols::moves::MoverContainer
utility::vector0< core::Real >	weight_
	relative weight when part of MoverContainer. More...

utility::vector0< MoverOP >	movers_

Detailed Description

A Mover that iterates through a vector of Movers, applying each one sequentially.

Common Methods: SequenceMover.add_mover SequenceMover.apply

Constructor & Destructor Documentation

protocols::moves::SequenceMover::SequenceMover ( bool ms = false )

Constructs a SequenceMover, optionally setting to use mover status. seqmover = SequenceMover()

Constructs a SequenceMover seqmover = SequenceMover()

Referenced by clone(), and fresh_instance().

protocols::moves::SequenceMover::SequenceMover	(	MoverOP	mover1,
		MoverOP	mover2
	)

Convenience constructor: initial sequence of 2 movers seqmover = SequenceMover( mover1 , mover2 )

Mover mover1 /first mover to apply with SequenceMover.apply Mover mover2 /second mover to apply with SequenceMover.apply

References protocols::moves::MoverContainer::add_mover().

protocols::moves::SequenceMover::SequenceMover	(	MoverOP	mover1,
		MoverOP	mover2,
		MoverOP	mover3
	)

Convenience constructor: initial sequence of 3 movers seqmover = SequenceMover( mover1 , mover2 , mover3 )

Mover mover1 /first mover to apply with SequenceMover.apply Mover mover2 /second mover to apply with SequenceMover.apply Mover mover3 /third mover to apply with SequenceMover.apply

References protocols::moves::MoverContainer::add_mover().

protocols::moves::SequenceMover::SequenceMover ( SequenceMover const & )

default

Copy constructor – performs a deep copy of all contained movers. Invoked by clone()

Member Function Documentation

void protocols::moves::SequenceMover::apply ( core::pose::Pose & pose )

overridevirtual

Applies a series of movers sequentially on a Pose.

example(s): seqmover.apply(pose) See also: MinMover RepeatMover SequenceMover TrialMover

Implements protocols::moves::MoverContainer.

References protocols::moves::FAIL_BAD_INPUT, protocols::moves::FAIL_DO_NOT_RETRY, protocols::moves::FAIL_RETRY, protocols::moves::MoverContainer::movers_, protocols::moves::MS_SUCCESS, protocols::moves::Mover::set_last_move_status(), protocols::moves::TR(), protocols::moves::Mover::type(), and use_mover_status_.

MoverOP protocols::moves::SequenceMover::clone ( ) const

overridevirtual

deep copy of all contained movers.

Reimplemented from protocols::moves::Mover.

References SequenceMover().

MoverOP protocols::moves::SequenceMover::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.

References SequenceMover().

std::string protocols::moves::SequenceMover::get_name ( ) const

overridevirtual

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

Implements protocols::moves::Mover.

void protocols::moves::SequenceMover::use_mover_status ( bool const flag )

inline

MoverStatus of the mover will be evaluated after each mover.

References use_mover_status_.

bool protocols::moves::SequenceMover::use_mover_status ( )

inline