#include <ClientMover.hh>

Inheritance diagram for protocols::environment::ClientMover:

Public Member Functions
	ClientMover ()

	ClientMover (ClientMover const &)

	~ClientMover () override

virtual claims::EnvClaims	yield_claims (core::pose::Pose const &, basic::datacache::WriteableCacheableMapOP)=0
	Returns a list of claims for this mover. More...

virtual void	initialize (Pose &conf)
	this method is called by the broking system in response to a successful initialization claim by this mover. The passport will prevent any unauthorized changes. More...

virtual void	yield_submovers (std::set< ClientMoverOP > &) const
	this method is used to make sure any movers contained in this mover (that want to make claims) also get registered with the environment. 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	apply (Pose &)=0
	Main Method. 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 MoverOP	clone () const
	Return a clone of the Mover object. 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...

virtual MoverOP	fresh_instance () const
	Generates a new Mover object freshly created with the default ctor. 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...

virtual std::string	get_name () const =0
	Each derived class must specify its name. The class name. 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...

Protected Member Functions
void	sandboxed_copy (core::pose::Pose const &sandbox_pose, core::pose::Pose &true_pose) const
	convience method that copies all changes from an unprotected pose to a protected pose. More...

virtual void	passport_updated ()
	hook that is called each time the passport status is updated (presumably because there's a new subenvironment, or the sub- environment has expired). More...

virtual void	broking_finished (EnvClaimBroker::BrokerResult const &)
	hook that provides information about the final result of broking at the very end, though this BrokerResult construct. More...

EnvironmentCAP	active_environment () const
	return a pointer the active environment More...

core::environment::DofPassportCOP	passport () const
	read-only access to the top passport in the passport stack. More...

bool	has_passport () const

bool	state_check (std::string const &method_name, bool test) const
	convienence method for failing a state-set call after brokering. 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 Types
typedef core::environment::DofPassportCOP	DofPassportCOP

typedef std::stack< std::pair < EnvironmentCAP, DofPassportCOP > >	PassportStack

Private Member Functions
void	push_passport (EnvironmentCAP, DofPassportCOP)
	called by environments to push a new passport on the passport stack More...

void	pop_passport (Environment const &)

Private Attributes
PassportStack	passports_

Friends
class	Environment

class	EnvClaimBroker

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

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

Member Typedef Documentation

typedef core::environment::DofPassportCOP protocols::environment::ClientMover::DofPassportCOP

private

typedef std::stack< std::pair< EnvironmentCAP, DofPassportCOP > > protocols::environment::ClientMover::PassportStack

private

Constructor & Destructor Documentation

protocols::environment::ClientMover::ClientMover ( )

Referenced by protocols::loops::loop_mover::LoopCM::yield_claims().

protocols::environment::ClientMover::ClientMover ( ClientMover const & )

default

protocols::environment::ClientMover::~ClientMover ( )

overridedefault

Member Function Documentation

EnvironmentCAP protocols::environment::ClientMover::active_environment ( ) const

protected

return a pointer the active environment

References passports_.

Referenced by protocols::environment::CoMTrackerCM::passport_updated(), and protocols::rigid::UniformRigidBodyCM::passport_updated().

virtual void protocols::environment::ClientMover::broking_finished ( EnvClaimBroker::BrokerResult const & )

inlineprotectedvirtual

hook that provides information about the final result of broking at the very end, though this BrokerResult construct.

Reimplemented in protocols::abinitio::abscript::AbscriptLoopCloserCM.

bool protocols::environment::ClientMover::has_passport ( ) const

inlineprotected

References passports_.

Referenced by protocols::loops::loop_mover::LoopCM::passport_updated(), protocols::abinitio::abscript::AbscriptLoopCloserCM::passport_updated(), protocols::environment::CoMTrackerCM::passport_updated(), protocols::environment::ScriptCM::passport_updated(), protocols::rigid::UniformRigidBodyCM::passport_updated(), protocols::abinitio::abscript::RigidChunkCM::passport_updated(), and state_check().

void protocols::environment::ClientMover::initialize ( Pose & conf )

virtual

this method is called by the broking system in response to a successful initialization claim by this mover. The passport will prevent any unauthorized changes.

Reimplemented in protocols::abinitio::abscript::AbscriptMover, protocols::abinitio::abscript::RigidChunkCM, protocols::rigid::UniformRigidBodyCM, protocols::environment::CoMTrackerCM, protocols::abinitio::abscript::FragmentCM, protocols::loops::loop_mover::LoopCM, and protocols::environment::ScriptCM.

References protocols::moves::Mover::get_name().

core::environment::DofPassportCOP protocols::environment::ClientMover::passport ( ) const

protected

read-only access to the top passport in the passport stack.

References protocols::moves::Mover::get_name(), and passports_.

Referenced by protocols::abinitio::abscript::StructPerturberCM::apply(), protocols::environment::ScriptCM::apply(), protocols::abinitio::abscript::AbscriptLoopCloserCM::apply(), protocols::rigid::UniformRigidBodyCM::apply(), protocols::environment::ScriptCM::initialize(), protocols::rigid::UniformRigidBodyCM::initialize(), protocols::abinitio::abscript::RigidChunkCM::initialize(), protocols::loops::loop_mover::LoopCM::passport_updated(), protocols::abinitio::abscript::AbscriptLoopCloserCM::passport_updated(), protocols::environment::ScriptCM::passport_updated(), and sandboxed_copy().

virtual void protocols::environment::ClientMover::passport_updated ( )

inlineprotectedvirtual

hook that is called each time the passport status is updated (presumably because there's a new subenvironment, or the sub- environment has expired).

Reimplemented in protocols::abinitio::abscript::RigidChunkCM, protocols::rigid::UniformRigidBodyCM, protocols::environment::CoMTrackerCM, protocols::environment::ScriptCM, protocols::abinitio::abscript::AbscriptLoopCloserCM, protocols::abinitio::abscript::FragmentCM, and protocols::loops::loop_mover::LoopCM.

Referenced by pop_passport().

void protocols::environment::ClientMover::pop_passport ( Environment const & canceling_env )

private

References protocols::moves::Mover::get_name(), core::environment::EnvCore::id(), core::environment::EnvCore::name(), passport_updated(), and passports_.

void protocols::environment::ClientMover::push_passport	(	EnvironmentCAP	env_ap,
		DofPassportCOP	pass
	)

private

called by environments to push a new passport on the passport stack

called by environments when the environment expires to pop the environment.

References core::scoring::env, protocols::moves::Mover::get_name(), protocols::moves::Mover::get_self_ptr(), and passports_.

void protocols::environment::ClientMover::sandboxed_copy	(	core::pose::Pose const &	sandbox_pose,
		core::pose::Pose &	true_pose
	)		const

protected

convience method that copies all changes from an unprotected pose to a protected pose.

Referenced by protocols::loops::loop_mover::LoopCM::apply().

bool protocols::environment::ClientMover::state_check	(	std::string const &	method_name,
		bool	test
	)		const

protected

convienence method for failing a state-set call after brokering.

once brokering has been completed, most state-set calls (e.g. set_mover or the like) don't make sense anymore. This method is used to convienently throw an explanatory exception.

References protocols::moves::Mover::get_name(), and has_passport().

Referenced by protocols::abinitio::abscript::FragmentCM::set_selector(), protocols::abinitio::abscript::RigidChunkCM::sim_selector(), and protocols::abinitio::abscript::RigidChunkCM::templ_selector().

virtual claims::EnvClaims protocols::environment::ClientMover::yield_claims	(	core::pose::Pose const &	,
		basic::datacache::WriteableCacheableMapOP
	)

pure virtual

Returns a list of claims for this mover.

The pose passed as an argument is used for reference informational purposes only (for example, you want to know the sequence) or access the pose cache. Any changes to the conformation will get overwritten!

Implemented in protocols::abinitio::abscript::ConstraintPreparer, protocols::abinitio::abscript::AbscriptMover, protocols::rigid::UniformRigidBodyCM, protocols::environment::CoMTrackerCM, protocols::abinitio::abscript::AbscriptLoopCloserCM, protocols::abinitio::abscript::FragmentCM, protocols::abinitio::abscript::RigidChunkCM, protocols::loops::loop_mover::LoopCM, protocols::abinitio::abscript::StructPerturberCM, protocols::abinitio::abscript::FragmentJumpCM, and protocols::environment::ScriptCM.