Rosetta  2020.46
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | List of all members
core::conformation::signals::LengthEvent Struct Reference

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

#include <LengthEvent.hh>

Inheritance diagram for core::conformation::signals::LengthEvent:
Inheritance graph
[legend]

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...
 
 ~LengthEvent () override
 default destructor More...
 
LengthEventoperator= (LengthEvent const &rval)
 copy assignment More...
 
void check_consistency () const
 
- 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...
 
GeneralEventoperator= (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...
 
Size conformation_size
 The length of the conformation after the length event. More...
 
int length_change
 overall length change of the conformation More...
 
Residue const * 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.

Member Typedef Documentation

Member Enumeration Documentation

the type of length change

Enumerator
EMPTY 
INVALIDATE 
RESIDUE_APPEND 
RESIDUE_PREPEND 
RESIDUE_DELETE 

Constructor & Destructor Documentation

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

default constructor

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

constructor

Parameters
ttype of length change
posresidue position

References check_consistency(), conformation_size, and core::conformation::Conformation::size().

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

copy constructor

References check_consistency().

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

default destructor

Member Function Documentation

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

Member Data Documentation

Size core::conformation::signals::LengthEvent::conformation_size

The length of the conformation after the length event.

This is needed for things like regenerating mappings after multiple applications of events which may invalidate the confromation.

Referenced by LengthEvent(), operator=(), and core::id::SequenceMapping::SequenceMapping().

int core::conformation::signals::LengthEvent::length_change
Size core::conformation::signals::LengthEvent::position

residue position where the event happened

Referenced by core::conformation::carbohydrates::GlycanTreeSet::on_length_change(), core::pose::datacache::SpecialSegmentsObserver::on_length_change(), core::pose::PDBInfo::on_length_change(), protocols::forge::build::SegmentSwap::on_residue_append(), protocols::forge::build::Bridge::on_residue_append(), protocols::forge::build::GrowRight::on_residue_append(), protocols::forge::build::GrowLeft::on_residue_append(), protocols::forge::build::SegmentRebuild::on_residue_append(), protocols::forge::build::ConnectRight::on_residue_append(), protocols::forge::build::SegmentInsert::on_residue_append(), protocols::denovo_design::components::StructureDataObserver::on_residue_delete(), 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(), protocols::forge::build::SegmentSwap::on_residue_prepend(), protocols::forge::build::Bridge::on_residue_prepend(), protocols::forge::build::GrowRight::on_residue_prepend(), protocols::forge::build::GrowLeft::on_residue_prepend(), protocols::forge::build::SegmentRebuild::on_residue_prepend(), protocols::forge::build::ConnectRight::on_residue_prepend(), protocols::forge::build::SegmentInsert::on_residue_prepend(), operator=(), and core::conformation::carbohydrates::GlycanTree::update_on_length_change().

Residue const* 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.

Referenced by core::conformation::carbohydrates::GlycanTreeSet::on_length_change(), core::pose::PDBInfo::on_length_change(), operator=(), and core::conformation::carbohydrates::GlycanTree::update_on_length_change().

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

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