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:

Collaboration diagram for core::conformation::signals::IdentityEvent:

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...
virtual	~IdentityEvent ()
	default destructor More...
IdentityEvent &	operator= (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...
GeneralEvent &	operator= (GeneralEvent const &rval)
	copy assignment More...

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

Definition at line 49 of file IdentityEvent.hh.

Member Typedef Documentation

typedef core::Size core::conformation::signals::IdentityEvent::Size

Definition at line 53 of file IdentityEvent.hh.

typedef GeneralEvent core::conformation::signals::IdentityEvent::Super

Definition at line 54 of file IdentityEvent.hh.

Member Enumeration Documentation

enum core::conformation::signals::IdentityEvent::Tag

the type of length change

Enumerator
EMPTY
INVALIDATE
RESIDUE

Definition at line 58 of file IdentityEvent.hh.

Constructor & Destructor Documentation

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

inline

default constructor

Definition at line 67 of file IdentityEvent.hh.

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

inline

constructor

Parameters

pos	residue position

Definition at line 78 of file IdentityEvent.hh.

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

inline

copy constructor

Definition at line 93 of file IdentityEvent.hh.

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

inlinevirtual

default destructor

Definition at line 104 of file IdentityEvent.hh.

Member Function Documentation

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

inline

copy assignment

Definition at line 110 of file IdentityEvent.hh.

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

Member Data Documentation

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

residue position

Definition at line 125 of file IdentityEvent.hh.

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

ResidueCAP 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.

Definition at line 133 of file IdentityEvent.hh.

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

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

tag indicating type of identity change

Definition at line 122 of file IdentityEvent.hh.

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

---

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

• src/core/conformation/signals/IdentityEvent.hh