Rosetta  2021.16
 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::IdentityEvent Struct Reference

signals a change in residue identity in a Conformation More...

#include <IdentityEvent.hh>

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

Public Types

enum  Tag { EMPTY, INVALIDATE, RESIDUE }
 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

 IdentityEvent ()
 default constructor More...
 
 IdentityEvent (Conformation const *conf, Tag const t, Size const &pos, Residue const *res)
 constructor More...
 
 IdentityEvent (IdentityEvent const &rval)
 copy constructor More...
 
 ~IdentityEvent () override
 default destructor More...
 
IdentityEventoperator= (IdentityEvent 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...
 
GeneralEventoperator= (GeneralEvent const &rval)
 copy assignment More...
 

Public Attributes

Tag tag
 tag indicating type of identity change More...
 
Size position
 residue position 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 residue identity 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 

Constructor & Destructor Documentation

core::conformation::signals::IdentityEvent::IdentityEvent ( )
inline

default constructor

core::conformation::signals::IdentityEvent::IdentityEvent ( Conformation const *  conf,
Tag const  t,
Size const &  pos,
Residue const *  res 
)
inline

constructor

Parameters
posresidue position
core::conformation::signals::IdentityEvent::IdentityEvent ( IdentityEvent const &  rval)
inline

copy constructor

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

default destructor

Member Function Documentation

IdentityEvent& core::conformation::signals::IdentityEvent::operator= ( IdentityEvent const &  rval)
inline

Member Data Documentation

Size core::conformation::signals::IdentityEvent::position

residue position

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

Residue const* core::conformation::signals::IdentityEvent::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::pose::PDBInfo::on_identity_change(), and operator=().

Tag core::conformation::signals::IdentityEvent::tag

tag indicating type of identity change

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


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