instruction to create an n-side extension More...

#include <GrowLeft.hh>

Inheritance diagram for protocols::forge::build::GrowLeft:

Public Types
typedef Super::Size	Size

typedef Super::ResidueTypeSetCAP	ResidueTypeSetCAP

typedef Super::LengthEvent	LengthEvent

typedef Super::MoveMap	MoveMap

typedef Super::Pose	Pose

typedef Super::Positions	Positions

typedef Super::String	String

Public Types inherited from protocols::forge::build::BuildInstruction
typedef core::Size	Size

typedef core::Real	Real

typedef core::chemical::ResidueTypeSet	ResidueTypeSet

typedef core::chemical::ResidueTypeSetCAP	ResidueTypeSetCAP

typedef core::chemical::ResidueTypeSetCOP	ResidueTypeSetCOP

typedef core::conformation::signals::LengthEvent	LengthEvent

typedef core::kinematics::MoveMap	MoveMap

typedef core::pose::Pose	Pose

typedef utility::vector1 < BuildInstructionCAP >	BuildInstructionCAPs

typedef utility::signals::Link	Link

typedef std::set< core::Size >	Positions

typedef std::string	String

Public Member Functions
	GrowLeft ()
	default constructor More...

	GrowLeft (core::Size const pos, String const &ss, String const &aa=String(), ResidueTypeSetCAP rts=core::chemical::ChemicalManager::get_instance() ->residue_type_set(core::chemical::FA_STANDARD))
	constructor More...

	GrowLeft (GrowLeft const &rval)
	copy constructor More...

	~GrowLeft () override
	default destructor More...

GrowLeft &	operator= (GrowLeft const &rval)
	copy assignment More...

BuildInstructionOP	clone () const override
	clone this object More...

core::Size	pos () const
	grow left from this anchor position More...

String const &	ss () const
	get secondary structure string More...

String const &	aa () const
	get annotated amino acid string More...

bool	original_interval_valid () const override
	is the original interval storing valid information, or is empty or being used for something else? More...

Interval	interval () const override
	a copy of the working range of residues specifying the modified region More...

Positions	preexisting_positions () const override
	return a copy of the set of positions within the new region that were pre-existing in the original Pose prior to modify() More...

Positions	new_positions () const override
	return a copy of the set of positions that are "new" and did not exist in the original Pose. More...

Positions	defined_positions () const override
	return a copy of the set of positions within the newly modified region that has a defined conformation. E.g. existing or copied residues. More...

Positions	undefined_positions () const override
	return a copy of the set of positions within the newly modified region that has an undefined conformation. E.g. newly created residues. More...

MoveMap	movemap () const override
	return a copy of the MoveMap that defines the moveable/fixed positions/dofs for this instruction More...

void	on_residue_append (LengthEvent const &event) override
	update indexing on residue append More...

void	on_residue_prepend (LengthEvent const &event) override
	update indexing on residue prepend More...

void	on_residue_delete (LengthEvent const &event) override
	update indexing on residue delete More...

Positions	original_kept_positions () const override
	return the set of positions within the original interval that will be kept in this BuildInstruction More...

Positions	original_deleted_positions () const override
	return set of positions within the original interval that will be deleted in this BuildInstruction More...

Positions	original_fixed_positions () const override
	return set of any fixed positions necessary with respect to the original interval and original Pose numbering More...

Positions	original_mutable_positions () const override
	return set of any mutable positions necessary with respect to the original interval and original Pose numbering More...

bool	creates_undefined_backbone () const override
	does this object create undefined backbone in the modified region? More...

Public Member Functions inherited from protocols::forge::build::BuildInstruction
	BuildInstruction ()
	default constructor More...

	BuildInstruction (Interval const &i, ResidueTypeSetCAP rts=core::chemical::ChemicalManager::get_instance() ->residue_type_set(core::chemical::FA_STANDARD))
	interval constructor More...

	BuildInstruction (BuildInstruction const &rval)
	copy constructor More...

	~BuildInstruction () override
	default destructor More...

BuildInstruction &	operator= (BuildInstruction const &rval)
	copy assignment More...

BuildInstructionState::Enum	modify (Pose &pose)
	modify this pose More...

BuildInstructionState::Enum	state () const
	return the state of this BuildInstruction More...

bool	ready () const
	Is the BuildInstruction's state at READY? More...

bool	waiting_on_dependencies () const
	Is the BuildInstruction's state at WAITING_ON_DEPENDENCIES? More...

bool	modify_was_successful () const
	Is the BuildInstruction's state at MODIFY_WAS_SUCCESSFUL? More...

void	attach_to (Pose &pose)
	attach to a Pose's conformation More...

void	detach_from ()
	detach from a Pose's conformation More...

void	on_length_change (LengthEvent const &event)
	update any indexing wrt length change to Pose/Conformation being watched More...

bool	detach_after_modify () const
	detach after modify()? More...

Interval const &	original_interval () const
	return original residue range of this instruction More...

ResidueTypeSet const &	residue_type_set () const
	the residue type set being used More...

bool	has_dependencies () const
	does this BuildInstruction have dependencies? More...

core::Size	n_dependencies () const
	the number of dependencies this BuildInstruction has More...

BuildInstructionCAPs const &	dependencies () const
	the list of instructions whose modify() must complete before the modify() for this instruction may be called successfully More...

void	detach_after_modify (bool const flag)
	set detach after modify() More...

void	reset_accounting ()
	reset intervals, positions, etc to initial state and drop observers. State set to READY. More...

virtual void	add_dependency_to (BuildInstructionCAP i)
	add an instruction to this BuildInstruction's dependency list More...

virtual bool	dependent_on (BuildInstructionCAP i) const
	is this instruction dependent upon the given instruction? More...

void	clear_dependencies ()
	clear the list of dependencies More...

virtual bool	compatible_with (BuildInstruction const &rval) const
	compares fixed and mutable positions to determine compatibility with another instruction More...

Protected Member Functions
bool	dependencies_satisfied () const override
	are dependencies satisfied so that modify_impl() can complete successfully? More...

void	modify_impl (Pose &pose) override
	do the actual work of modifying the Pose More...

void	reset_accounting_impl () override
	do the actual reset of intervals, positions, etc to initial state More...

Protected Member Functions inherited from protocols::forge::build::BuildInstruction
Link const &	length_obs_link () const
	access to the Conformation length observer link More...

void	state (BuildInstructionState::Enum const s)
	set the BuildInstruction's current state More...

Private Types
typedef BuildInstruction	Super

Private Attributes
core::Size	pos_
	make an n-terminal extension before this position More...

String	ss_
	secondary structure string, also defines length of extension More...

String	aa_
	annotated amino acid string, length of the one-letter version must be equal to length of ss More...

Detailed Description

instruction to create an n-side extension

Use this for n-side insertions, but typically not n-terminal extensions unless necessary. It does not automatically cover the additional residue on the right endpoint that needs to move during n-terminal extensions due to invalid phi torsion. For that case, use the SegmentRebuild class replacing the n-terminal residue with desired length+1.

Member Typedef Documentation

typedef Super::LengthEvent protocols::forge::build::GrowLeft::LengthEvent

typedef Super::MoveMap protocols::forge::build::GrowLeft::MoveMap

typedef Super::Pose protocols::forge::build::GrowLeft::Pose

typedef Super::Positions protocols::forge::build::GrowLeft::Positions

typedef Super::ResidueTypeSetCAP protocols::forge::build::GrowLeft::ResidueTypeSetCAP

typedef Super::Size protocols::forge::build::GrowLeft::Size

typedef Super::String protocols::forge::build::GrowLeft::String

typedef BuildInstruction protocols::forge::build::GrowLeft::Super

private

Constructor & Destructor Documentation

protocols::forge::build::GrowLeft::GrowLeft ( )

default constructor

protocols::forge::build::GrowLeft::GrowLeft	(	core::Size const	pos,
		String const &	ss,
		String const &	aa = `String()`,
		ResidueTypeSetCAP	rts = `core::chemical::ChemicalManager::get_instance()->residue_type_set( core::chemical::FA_STANDARD )`
	)

constructor

Parameters

[in]	pos	grow an n-side extension prior to this position
[in]	ss	the secondary structure desired, also defines length of extension
[in]	aa	the annotated amino acid sequence desired, default is poly-alanine
[in]	rts	the residue type set to use, default FA_STANDARD

Remarks: length of the one-letter aa must equal the length of ss

References aa_, core::pose::annotated_to_oneletter_sequence(), and ss_.

protocols::forge::build::GrowLeft::GrowLeft ( GrowLeft const & rval )

default

copy constructor

protocols::forge::build::GrowLeft::~GrowLeft ( )

overridedefault

default destructor

Member Function Documentation

String const& protocols::forge::build::GrowLeft::aa ( ) const

inline

get annotated amino acid string

References aa_.

BuildInstructionOP protocols::forge::build::GrowLeft::clone ( ) const

overridevirtual

clone this object

Implements protocols::forge::build::BuildInstruction.

bool protocols::forge::build::GrowLeft::creates_undefined_backbone ( ) const

inlineoverridevirtual

does this object create undefined backbone in the modified region?

Returns: true

Implements protocols::forge::build::BuildInstruction.

GrowLeft::Positions protocols::forge::build::GrowLeft::defined_positions ( ) const

overridevirtual

return a copy of the set of positions within the newly modified region that has a defined conformation. E.g. existing or copied residues.

return a copy of the set of positions within the newly modified region that has a defined conformation. E.g. copied residues.

Returns: An empty set – no positions are defined.

This set can change wrt length changes in Pose/Conformation being watched.

Implements protocols::forge::build::BuildInstruction.

bool protocols::forge::build::GrowLeft::dependencies_satisfied ( ) const

inlineoverrideprotectedvirtual

are dependencies satisfied so that modify_impl() can complete successfully?

Returns: always True, this BuildInstruction has no dependencies

Reimplemented from protocols::forge::build::BuildInstruction.

Interval protocols::forge::build::GrowLeft::interval ( ) const

inlineoverridevirtual

a copy of the working range of residues specifying the modified region

Remarks: This can change if listening to Conformation LengthEvents

Implements protocols::forge::build::BuildInstruction.

References pos_, and ss_.

Referenced by modify_impl(), and new_positions().

void protocols::forge::build::GrowLeft::modify_impl ( Pose & pose )

overrideprotectedvirtual

do the actual work of modifying the Pose

Implements protocols::forge::build::BuildInstruction.

References aa_, protocols::forge::methods::grow_left_rtype(), interval(), pos_, protocols::forge::build::BuildInstruction::residue_type_set(), core::pose::residue_types_from_sequence(), core::pose::Pose::set_secstruct(), ss_, and protocols::forge::methods::trans_omega().

GrowLeft::MoveMap protocols::forge::build::GrowLeft::movemap ( ) const

overridevirtual

return a copy of the MoveMap that defines the moveable/fixed positions/dofs for this instruction

Returns: a MoveMap with [interval.left, interval.right] bb & chi set to true at the MoveMapTorsionID level

This set can change wrt length changes in Pose/Conformation being watched.

Implements protocols::forge::build::BuildInstruction.

References new_positions(), core::kinematics::MoveMap::set_bb(), and core::kinematics::MoveMap::set_chi().

GrowLeft::Positions protocols::forge::build::GrowLeft::new_positions ( ) const

overridevirtual

return a copy of the set of positions that are "new" and did not exist in the original Pose.

Returns: A set of positions spanning the entire region – all positions are new.

Implements protocols::forge::build::BuildInstruction.

References protocols::forge::methods::closed_range(), interval(), protocols::forge::build::Interval::left, and protocols::forge::build::Interval::right.

Referenced by movemap(), and undefined_positions().

void protocols::forge::build::GrowLeft::on_residue_append ( LengthEvent const & event )

overridevirtual

update indexing on residue append

Implements protocols::forge::build::BuildInstruction.

References pos_, and core::conformation::signals::LengthEvent::position.

void protocols::forge::build::GrowLeft::on_residue_delete ( LengthEvent const & event )

overridevirtual

update indexing on residue delete

Implements protocols::forge::build::BuildInstruction.

References core::conformation::signals::LengthEvent::length_change, pos_, and core::conformation::signals::LengthEvent::position.

void protocols::forge::build::GrowLeft::on_residue_prepend ( LengthEvent const & event )

overridevirtual

update indexing on residue prepend

Implements protocols::forge::build::BuildInstruction.

References pos_, and core::conformation::signals::LengthEvent::position.

GrowLeft & protocols::forge::build::GrowLeft::operator= ( GrowLeft const & rval )

copy assignment

References aa_, protocols::forge::build::BuildInstruction::operator=(), pos_, and ss_.

GrowLeft::Positions protocols::forge::build::GrowLeft::original_deleted_positions ( ) const

overridevirtual

return set of positions within the original interval that will be deleted in this BuildInstruction

Returns: An empty set – no positions are deleted.

Implements protocols::forge::build::BuildInstruction.

GrowLeft::Positions protocols::forge::build::GrowLeft::original_fixed_positions ( ) const

overridevirtual

return set of any fixed positions necessary with respect to the original interval and original Pose numbering

Remarks: Used for ensuring build regions for instructions do not overlap and so that jumps may be placed correctly.

Returns: empty set if no fixed positions

Implements protocols::forge::build::BuildInstruction.

References protocols::forge::build::BuildInstruction::original_interval().

bool protocols::forge::build::GrowLeft::original_interval_valid ( ) const

inlineoverridevirtual

is the original interval storing valid information, or is empty or being used for something else?

Returns: false, stores invalid interval

Implements protocols::forge::build::BuildInstruction.

GrowLeft::Positions protocols::forge::build::GrowLeft::original_kept_positions ( ) const

overridevirtual

return the set of positions within the original interval that will be kept in this BuildInstruction

Returns: An empty set – no positions are kept.

Implements protocols::forge::build::BuildInstruction.

GrowLeft::Positions protocols::forge::build::GrowLeft::original_mutable_positions ( ) const

overridevirtual

return set of any mutable positions necessary with respect to the original interval and original Pose numbering

Remarks: Used for ensuring build regions for instructions do not overlap and so that jumps may be placed correctly.

Returns: empty set if no mutable positions

Implements protocols::forge::build::BuildInstruction.

core::Size protocols::forge::build::GrowLeft::pos ( ) const

inline

grow left from this anchor position

Remarks: this can change if listening to Conformation LengthEvents Use original_interval() to get the original anchor position.

References pos_.

GrowLeft::Positions protocols::forge::build::GrowLeft::preexisting_positions ( ) const

overridevirtual

return a copy of the set of positions within the new region that were pre-existing in the original Pose prior to modify()

Returns: An empty set – no positions are pre-existing.

Implements protocols::forge::build::BuildInstruction.

void protocols::forge::build::GrowLeft::reset_accounting_impl ( )

overrideprotectedvirtual

do the actual reset of intervals, positions, etc to initial state

Implements protocols::forge::build::BuildInstruction.

References protocols::forge::build::BuildInstruction::original_interval(), pos_, and protocols::forge::build::Interval::right.

String const& protocols::forge::build::GrowLeft::ss ( ) const

inline

get secondary structure string

References ss_.

GrowLeft::Positions protocols::forge::build::GrowLeft::undefined_positions ( ) const

overridevirtual

return a copy of the set of positions within the newly modified region that has an undefined conformation. E.g. newly created residues.

return a copy of the set of positions within the newly modified region that has an undefined conformation. E.g. existing or copied residues.

Returns: A set of positions spanning the entire region – all positions are undefined.

This set can change wrt length changes in Pose/Conformation being watched.

Implements protocols::forge::build::BuildInstruction.

References new_positions().

Member Data Documentation

String protocols::forge::build::GrowLeft::aa_

private

annotated amino acid string, length of the one-letter version must be equal to length of ss

Referenced by aa(), GrowLeft(), modify_impl(), and operator=().

core::Size protocols::forge::build::GrowLeft::pos_

private

make an n-terminal extension before this position

Remarks: this position can shift if listening to a Pose/Conformation and the number of residues changes

Referenced by interval(), modify_impl(), on_residue_append(), on_residue_delete(), on_residue_prepend(), operator=(), pos(), and reset_accounting_impl().

String protocols::forge::build::GrowLeft::ss_

private

secondary structure string, also defines length of extension

Referenced by GrowLeft(), interval(), modify_impl(), operator=(), and ss().

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

src/protocols/forge/build/GrowLeft.hh
src/protocols/forge/build/GrowLeft.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation