#include <MultiplePoseMover.hh>

Inheritance diagram for protocols::rosetta_scripts::MultiplePoseMover:

Public Member Functions
	MultiplePoseMover ()
	No-argument constructor. More...

	~MultiplePoseMover () override=default
	Virtual destructor. 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...

void	apply (core::pose::Pose &pose) override
	Process input pose. More...

core::pose::PoseOP	get_additional_output () override
	Mechanism by which a mover may return multiple output poses from a single input pose. More...

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
	Parse settings in tag. More...

void	set_previous_mover (protocols::moves::MoverOP const m)
	Used by RosettaScripts to set the previous mover to pull poses from. More...

void	set_rosetta_scripts_tag (utility::tag::TagCOP tag)
	sets rosettascripts tag 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::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...

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

Protected Member Functions
virtual bool	process_pose (core::pose::Pose &, utility::vector1< core::pose::PoseOP > &)
	Process a single input pose by the RosettaScripts 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...

Private Member Functions
bool	fill_input_cache ()

core::pose::PoseOP	generate_pose ()

std::deque< core::pose::PoseOP >	select_poses (std::deque< core::pose::PoseOP > &poses)
	Select poses from set using specified selectors. More...

std::deque< core::pose::PoseOP >	process_poses (std::deque< core::pose::PoseOP > &poses)
	Rub sub-protocol on set of poses. More...

MultiplePoseMover &	operator= (const MultiplePoseMover &)=delete
	in its [previous] form MultiplePoseMover [was] not assignable due to presense of protocols::filters::Filters_map defined as std::map< const std::string, ...> but compiler tries to generate assigment operator anyway I don't know if that has changed now that we removed the Filters_map More...

Private Attributes
bool	cached_

core::Size	max_input_poses_

core::Size	max_output_poses_

utility::tag::TagCOP	rosetta_scripts_tag_

utility::tag::TagCOP	selector_tag_

protocols::moves::MoverOP	previous_mover_

utility::vector1< PoseSelectorOP >	selectors_

std::deque< core::pose::PoseOP >	pose_input_cache_

std::deque< core::pose::PoseOP >	pose_output_cache_

core::Size	poses_input_

core::Size	poses_output_

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

Constructor & Destructor Documentation

protocols::rosetta_scripts::MultiplePoseMover::MultiplePoseMover ( )

No-argument constructor.

protocols::rosetta_scripts::MultiplePoseMover::~MultiplePoseMover ( )

overridedefault

Virtual destructor.

Member Function Documentation

void protocols::rosetta_scripts::MultiplePoseMover::apply ( core::pose::Pose & pose )

overridevirtual

Process input pose.

Implements protocols::moves::Mover.

References cached_, core::pose::Pose::clone(), protocols::moves::FAIL_RETRY, fill_input_cache(), generate_pose(), protocols::moves::MS_SUCCESS, pose_input_cache_, pose_output_cache_, poses_input_, poses_output_, protocols::moves::Mover::set_last_move_status(), and protocols::rosetta_scripts::TR().

Referenced by protocols::match::MatcherMover::apply().

protocols::moves::MoverOP protocols::rosetta_scripts::MultiplePoseMover::clone ( ) const

inlineoverridevirtual

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.

bool protocols::rosetta_scripts::MultiplePoseMover::fill_input_cache ( )

private

References max_input_poses_, pose_input_cache_, poses_input_, previous_mover_, and protocols::rosetta_scripts::TR().

Referenced by apply(), and generate_pose().

protocols::moves::MoverOP protocols::rosetta_scripts::MultiplePoseMover::fresh_instance ( ) const

inlineoverridevirtual

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.

core::pose::PoseOP protocols::rosetta_scripts::MultiplePoseMover::generate_pose ( )

private

References cached_, fill_input_cache(), max_output_poses_, pose_input_cache_, pose_output_cache_, poses_output_, process_poses(), and select_poses().

Referenced by apply(), and get_additional_output().

core::pose::PoseOP protocols::rosetta_scripts::MultiplePoseMover::get_additional_output ( )

overridevirtual

Mechanism by which a mover may return multiple output poses from a single input pose.

fpd

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

Mechanism by which a mover may return multiple output poses from a single input pose. After apply is called, calling this function will return subsequent output poses. NULL is returned if the mover has no more output poses remaining. The base class implementation returns NULL always; multi-output movers must override this. RosettaScripts uses this interface to produce a 'branched' protocol.

Reimplemented from protocols::moves::Mover.

References generate_pose().

std::string protocols::rosetta_scripts::MultiplePoseMover::get_name ( ) const

overridevirtual

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

Implements protocols::moves::Mover.

References mover_name().

std::string protocols::rosetta_scripts::MultiplePoseMover::mover_name ( )

static

Referenced by get_name(), protocols::rosetta_scripts::MultiplePoseMoverCreator::keyname(), and provide_xml_schema().

MultiplePoseMover& protocols::rosetta_scripts::MultiplePoseMover::operator= ( const MultiplePoseMover & )

privatedelete

in its [previous] form MultiplePoseMover [was] not assignable due to presense of protocols::filters::Filters_map defined as std::map< const std::string, ...> but compiler tries to generate assigment operator anyway I don't know if that has changed now that we removed the Filters_map

void protocols::rosetta_scripts::MultiplePoseMover::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	data
	)

overridevirtual

Parse settings in tag.

Reimplemented from protocols::moves::Mover.

References cached_, max_input_poses_, max_output_poses_, protocols::rosetta_scripts::PSF_NEED_FULL_POSE_SET, protocols::rosetta_scripts::PSF_NONE, protocols::rosetta_scripts::recursively_access_all_attributes(), rosetta_scripts_tag_, selectors_, set_rosetta_scripts_tag(), and protocols::rosetta_scripts::TR().

bool protocols::rosetta_scripts::MultiplePoseMover::process_pose	(	core::pose::Pose &	pose,
		utility::vector1< core::pose::PoseOP > &	additional_poses
	)

protectedvirtual

Process a single input pose by the RosettaScripts mover.

Reimplemented in protocols::denovo_design::DisulfidizeMover, and protocols::match::MatcherMover.

References protocols::moves::MS_SUCCESS, protocols::rosetta_scripts::RosettaScriptsParser::parse_protocol_tag(), rosetta_scripts_tag_, and protocols::rosetta_scripts::TR().

Referenced by process_poses().

std::deque< core::pose::PoseOP > protocols::rosetta_scripts::MultiplePoseMover::process_poses ( std::deque< core::pose::PoseOP > & poses )

private

Rub sub-protocol on set of poses.

References process_pose(), and protocols::rosetta_scripts::TR().

Referenced by generate_pose().

void protocols::rosetta_scripts::MultiplePoseMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

References protocols::moves::complex_type_name_for_mover(), mover_name(), protocols::rosetta_scripts::mpm_mangler(), protocols::rosetta_scripts::PoseSelectorFactory::pose_selector_group_name(), protocols::rosetta_scripts::RosettaScriptsParser::rosetta_scripts_complex_type_naming_func(), protocols::rosetta_scripts::RosettaScriptsParser::rosetta_scripts_element_name(), and protocols::rosetta_scripts::RosettaScriptsParser::write_ROSETTASCRIPTS_complex_type().

Referenced by protocols::rosetta_scripts::MultiplePoseMoverCreator::provide_xml_schema().

std::deque< core::pose::PoseOP > protocols::rosetta_scripts::MultiplePoseMover::select_poses ( std::deque< core::pose::PoseOP > & poses )

private

Select poses from set using specified selectors.

References selectors_, and protocols::rosetta_scripts::TR().

Referenced by generate_pose().

void protocols::rosetta_scripts::MultiplePoseMover::set_previous_mover ( protocols::moves::MoverOP const m )

Used by RosettaScripts to set the previous mover to pull poses from.

References previous_mover_.

void protocols::rosetta_scripts::MultiplePoseMover::set_rosetta_scripts_tag ( utility::tag::TagCOP tag )

sets rosettascripts tag

References rosetta_scripts_tag_.

Referenced by protocols::denovo_design::DisulfidizeMover::DisulfidizeMover(), and parse_my_tag().

Member Data Documentation

bool protocols::rosetta_scripts::MultiplePoseMover::cached_

private

Referenced by apply(), generate_pose(), and parse_my_tag().

core::Size protocols::rosetta_scripts::MultiplePoseMover::max_input_poses_

private

Referenced by fill_input_cache(), and parse_my_tag().

core::Size protocols::rosetta_scripts::MultiplePoseMover::max_output_poses_

private

Referenced by generate_pose(), and parse_my_tag().

std::deque< core::pose::PoseOP > protocols::rosetta_scripts::MultiplePoseMover::pose_input_cache_

private

Referenced by apply(), fill_input_cache(), and generate_pose().

std::deque< core::pose::PoseOP > protocols::rosetta_scripts::MultiplePoseMover::pose_output_cache_

private

Referenced by apply(), and generate_pose().

core::Size protocols::rosetta_scripts::MultiplePoseMover::poses_input_

private

Referenced by apply(), and fill_input_cache().

core::Size protocols::rosetta_scripts::MultiplePoseMover::poses_output_

private

Referenced by apply(), and generate_pose().

protocols::moves::MoverOP protocols::rosetta_scripts::MultiplePoseMover::previous_mover_

private

Referenced by fill_input_cache(), and set_previous_mover().

utility::tag::TagCOP protocols::rosetta_scripts::MultiplePoseMover::rosetta_scripts_tag_

private

Referenced by parse_my_tag(), process_pose(), and set_rosetta_scripts_tag().

utility::tag::TagCOP protocols::rosetta_scripts::MultiplePoseMover::selector_tag_

private

utility::vector1< PoseSelectorOP > protocols::rosetta_scripts::MultiplePoseMover::selectors_

private

Referenced by parse_my_tag(), and select_poses().

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

src/protocols/rosetta_scripts/MultiplePoseMover.hh
src/protocols/rosetta_scripts/MultiplePoseMover.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation