A mover to store current residue indices in a map that will be updated as residues are added or deleted, permitting residue indices from the current state to be used to set up movers applied in the future. More...

#include <StorePoseSnapshot.hh>

Inheritance diagram for protocols::simple_moves::StorePoseSnapshot:

[legend]

Public Member Functions
	StorePoseSnapshot ()
	Default constructor. More...

	StorePoseSnapshot (StorePoseSnapshot const &src)
	Copy constructor. More...

	~StorePoseSnapshot () override
	Destructor. More...

void	apply (core::pose::Pose &pose) override
	Apply function – actually apply this mover to the pose, modifying the pose. More...

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

protocols::moves::MoverOP	fresh_instance () const override
	Create a new instance of this mover, initialized to default settings. More...

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
	Parse RosettaScripts XML to set up this mover. More...

void	set_reference_pose_name (std::string const &name_in)
	Set the name of the reference pose object that will be created and stored in the pose. More...

std::string	reference_pose_name () const
	Return the name of the reference pose object that will be created and stored in the 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::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 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 Types
typedef protocols::moves::Mover	parent

Private Attributes
std::string	reference_pose_name_
	The name of the ReferencePose object that will be created and stored in the pose. More...

bool	overwrite_current_refpose_

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

A mover to store current residue indices in a map that will be updated as residues are added or deleted, permitting residue indices from the current state to be used to set up movers applied in the future.

Member Typedef Documentation

typedef protocols::moves::Mover protocols::simple_moves::StorePoseSnapshot::parent

private

Constructor & Destructor Documentation

protocols::simple_moves::StorePoseSnapshot::StorePoseSnapshot ( )

Default constructor.

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

default

Copy constructor.

protocols::simple_moves::StorePoseSnapshot::~StorePoseSnapshot ( )

overridedefault

Destructor.

Member Function Documentation

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

overridevirtual

Apply function – actually apply this mover to the pose, modifying the pose.

Implements protocols::moves::Mover.

References overwrite_current_refpose_, core::pose::Pose::reference_pose_from_current(), reference_pose_name(), and protocols::simple_moves::TR().

protocols::moves::MoverOP protocols::simple_moves::StorePoseSnapshot::clone ( ) const

inlineoverridevirtual

Get the mover name.

Makea copy of this mover, and return an owning pointer to the copy.

Reimplemented from protocols::moves::Mover.

protocols::moves::MoverOP protocols::simple_moves::StorePoseSnapshot::fresh_instance ( ) const

inlineoverridevirtual

Create a new instance of this mover, initialized to default settings.

Reimplemented from protocols::moves::Mover.

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

overridevirtual

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

Implements protocols::moves::Mover.

References mover_name().

std::string protocols::simple_moves::StorePoseSnapshot::mover_name ( )

static

Referenced by get_name(), protocols::simple_moves::StorePoseSnapshotCreator::keyname(), and provide_xml_schema().

void protocols::simple_moves::StorePoseSnapshot::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &
	)

overridevirtual

Parse RosettaScripts XML to set up this mover.

Get the mover name.

This is called at script initialization, long before the apply() function is called.

Parse RosettaScripts XML to set up this mover.

This is called at script initialization, long before the apply() function is called.

Reimplemented from protocols::moves::Mover.

References overwrite_current_refpose_, reference_pose_name(), set_reference_pose_name(), and protocols::simple_moves::TR().

void protocols::simple_moves::StorePoseSnapshot::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

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

Referenced by protocols::simple_moves::StorePoseSnapshotCreator::provide_xml_schema().

std::string protocols::simple_moves::StorePoseSnapshot::reference_pose_name ( ) const

Return the name of the reference pose object that will be created and stored in the pose.

References reference_pose_name_.

Referenced by apply(), and parse_my_tag().

void protocols::simple_moves::StorePoseSnapshot::set_reference_pose_name ( std::string const & name_in )

Set the name of the reference pose object that will be created and stored in the pose.

References reference_pose_name_.

Referenced by parse_my_tag().

Member Data Documentation

bool protocols::simple_moves::StorePoseSnapshot::overwrite_current_refpose_

private

Referenced by apply(), and parse_my_tag().

std::string protocols::simple_moves::StorePoseSnapshot::reference_pose_name_

private

The name of the ReferencePose object that will be created and stored in the pose.

Referenced by reference_pose_name(), and set_reference_pose_name().

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

src/protocols/simple_moves/StorePoseSnapshot.hh
src/protocols/simple_moves/StorePoseSnapshot.cc

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation