instruction to swap a segment with an external segment More...

#include <SegmentSwap.hh>

Inheritance diagram for protocols::forge::build::SegmentSwap:

Public Types
typedef Super::Size	Size

typedef Super::ResidueTypeSetCAP	ResidueTypeSetCAP

typedef Super::LengthEvent	LengthEvent

typedef Super::Pose	Pose

typedef Super::Positions	Positions

typedef Super::String	String

typedef core::kinematics::MoveMap	MoveMap

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
	SegmentSwap ()
	default constructor More...

	SegmentSwap (Interval const &i, MoveMap const &swap_in_movemap, Pose const &swap_in)
	constructor More...

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

	~SegmentSwap () override
	default destructor More...

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

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

MoveMap const &	swap_in_movemap () const
	fixed backbone residues in this movemap will be used for new jumps More...

Pose const &	swap_in () const
	the pose to swap in 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 swapped 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 Member Functions
void	init ()
	init to be called during non-default constructors More...

Private Attributes
Interval	interval_
	range of residues to swap out More...

MoveMap	swap_in_movemap_
	fixed backbone residues in this movemap will be used for new jumps More...

Pose	swap_in_
	swap in this Pose More...

Detailed Description

instruction to swap a segment with an external segment

Member Typedef Documentation

◆ LengthEvent

typedef Super::LengthEvent protocols::forge::build::SegmentSwap::LengthEvent

◆ MoveMap

typedef core::kinematics::MoveMap protocols::forge::build::SegmentSwap::MoveMap

◆ Pose

typedef Super::Pose protocols::forge::build::SegmentSwap::Pose

◆ Positions

typedef Super::Positions protocols::forge::build::SegmentSwap::Positions

◆ ResidueTypeSetCAP

typedef Super::ResidueTypeSetCAP protocols::forge::build::SegmentSwap::ResidueTypeSetCAP

◆ Size

typedef Super::Size protocols::forge::build::SegmentSwap::Size

◆ String

typedef Super::String protocols::forge::build::SegmentSwap::String

◆ Super

typedef BuildInstruction protocols::forge::build::SegmentSwap::Super

private

Constructor & Destructor Documentation

◆ SegmentSwap() [1/3]

protocols::forge::build::SegmentSwap::SegmentSwap ( )

default constructor

◆ SegmentSwap() [2/3]

protocols::forge::build::SegmentSwap::SegmentSwap	(	Interval const &	i,
		MoveMap const &	swap_in_movemap,
		Pose const &	swap_in
	)

constructor

Parameters

[in]	interval	swap out this range of residues
[in]	move_map	fixed backbone residues in this movemap will be used for new jumps
[in]	swap_in	swap in this pose
[in]	interval	swap out this range of residues
[in]	move_map	fixed backbone residues in this movemap will be used for new jumps
[in]	swap_in	swap in this pose

Remarks: Procedure will attempt to honor the movemap as much as it can. The caveat is that sequences of calls to some FoldTree routines may shift the jumps internally in a way that is not easily predictable. If the procedure cannot find an allowed residue for a jump, it will make a jump to the (lower) median residue in the disconnected fold tree interval.

References init().

◆ SegmentSwap() [3/3]

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

default

copy constructor

◆ ~SegmentSwap()

protocols::forge::build::SegmentSwap::~SegmentSwap ( )

overridedefault

default destructor

Member Function Documentation

◆ clone()

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

overridevirtual

clone this object

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

◆ creates_undefined_backbone()

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

inlineoverridevirtual

does this object create undefined backbone in the modified region?

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

◆ defined_positions()

SegmentSwap::Positions protocols::forge::build::SegmentSwap::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.

Returns: A set of positions spanning the interval – all positions are are defined.

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

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

References new_positions().

◆ dependencies_satisfied()

bool protocols::forge::build::SegmentSwap::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.

◆ init()

void protocols::forge::build::SegmentSwap::init ( void )

private

init to be called during non-default constructors

References core::pose::Pose::conformation(), core::conformation::Residue::is_lower_terminus(), core::conformation::Residue::is_upper_terminus(), core::conformation::remove_lower_terminus_type_from_conformation_residue(), core::conformation::remove_upper_terminus_type_from_conformation_residue(), core::pose::Pose::residue(), core::pose::Pose::size(), and swap_in_.

Referenced by SegmentSwap().

◆ interval()

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

overridevirtual

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

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

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

References interval_.

Referenced by new_positions().

◆ modify_impl()

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

overrideprotectedvirtual

do the actual work of modifying the Pose

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

References core::pose::Pose::conformation(), core::conformation::Conformation::delete_residue_range_slow(), core::pose::Pose::fold_tree(), core::pose::Pose::insert_residue_by_jump(), interval_, core::sequence::left, protocols::forge::build::Interval::left, core::kinematics::FoldTree::new_jump(), protocols::forge::build::BuildInstruction::original_interval(), core::pose::Pose::pdb_info(), protocols::forge::methods::replace(), core::pose::Pose::residue(), protocols::forge::build::Interval::right, core::pose::Pose::secstruct(), core::pose::Pose::set_secstruct(), core::pose::Pose::size(), swap_in_, and swap_in_movemap_.

◆ movemap()

SegmentSwap::MoveMap protocols::forge::build::SegmentSwap::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 set to false at the MoveMapTorsionID level

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

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

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

◆ new_positions()

SegmentSwap::Positions protocols::forge::build::SegmentSwap::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 interval – all positions are are defined.

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 defined_positions(), and movemap().

◆ on_residue_append()

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

overridevirtual

update indexing on residue append

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

References interval_, protocols::forge::build::Interval::left, core::conformation::signals::LengthEvent::position, and protocols::forge::build::Interval::right.

◆ on_residue_delete()

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

overridevirtual

update indexing on residue delete

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

References interval_, protocols::forge::build::Interval::left, core::conformation::signals::LengthEvent::length_change, core::conformation::signals::LengthEvent::position, and protocols::forge::build::Interval::right.

◆ on_residue_prepend()

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

overridevirtual

update indexing on residue prepend

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

References interval_, protocols::forge::build::Interval::left, core::conformation::signals::LengthEvent::position, and protocols::forge::build::Interval::right.

◆ operator=()

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

copy assignment

References interval_, protocols::forge::build::BuildInstruction::operator=(), swap_in_, and swap_in_movemap_.

◆ original_deleted_positions()

SegmentSwap::Positions protocols::forge::build::SegmentSwap::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.

References protocols::forge::methods::closed_range(), core::sequence::left, and protocols::forge::build::BuildInstruction::original_interval().

◆ original_fixed_positions()

SegmentSwap::Positions protocols::forge::build::SegmentSwap::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 necessary

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

◆ original_interval_valid()

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

inlineoverridevirtual

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

Returns: true, stores valid interval

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

◆ original_kept_positions()

SegmentSwap::Positions protocols::forge::build::SegmentSwap::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.

◆ original_mutable_positions()

SegmentSwap::Positions protocols::forge::build::SegmentSwap::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.

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

References protocols::forge::methods::closed_range(), core::sequence::left, and protocols::forge::build::BuildInstruction::original_interval().

◆ preexisting_positions()

SegmentSwap::Positions protocols::forge::build::SegmentSwap::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.

◆ reset_accounting_impl()

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

overrideprotectedvirtual

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

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

References interval_, and protocols::forge::build::BuildInstruction::original_interval().

◆ swap_in()

SegmentSwap::Pose const & protocols::forge::build::SegmentSwap::swap_in ( ) const

the pose to swap in

References swap_in_.

◆ swap_in_movemap()

SegmentSwap::MoveMap const & protocols::forge::build::SegmentSwap::swap_in_movemap ( ) const

fixed backbone residues in this movemap will be used for new jumps

Remarks: Procedure will attempt to honor this movemap as much as it can. The caveat is that sequences of calls to some FoldTree routines may shift the jumps internally in a way that is not easily predictable. If the procedure cannot find an allowed residue for a jump, it will make a jump to the (lower) median residue in the disconnected fold tree interval.

References swap_in_movemap_.

◆ undefined_positions()

SegmentSwap::Positions protocols::forge::build::SegmentSwap::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.

Returns: An empty set – no undefined positions.

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

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

Member Data Documentation

◆ interval_

Interval protocols::forge::build::SegmentSwap::interval_

private

range of residues to swap out

Remarks: this range 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=(), and reset_accounting_impl().

◆ swap_in_

Pose protocols::forge::build::SegmentSwap::swap_in_

private

swap in this Pose

Referenced by init(), modify_impl(), operator=(), and swap_in().

◆ swap_in_movemap_

MoveMap protocols::forge::build::SegmentSwap::swap_in_movemap_

private

fixed backbone residues in this movemap will be used for new jumps

Remarks: Procedure will attempt to honor this movemap as much as it can. The caveat is that sequences of calls to some FoldTree routines may shift the jumps internally in a way that is not easily predictable. If the procedure cannot find an allowed residue for a jump, it will make a jump to the (lower) median residue in the disconnected fold tree interval.

Referenced by modify_impl(), operator=(), and swap_in_movemap().

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

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ LengthEvent

◆ MoveMap

◆ Pose

◆ Positions

◆ ResidueTypeSetCAP

◆ Size

◆ String

◆ Super

Constructor & Destructor Documentation

◆ SegmentSwap() [1/3]

◆ SegmentSwap() [2/3]

◆ SegmentSwap() [3/3]

◆ ~SegmentSwap()

Member Function Documentation

◆ clone()

◆ creates_undefined_backbone()

◆ defined_positions()

◆ dependencies_satisfied()

◆ init()

◆ interval()

◆ modify_impl()

◆ movemap()

◆ new_positions()

◆ on_residue_append()

◆ on_residue_delete()

◆ on_residue_prepend()

◆ operator=()

◆ original_deleted_positions()

◆ original_fixed_positions()

◆ original_interval_valid()

◆ original_kept_positions()

◆ original_mutable_positions()

◆ preexisting_positions()

◆ reset_accounting_impl()

◆ swap_in()

◆ swap_in_movemap()

◆ undefined_positions()

Member Data Documentation

◆ interval_

◆ swap_in_

◆ swap_in_movemap_