signals a change in length of residues in a Conformation More...

#include <LengthEvent.hh>

Inheritance diagram for core::conformation::signals::LengthEvent:

Collaboration diagram for core::conformation::signals::LengthEvent:

Public Types
enum	Tag { EMPTY, INVALIDATE, RESIDUE_APPEND, RESIDUE_PREPEND, RESIDUE_DELETE }
	the type of length change More...

typedef core::Size	Size

typedef GeneralEvent	Super

Public Types inherited from core::conformation::signals::GeneralEvent
typedef core::conformation::Conformation	Conformation

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

	LengthEvent (Conformation const conf, Tag const t, Size const &pos, int const &len_chg, Residue const res)
	constructor More...

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

virtual	~LengthEvent ()
	default destructor More...

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

Public Member Functions inherited from core::conformation::signals::GeneralEvent
	GeneralEvent ()
	default constructor More...

	GeneralEvent (Conformation const *conf)
	constructor More...

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

virtual	~GeneralEvent ()
	default destructor More...

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

Public Attributes
Tag	tag
	tag indicating type of length change More...

Size	position
	residue position where the event happened More...

int	length_change
	overall length change of the conformation More...

ResidueCAP	residue
	direct access to residue More...

Public Attributes inherited from core::conformation::signals::GeneralEvent
Conformation const *	conformation
	the Conformation firing the signal More...

Detailed Description

signals a change in length of residues in a Conformation

Remarks: When accessing residue information, take care as to which data member you choose. For almost all situations the ResidueCAP 'residue' should be used instead of the Conformation. See remarks below.

Definition at line 47 of file LengthEvent.hh.

Member Typedef Documentation

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

Definition at line 51 of file LengthEvent.hh.

typedef GeneralEvent core::conformation::signals::LengthEvent::Super

Definition at line 52 of file LengthEvent.hh.

Member Enumeration Documentation

enum core::conformation::signals::LengthEvent::Tag

the type of length change

Enumerator
EMPTY
INVALIDATE
RESIDUE_APPEND
RESIDUE_PREPEND
RESIDUE_DELETE

Definition at line 56 of file LengthEvent.hh.

Constructor & Destructor Documentation

core::conformation::signals::LengthEvent::LengthEvent ( )

inline

default constructor

Definition at line 67 of file LengthEvent.hh.

core::conformation::signals::LengthEvent::LengthEvent	(	Conformation const *	conf,
		Tag const	t,
		Size const &	pos,
		int const &	len_chg,
		Residue const *	res
	)

inline

constructor

Parameters

t	type of length change
pos	residue position

Definition at line 80 of file LengthEvent.hh.

core::conformation::signals::LengthEvent::LengthEvent ( LengthEvent const & rval)

inline

copy constructor

Definition at line 97 of file LengthEvent.hh.

virtual core::conformation::signals::LengthEvent::~LengthEvent ( )

inlinevirtual

default destructor

Definition at line 109 of file LengthEvent.hh.

Member Function Documentation

LengthEvent& core::conformation::signals::LengthEvent::operator= ( LengthEvent const & rval)

inline

copy assignment

Definition at line 115 of file LengthEvent.hh.

References length_change, core::conformation::signals::GeneralEvent::operator=(), position, residue, and tag.

Member Data Documentation

int core::conformation::signals::LengthEvent::length_change

overall length change of the conformation

Definition at line 134 of file LengthEvent.hh.

Referenced by core::pose::datacache::SpecialSegmentsObserver::on_length_change(), core::pose::PDBInfo::on_length_change(), protocols::forge::build::SegmentSwap::on_residue_delete(), protocols::forge::build::Bridge::on_residue_delete(), protocols::forge::build::GrowRight::on_residue_delete(), protocols::forge::build::GrowLeft::on_residue_delete(), protocols::forge::build::SegmentRebuild::on_residue_delete(), protocols::forge::build::ConnectRight::on_residue_delete(), protocols::forge::build::SegmentInsert::on_residue_delete(), operator=(), and core::id::SequenceMapping::SequenceMapping().

Size core::conformation::signals::LengthEvent::position

residue position where the event happened

Definition at line 131 of file LengthEvent.hh.

ResidueCAP core::conformation::signals::LengthEvent::residue

direct access to residue

Remarks: Almost always want to use this to access the residue instead of the conformation. Calling Conformation::residue() can cause an internal update/re-sync inside Pose, which may have consequences if you're depending upon multiple residue operations to be setup (such as bond angle/length changes) prior to an internal update.

Definition at line 142 of file LengthEvent.hh.

Referenced by core::pose::PDBInfo::on_length_change(), and operator=().

Tag core::conformation::signals::LengthEvent::tag

tag indicating type of length change

Definition at line 128 of file LengthEvent.hh.

Referenced by protocols::toolbox::match_enzdes_util::EnzdesCacheableObserver::on_length_change(), protocols::forge::build::BuildInstruction::on_length_change(), core::pose::PDBInfo::on_length_change(), core::scoring::constraints::ConstraintSet::on_length_change(), operator=(), and core::id::SequenceMapping::SequenceMapping().

The documentation for this struct was generated from the following file:

src/core/conformation/signals/LengthEvent.hh

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation