OpenStructure
Public Member Functions
ResidueImpl Class Reference

#include <residue_impl.hh>

Inherits GenericPropContainerImpl, and enable_shared_from_this< ResidueImpl >.

Public Member Functions

 ResidueImpl (const EntityImplPtr &ent, const ChainImplPtr &ch, const ResNum &num, const ResidueKey &key)
 
AtomImplPtr InsertAtom (const String &name, const geom::Vec3 &pos, const String &ele)
 
AtomImplPtr InsertAtom (const AtomImplPtr &atom)
 
AtomImplPtr InsertAltAtom (const String &name, const String &alt_group, const geom::Vec3 &pos, const String &ele, Real occ, Real b_factor)
 
const ResNumGetNumber () const
 
void SetNumber (const ResNum &num)
 
const ResidueKeyGetKey () const
 
void SetKey (const ResidueKey &key)
 
ChainImplPtr GetChain () const
 
AtomImplPtr GetCentralAtom () const
 
void SetCentralAtom (const AtomImplPtr &a)
 
geom::Vec3 GetCentralNormal () const
 
char GetOneLetterCode () const
 
void SetOneLetterCode (const char olc)
 
AtomImplPtr FindAtom (const String &aname) const
 
void Apply (EntityVisitor &v)
 
int GetAtomCount () const
 
int GetBondCount () const
 
EntityImplPtr GetEntity () const
 
TorsionImplP GetPhiTorsion () const
 
TorsionImplP GetOmegaTorsion () const
 
TorsionImplP GetPsiTorsion () const
 
SecStructure GetSecStructure () const
 
void SetSecStructure (SecStructure ss)
 
const AtomImplListGetAtomList () const
 
AtomImplListGetAtomList ()
 
Real GetMass () const
 
geom::Vec3 GetCenterOfMass () const
 
geom::Vec3 GetCenterOfAtoms () const
 
geom::AlignedCuboid GetBounds () const
 
void DeleteAtom (const AtomImplPtr &atom)
 
void DeleteAtoms (const String &atom_name)
 
void DeleteAllAtoms ()
 
void AddTorsion (const TorsionImplP &torsion)
 
const TorsionImplListGetTorsionList () const
 
bool HasAltAtomGroup (const String &group) const
 
std::vector< StringGetAltAtomGroupNames () const
 
std::vector< StringGetAltAtomGroupNames (const AtomImplPtr &atom) const
 
bool HasAltAtoms () const
 
Real GetAverageBFactor () const
 
bool SwitchAtomPos (const String &group)
 
void AddAltAtomPos (const String &group, const AtomImplPtr &atom, const geom::Vec3 &position, Real occ, Real b_factor)
 
geom::Vec3 GetAltAtomPos (const AtomImplPtr &atom, const String &group) const
 
Real GetAltAtomOcc (const AtomImplPtr &atom, const String &group) const
 
Real GetAltAtomBFactor (const AtomImplPtr &atom, const String &group) const
 
const StringGetCurrentAltGroupName () const
 
int GetIndex () const
 
String GetQualifiedName () const
 
const StringGetName () const
 
TorsionImplListGetTorsionList ()
 
void SetChemClass (ChemClass cc)
 
ChemClass GetChemClass () const
 
ChemType GetChemType () const
 
void SetChemType (ChemType ct)
 
TorsionImplP FindTorsion (const String &torsion_name) const
 
String GetStringProperty (Prop::ID prop_id) const
 
Real GetFloatProperty (Prop::ID prop_id) const
 
int GetIntProperty (Prop::ID prop_id) const
 
void SetProtein (bool protein)
 
bool IsProtein () const
 
bool IsLigand () const
 
void SetIsLigand (bool flag)
 
void UpdateTransformedPos ()
 
- Public Member Functions inherited from GenericPropContainerImpl
 GenericPropContainerImpl ()
 
 ~GenericPropContainerImpl ()
 
 GenericPropContainerImpl (const GenericPropContainerImpl &rhs)
 
GenericPropContainerImploperator= (const GenericPropContainerImpl &r)
 
GenericPropValueGenericProp (const String &key)
 
const GenericPropValueGenericProp (const String &key) const
 
bool HasProp (const String &key) const
 
void ClearProps ()
 
void RemoveProp (const String &key)
 
void Assign (const GenericPropContainerImpl &impl)
 
PropertyMap GetPropMap () const
 
std::vector< StringGetPropList () const
 

Detailed Description

Definition at line 47 of file residue_impl.hh.

Constructor & Destructor Documentation

◆ ResidueImpl()

ResidueImpl ( const EntityImplPtr ent,
const ChainImplPtr ch,
const ResNum num,
const ResidueKey key 
)

Member Function Documentation

◆ AddAltAtomPos()

void AddAltAtomPos ( const String group,
const AtomImplPtr atom,
const geom::Vec3 position,
Real  occ,
Real  b_factor 
)

◆ AddTorsion()

void AddTorsion ( const TorsionImplP torsion)

◆ Apply()

void Apply ( EntityVisitor v)

◆ DeleteAllAtoms()

void DeleteAllAtoms ( )

◆ DeleteAtom()

void DeleteAtom ( const AtomImplPtr atom)

◆ DeleteAtoms()

void DeleteAtoms ( const String atom_name)

◆ FindAtom()

AtomImplPtr FindAtom ( const String aname) const

Find atom by name.

Todo:
make the return type a AtomImplList, since there may be several atoms with the given name.
Returns
The first atom matchin the name, or an invalid AtomImplPtr if there is no such atom.

◆ FindTorsion()

TorsionImplP FindTorsion ( const String torsion_name) const

◆ GetAltAtomBFactor()

Real GetAltAtomBFactor ( const AtomImplPtr atom,
const String group 
) const

◆ GetAltAtomGroupNames() [1/2]

std::vector<String> GetAltAtomGroupNames ( ) const

◆ GetAltAtomGroupNames() [2/2]

std::vector<String> GetAltAtomGroupNames ( const AtomImplPtr atom) const

◆ GetAltAtomOcc()

Real GetAltAtomOcc ( const AtomImplPtr atom,
const String group 
) const

◆ GetAltAtomPos()

geom::Vec3 GetAltAtomPos ( const AtomImplPtr atom,
const String group 
) const

◆ GetAtomCount()

int GetAtomCount ( ) const

Get number of atoms of this residue.

◆ GetAtomList() [1/2]

AtomImplList& GetAtomList ( )
inline

Definition at line 136 of file residue_impl.hh.

◆ GetAtomList() [2/2]

const AtomImplList& GetAtomList ( ) const

◆ GetAverageBFactor()

Real GetAverageBFactor ( ) const

retrieve average temperature factor of residue.

◆ GetBondCount()

int GetBondCount ( ) const

Get number of bonds of this residue.

◆ GetBounds()

geom::AlignedCuboid GetBounds ( ) const

◆ GetCenterOfAtoms()

geom::Vec3 GetCenterOfAtoms ( ) const

◆ GetCenterOfMass()

geom::Vec3 GetCenterOfMass ( ) const

◆ GetCentralAtom()

AtomImplPtr GetCentralAtom ( ) const

◆ GetCentralNormal()

geom::Vec3 GetCentralNormal ( ) const

◆ GetChain()

ChainImplPtr GetChain ( ) const

◆ GetChemClass()

ChemClass GetChemClass ( ) const
inline

Definition at line 201 of file residue_impl.hh.

◆ GetChemType()

ChemType GetChemType ( ) const
inline

Definition at line 204 of file residue_impl.hh.

◆ GetCurrentAltGroupName()

const String& GetCurrentAltGroupName ( ) const
inline

Definition at line 178 of file residue_impl.hh.

◆ GetEntity()

EntityImplPtr GetEntity ( ) const

◆ GetFloatProperty()

Real GetFloatProperty ( Prop::ID  prop_id) const

◆ GetIndex()

int GetIndex ( ) const

◆ GetIntProperty()

int GetIntProperty ( Prop::ID  prop_id) const

◆ GetKey()

const ResidueKey& GetKey ( ) const
inline

Definition at line 66 of file residue_impl.hh.

◆ GetMass()

Real GetMass ( ) const

◆ GetName()

const String& GetName ( ) const
inline

Get name of residue. At the moment an alias for GetKey.

Definition at line 189 of file residue_impl.hh.

◆ GetNumber()

const ResNum& GetNumber ( ) const
inline

Definition at line 63 of file residue_impl.hh.

◆ GetOmegaTorsion()

TorsionImplP GetOmegaTorsion ( ) const

Retrieve omega torsion between this and the previous residue.

If no omega torsion has been assigned to this residue an invalid TorsionImplP will be returned.

◆ GetOneLetterCode()

char GetOneLetterCode ( ) const

◆ GetPhiTorsion()

TorsionImplP GetPhiTorsion ( ) const

Get phi torsion.

If no phi torsion has been assigned to this residue an invalid TorsionImplP will be returned.

◆ GetPsiTorsion()

TorsionImplP GetPsiTorsion ( ) const

Get psi torsion.

If no psi torsion has been assigned to this residue an invalid TorsionImplP will be returned.

◆ GetQualifiedName()

String GetQualifiedName ( ) const

Get fully qualified name of the residue, including chain name, residue name and number.

See also
AtomHandle::GetQualifiedName()

◆ GetSecStructure()

SecStructure GetSecStructure ( ) const

Get secondary structure type. By default, the residue is in COIL conformation.

◆ GetStringProperty()

String GetStringProperty ( Prop::ID  prop_id) const

◆ GetTorsionList() [1/2]

TorsionImplList& GetTorsionList ( )
inline

Get all torsions this residue is involved in.

Definition at line 194 of file residue_impl.hh.

◆ GetTorsionList() [2/2]

const TorsionImplList& GetTorsionList ( ) const
inline

Definition at line 153 of file residue_impl.hh.

◆ HasAltAtomGroup()

bool HasAltAtomGroup ( const String group) const

Test if residue has alternative atoms with a certain name.

◆ HasAltAtoms()

bool HasAltAtoms ( ) const

◆ InsertAltAtom()

AtomImplPtr InsertAltAtom ( const String name,
const String alt_group,
const geom::Vec3 pos,
const String ele,
Real  occ,
Real  b_factor 
)

◆ InsertAtom() [1/2]

AtomImplPtr InsertAtom ( const AtomImplPtr atom)

insert new residue with exactly the same parameters as atom, but no bonds

◆ InsertAtom() [2/2]

AtomImplPtr InsertAtom ( const String name,
const geom::Vec3 pos,
const String ele 
)

◆ IsLigand()

bool IsLigand ( ) const
inline

Definition at line 224 of file residue_impl.hh.

◆ IsProtein()

bool IsProtein ( ) const
inline

Definition at line 222 of file residue_impl.hh.

◆ SetCentralAtom()

void SetCentralAtom ( const AtomImplPtr a)

explicitely set central atom

if this is set, it will override the heuristic encoded in GetCentralAtom; pass an invalid ptr to deactivate again

◆ SetChemClass()

void SetChemClass ( ChemClass  cc)
inline

Definition at line 198 of file residue_impl.hh.

◆ SetChemType()

void SetChemType ( ChemType  ct)
inline

Definition at line 207 of file residue_impl.hh.

◆ SetIsLigand()

void SetIsLigand ( bool  flag)
inline

Definition at line 225 of file residue_impl.hh.

◆ SetKey()

void SetKey ( const ResidueKey key)
inline

Definition at line 70 of file residue_impl.hh.

◆ SetNumber()

void SetNumber ( const ResNum num)
inline

Definition at line 64 of file residue_impl.hh.

◆ SetOneLetterCode()

void SetOneLetterCode ( const char  olc)

◆ SetProtein()

void SetProtein ( bool  protein)
inline

Definition at line 220 of file residue_impl.hh.

◆ SetSecStructure()

void SetSecStructure ( SecStructure  ss)

Set secondary structure type.

◆ SwitchAtomPos()

bool SwitchAtomPos ( const String group)

◆ UpdateTransformedPos()

void UpdateTransformedPos ( )

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