Rosetta 3.4
Public Types | Public Member Functions | Public Attributes
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]
Collaboration diagram for core::conformation::signals::LengthEvent:
Collaboration graph
[legend]

List of all members.

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 Member Functions

 LengthEvent ()
 default constructor
 LengthEvent (Conformation const *conf, Tag const t, Size const &pos, int const &len_chg, Residue const *res)
 constructor
 LengthEvent (LengthEvent const &rval)
 copy constructor
virtual ~LengthEvent ()
 default destructor
LengthEventoperator= (LengthEvent const &rval)
 copy assignment

Public Attributes

Tag tag
 tag indicating type of length change
Size position
 residue position where the event happened
int length_change
 overall length change of the conformation
ResidueCAP residue
 direct access to residue

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 
) [inline]

constructor

Parameters:
ttype of length change
posresidue position
core::conformation::signals::LengthEvent::LengthEvent ( LengthEvent const &  rval) [inline]

copy constructor

virtual core::conformation::signals::LengthEvent::~LengthEvent ( ) [inline, virtual]

default destructor


Member Function Documentation

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

Member Data Documentation

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::pose::PDBInfo::on_length_change(), and operator=().


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines