#include <SpinAroundPartnerMover.hh>

Inheritance diagram for protocols::membrane::SpinAroundPartnerMover:

[legend]

Public Member Functions
	SpinAroundPartnerMover ()
	Constructors ///. More...

	SpinAroundPartnerMover (core::Size jump_num)
	Custom Constructor. More...

	SpinAroundPartnerMover (core::Size jump_num, core::Size range)
	Custom constructor. More...

	SpinAroundPartnerMover (SpinAroundPartnerMover const &src)
	Copy Constructor. More...

SpinAroundPartnerMover &	operator= (SpinAroundPartnerMover const &src)
	Assignment Operator. More...

	~SpinAroundPartnerMover () override
	Destructor. More...

protocols::moves::MoverOP	clone () const override
	Rosetta Scripts Methods ///. More...

protocols::moves::MoverOP	fresh_instance () const override
	Create a Fresh Instance of this Mover. More...

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
	Pase Rosetta Scripts Options for this Mover. More...

std::string	get_name () const override
	Mover Methods ///. More...

core::Size	get_jump () const
	Get the jump number for this Mover. More...

bool	get_rand_range () const
	Get the random range for this Mover. More...

core::Size	get_range () const
	Get the sampling range for this Mover. More...

core::Real	get_x () const
	Get the x position for this Mover. More...

core::Real	get_y () const
	Get the y position for this Mover. More...

void	apply (core::pose::Pose &pose) override
	Flip the downstream partner in the membrane. More...

void	random_range (bool yesno)
	Set random range. More...

void	set_x (core::Real x)
	Set x position. More...

void	set_y (core::Real y)
	Set y position. 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 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 void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
	Provide xml schema for RosettaScripts compatibility. More...

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 Member Functions
void	register_options ()
	Setup Methods ///. More...

void	set_defaults ()
	Set default values. More...

Private Attributes
core::Size	jump_
	Jump number. More...

bool	rand_range_

core::Size	range_
	Sampling range. More...

core::Real	x_
	Set x and y position. More...

core::Real	y_

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

Constructor & Destructor Documentation

◆ SpinAroundPartnerMover() [1/4]

protocols::membrane::SpinAroundPartnerMover::SpinAroundPartnerMover ( )

Constructors ///.

Default Constructor

Defaults: jump = 1, sampling range = 100 Sampling range of 100 means that both x and y are sampled from -100 to +100

References register_options(), and set_defaults().

Referenced by operator=().

◆ SpinAroundPartnerMover() [2/4]

protocols::membrane::SpinAroundPartnerMover::SpinAroundPartnerMover ( core::Size jump_num )

Custom Constructor.

User can specify jump number

References jump_, register_options(), and set_defaults().

◆ SpinAroundPartnerMover() [3/4]

protocols::membrane::SpinAroundPartnerMover::SpinAroundPartnerMover	(	core::Size	jump_num,
		core::Size	range
	)

Custom constructor.

User can specify jump number and sampling range

References jump_, rand_range_, protocols::sic_dock::range(), range_, register_options(), and set_defaults().

◆ SpinAroundPartnerMover() [4/4]

protocols::membrane::SpinAroundPartnerMover::SpinAroundPartnerMover ( SpinAroundPartnerMover const & src )

default

Copy Constructor.

Create a deep copy of this mover

◆ ~SpinAroundPartnerMover()

protocols::membrane::SpinAroundPartnerMover::~SpinAroundPartnerMover ( )

overridedefault

Destructor.

Member Function Documentation

◆ apply()

void protocols::membrane::SpinAroundPartnerMover::apply ( core::pose::Pose & pose )

overridevirtual

Flip the downstream partner in the membrane.

Implements protocols::moves::Mover.

References protocols::membrane::compute_structure_based_embedding(), core::pose::Pose::fold_tree(), protocols::membrane::is_membrane_fixed(), jump_, core::pose::Pose::membrane_info(), rand_range_, range_, core::kinematics::FoldTree::show(), protocols::membrane::split_topology_by_jump_noshift(), protocols::TR(), trans(), x_, and y_.

◆ clone()

protocols::moves::MoverOP protocols::membrane::SpinAroundPartnerMover::clone ( ) const

overridevirtual

Rosetta Scripts Methods ///.

Create a Clone of this mover

Reimplemented from protocols::moves::Mover.

◆ fresh_instance()

protocols::moves::MoverOP protocols::membrane::SpinAroundPartnerMover::fresh_instance ( ) const

overridevirtual

Create a Fresh Instance of this Mover.

Reimplemented from protocols::moves::Mover.

◆ get_jump()

core::Size protocols::membrane::SpinAroundPartnerMover::get_jump ( ) const

Get the jump number for this Mover.

References jump_.

◆ get_name()

std::string protocols::membrane::SpinAroundPartnerMover::get_name ( ) const

overridevirtual

Mover Methods ///.

Get the name of this Mover (SpinAroundPartnerMover)

Implements protocols::moves::Mover.

◆ get_rand_range()

bool protocols::membrane::SpinAroundPartnerMover::get_rand_range ( ) const

Get the random range for this Mover.

References rand_range_.

◆ get_range()

core::Size protocols::membrane::SpinAroundPartnerMover::get_range ( ) const

Get the sampling range for this Mover.

References range_.

◆ get_x()

core::Real protocols::membrane::SpinAroundPartnerMover::get_x ( ) const

Get the x position for this Mover.

References x_.

◆ get_y()

core::Real protocols::membrane::SpinAroundPartnerMover::get_y ( ) const

Get the y position for this Mover.

References y_.

◆ operator=()

SpinAroundPartnerMover & protocols::membrane::SpinAroundPartnerMover::operator= ( SpinAroundPartnerMover const & src )

Assignment Operator.

References SpinAroundPartnerMover().

◆ parse_my_tag()

void protocols::membrane::SpinAroundPartnerMover::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &
	)

overridevirtual

Pase Rosetta Scripts Options for this Mover.

Reimplemented from protocols::moves::Mover.

References jump_, rand_range_, range_, x_, and y_.

◆ provide_xml_schema()

void protocols::membrane::SpinAroundPartnerMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

Provide xml schema for RosettaScripts compatibility.

References protocols::membrane::SpinAroundPartnerMoverCreator::mover_name(), and protocols::moves::xsd_type_definition_w_attributes().

◆ random_range()

void protocols::membrane::SpinAroundPartnerMover::random_range ( bool yesno )

Set random range.

References rand_range_.

◆ register_options()

void protocols::membrane::SpinAroundPartnerMover::register_options ( )

private

Setup Methods ///.

Register Options from Command Line

Referenced by SpinAroundPartnerMover().

◆ set_defaults()

void protocols::membrane::SpinAroundPartnerMover::set_defaults ( )

private

Set default values.

References jump_, rand_range_, range_, x_, and y_.

Referenced by SpinAroundPartnerMover().

◆ set_x()

void protocols::membrane::SpinAroundPartnerMover::set_x ( core::Real x )

Set x position.

References rand_range_, and x_.

◆ set_y()

void protocols::membrane::SpinAroundPartnerMover::set_y ( core::Real y )

Set y position.

References rand_range_, and y_.

Member Data Documentation

◆ jump_

core::Size protocols::membrane::SpinAroundPartnerMover::jump_

private

Jump number.

Referenced by apply(), get_jump(), parse_my_tag(), set_defaults(), and SpinAroundPartnerMover().

◆ rand_range_

bool protocols::membrane::SpinAroundPartnerMover::rand_range_

private

Referenced by apply(), get_rand_range(), parse_my_tag(), random_range(), set_defaults(), set_x(), set_y(), and SpinAroundPartnerMover().

◆ range_

core::Size protocols::membrane::SpinAroundPartnerMover::range_

private

Sampling range.

Referenced by apply(), get_range(), parse_my_tag(), set_defaults(), and SpinAroundPartnerMover().

◆ x_

core::Real protocols::membrane::SpinAroundPartnerMover::x_

private

Set x and y position.

Referenced by apply(), get_x(), parse_my_tag(), set_defaults(), and set_x().

◆ y_

core::Real protocols::membrane::SpinAroundPartnerMover::y_

private

Referenced by apply(), get_y(), parse_my_tag(), set_defaults(), and set_y().

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

src/protocols/membrane/SpinAroundPartnerMover.hh
src/protocols/membrane/SpinAroundPartnerMover.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ SpinAroundPartnerMover() [1/4]

◆ SpinAroundPartnerMover() [2/4]

◆ SpinAroundPartnerMover() [3/4]

◆ SpinAroundPartnerMover() [4/4]

◆ ~SpinAroundPartnerMover()

Member Function Documentation

◆ apply()

◆ clone()

◆ fresh_instance()

◆ get_jump()

◆ get_name()

◆ get_rand_range()

◆ get_range()

◆ get_x()

◆ get_y()

◆ operator=()

◆ parse_my_tag()

◆ provide_xml_schema()

◆ random_range()

◆ register_options()

◆ set_defaults()

◆ set_x()

◆ set_y()

Member Data Documentation

◆ jump_

◆ rand_range_

◆ range_

◆ x_

◆ y_