a RemodelConstraintGenerator that creates AmbiguousMultiConstraints for all positions More...

#include <ResidueVicinityRCG.hh>

Inheritance diagram for protocols::forge::remodel::ResidueVicinityRCG:

Collaboration diagram for protocols::forge::remodel::ResidueVicinityRCG:

Public Member Functions
	ResidueVicinityRCG ()

	ResidueVicinityRCG (ResidueVicinityRCG const &rval)
	copy construtor More...

	ResidueVicinityRCG (core::Size lstart, core::Size lstop, utility::vector1< ResidueVicinityInfoOP > const &rv_infos)

virtual	~ResidueVicinityRCG ()

virtual void	generate_remodel_constraints (core::pose::Pose const &pose)
	for every ResidueVicinityInfo (RVI) that this generator has, an AmbiguousConstraint between the More...

virtual void	parse_my_tag (TagPtr const tag, protocols::moves::DataMap &data, protocols::filters::Filters_map const &filters, protocols::moves::Movers_map const &movers, core::pose::Pose const &pose)
	This is called if this mover is instantiated from XML. More...

virtual std::string	get_name () const
	Each derived class must specify its name. The class name. More...

virtual protocols::moves::MoverOP	fresh_instance () const
	this is like clone(), except it generates a new mover object freshly created with the default ctor. This function should be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage). More...

virtual protocols::moves::MoverOP	clone () const
	clone has to be overridden only if clone invocation is expected. More...

void	clear_rv_infos ()

void	add_rv_info (ResidueVicinityInfoOP rv_info)

void	lstart (core::Size const lstart)

void	lstop (core::Size const lstop)

void	set_rv_infos (utility::vector1< ResidueVicinityInfoOP > const &rv_infos)

Public Member Functions inherited from protocols::forge::remodel::RemodelConstraintGenerator
virtual	~RemodelConstraintGenerator ()
	Automatically generated virtual destructor for class deriving directly from ReferenceCount. More...

virtual void	apply (core::pose::Pose &pose)
	generates constraints and adds them to the pose More...

	RemodelConstraintGenerator ()

	RemodelConstraintGenerator (RemodelConstraintGenerator const &rval)

void	add_remodel_constraints_to_pose (core::pose::Pose &pose)

void	remove_remodel_constraints_from_pose (core::pose::Pose &pose) const

virtual void	init (core::pose::Pose const &)
	Pose-specific setup routines go here. More...

VarLengthBuildAP	vlb () const

void	set_vlb (VarLengthBuildAP vlb)

std::string	id () const

void	set_id (std::string const &id)

void	set_seqmap (core::id::SequenceMappingCOP seqmap)

core::id::SequenceMappingCOP	seqmap () const

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

virtual	~Mover ()

virtual MoverSP	create ()

virtual void	apply (core::io::serialization::PipeMap &pmap)

virtual void	parse_state (SerializableState const &state)

virtual void	parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks, MoverCacheSP cache)

virtual void	save_state (SerializableState &state)

	Mover (std::string const &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

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

void	set_current_tag (std::string const &new_tag)

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

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
	this function informs 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
	this function informs 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

Protected Member Functions
void	generate_remodel_constraints_for_respair (core::pose::Pose const &pose, core::Size const loopres, ResidueVicinityInfo const &rv_info, utility::vector1< core::scoring::constraints::ConstraintCOP > &csts)

Protected Member Functions inherited from protocols::forge::remodel::RemodelConstraintGenerator
void	add_constraint (core::scoring::constraints::ConstraintCOP cst)

void	add_constraints (core::scoring::constraints::ConstraintCOPs csts)

void	clear_constraints ()

void	clear_stored_constraints ()

void	store_constraints ()

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 Attributes
core::Size	lstart_

core::Size	lstop_

utility::vector1 < ResidueVicinityInfoOP >	rv_infos_

Additional Inherited Members
Public Types inherited from protocols::forge::remodel::RemodelConstraintGenerator
typedef protocols::forge::components::VarLengthBuildAP	VarLengthBuildAP

Static Public Member Functions inherited from protocols::forge::remodel::RemodelConstraintGenerator
static core::scoring::constraints::ConstraintCOPs const	lookup_stored_constraints (std::string const &id)

Detailed Description

a RemodelConstraintGenerator that creates AmbiguousMultiConstraints for all positions

in the remodeled loop to the desired positions, such that during remodeling, the remodeled region will be driven towards the vicinity of these residues

Constructor & Destructor Documentation

protocols::forge::remodel::ResidueVicinityRCG::ResidueVicinityRCG ( )

Referenced by clone(), and fresh_instance().

protocols::forge::remodel::ResidueVicinityRCG::ResidueVicinityRCG ( ResidueVicinityRCG const & rval)

copy construtor

protocols::forge::remodel::ResidueVicinityRCG::ResidueVicinityRCG	(	core::Size	lstart,
		core::Size	lstop,
		utility::vector1< ResidueVicinityInfoOP > const &	rv_infos
	)

protocols::forge::remodel::ResidueVicinityRCG::~ResidueVicinityRCG ( )

virtual

Member Function Documentation

void protocols::forge::remodel::ResidueVicinityRCG::add_rv_info ( ResidueVicinityInfoOP rv_info)

inline

References rv_infos_.

void protocols::forge::remodel::ResidueVicinityRCG::clear_rv_infos ( )

inline

References rv_infos_.

protocols::moves::MoverOP protocols::forge::remodel::ResidueVicinityRCG::clone ( ) const

virtual

clone has to be overridden only if clone invocation is expected.

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.

References ResidueVicinityRCG().

protocols::moves::MoverOP protocols::forge::remodel::ResidueVicinityRCG::fresh_instance ( ) const

virtual

this is like clone(), except it generates a new mover object freshly created with the default ctor. This function should be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage).

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 ResidueVicinityRCG().

void protocols::forge::remodel::ResidueVicinityRCG::generate_remodel_constraints ( core::pose::Pose const & pose)

virtual

for every ResidueVicinityInfo (RVI) that this generator has, an AmbiguousConstraint between the

neighbor atoms of all residues in the remodel region and the RVI are generated.

Implements protocols::forge::remodel::RemodelConstraintGenerator.

References protocols::forge::remodel::RemodelConstraintGenerator::add_constraint(), protocols::forge::remodel::RemodelConstraintGenerator::clear_constraints(), generate_remodel_constraints_for_respair(), lstart_, lstop_, rv_infos_, protocols::forge::remodel::RemodelConstraintGenerator::seqmap(), and tr().

void protocols::forge::remodel::ResidueVicinityRCG::generate_remodel_constraints_for_respair	(	core::pose::Pose const &	pose,
		core::Size const	loopres,
		ResidueVicinityInfo const &	rv_info,
		utility::vector1< core::scoring::constraints::ConstraintCOP > &	csts
	)

protected

Referenced by generate_remodel_constraints().

std::string protocols::forge::remodel::ResidueVicinityRCG::get_name ( ) const

virtual

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

Implements protocols::moves::Mover.

References protocols::forge::remodel::ResidueVicinityCstGeneratorCreator::mover_name().

void protocols::forge::remodel::ResidueVicinityRCG::lstart ( core::Size const lstart)

References lstart_.

Referenced by parse_my_tag().

void protocols::forge::remodel::ResidueVicinityRCG::lstop ( core::Size const lstop)

References lstop_.

Referenced by parse_my_tag().

void protocols::forge::remodel::ResidueVicinityRCG::parse_my_tag	(	TagPtr const	tag,
		protocols::moves::DataMap &	,
		protocols::filters::Filters_map const &	,
		protocols::moves::Movers_map const &	,
		core::pose::Pose const &
	)