#include <residue_base.hh>
Inherits GenericPropContainer< ResidueBase >.
Inherited by ResidueHandle, and ResidueView.
Public Member Functions | |
| ResidueBase () | |
| ResidueBase (const impl::ResidueImplPtr &impl) | |
| ResidueBase (const ResidueBase &rhs) | |
 Public Member Functions inherited from GenericPropContainer< ResidueBase > | |
| void | ClearProps () |
| void | SetStringProp (const String &key, const String &value) |
| void | SetFloatProp (const String &key, Real value) |
| void | SetIntProp (const String &key, int value) |
| void | SetBoolProp (const String &key, bool value) |
| void | SetVec3Prop (const String &key, geom::Vec3 value) |
| void | RemoveProp (const String &key) |
| Public Member Functions inherited from ConstGenericPropContainer< H > | |
| bool | HasProp (const String &key) const |
| String | GetPropAsString (const String &key) const |
| String | GetStringProp (const String &key) const |
| Real | GetFloatProp (const String &key) const |
| int | GetIntProp (const String &key) const |
| bool | GetBoolProp (const String &key) const |
| geom::Vec3 | GetVec3Prop (const String &key) const |
| String | GetStringProp (const String &key, const String &def) const |
| Real | GetFloatProp (const String &key, Real def) const |
| int | GetIntProp (const String &key, int def) const |
| bool | GetBoolProp (const String &key, bool def) const |
| std::map< String, GenericPropValue > | GetPropMap () const |
| std::vector< String > | GetPropList () const |
Additional Inherited Members | |
| Protected Member Functions inherited from ConstGenericPropContainer< H > | |
| template<typename T > | |
| T | gp_get (const String &key) const |
| template<typename T > | |
| T | gp_get (const String &key, const T &def) const |
| GenericPropContainerImpl * | GetImpl () |
| const GenericPropContainerImpl * | GetImpl () const |
Detailed Description
base class for ResidueHandle and ResidueView
This class implements the common functionality for both ResidueHandle and ResidueView.
Like atoms and chains, residues are generic property containers and as such can store user-defined properties.
Each residue has a residue number that uniquely identifies the residue in a chain. This number consists of a numeric part and an optional alphanumeric insertion code.
Residues have names that are usually 3 characters long. The most common residue types such as the 20 standard amino acids and nucleotides also have a defined one-letter code. For other residues, the one-letter code is set to ?.
Residues have a chemical class. For standard amino acids this class is ChemClass::L_PEPTIDE_LINKING, indicating that the residue is capable to participate in a peptide bond. For nucleotides, the chemical class is either ChemClass::RNA_LINKING or ChemClass::DNA_LINKING. For unknown compounds the chemical class is ChemClass::UNKNOWN.
In addition, residues have a ChemType. A classification of all components into nine categories (ions, non-canonical molecules, saccharised, nucleotides, amino acids, co-enzymes, water coordinated ions, drugs, solvents) as obtained from the PDB.
Definition at line 65 of file residue_base.hh.
Constructor & Destructor Documentation
◆ ResidueBase() [1/3]
| ResidueBase | ( | ) |
◆ ResidueBase() [2/3]
| ResidueBase | ( | const impl::ResidueImplPtr & | impl | ) |
◆ ResidueBase() [3/3]
| ResidueBase | ( | const ResidueBase & | rhs | ) |
Member Function Documentation
◆ CheckValidity()
|
protected |
◆ GetCentralAtom()
| AtomHandle GetCentralAtom | ( | ) | const |
returns main atom, ie CA for amino acids
◆ GetCentralNormal()
| geom::Vec3 GetCentralNormal | ( | ) | const |
- Returns
- return specific normal of residue, usually CA-CB dir for AA
◆ GetChemClass()
| ChemClass GetChemClass | ( | ) | const |
◆ GetChemType()
| ChemType GetChemType | ( | ) | const |
PDB ligand classification from component dictionary.
◆ GetFloatProperty()
◆ GetIntProperty()
| int GetIntProperty | ( | Prop::ID | prop_id | ) | const |
Get int property by id.
◆ GetKey()
| const ResidueKey& GetKey | ( | ) | const |
return the residue key.
◆ GetName()
◆ GetNumber()
| const ResNum& GetNumber | ( | ) | const |
return residue number
◆ GetOmegaTorsion()
| TorsionHandle GetOmegaTorsion | ( | ) | const |
Get omega torsion.
If no omega torsion has been assigned to this residue an invalid TorsionHandle will be returned.
◆ GetOneLetterCode()
| char GetOneLetterCode | ( | ) | const |
◆ GetPhiTorsion()
| TorsionHandle GetPhiTorsion | ( | ) | const |
Get phi torsion.
If no phi torsion has been assigned to this residue an invalid TorsionHandle will be returned.
◆ GetPsiTorsion()
| TorsionHandle GetPsiTorsion | ( | ) | const |
Get psi torsion.
If no psi torsion has been assigned to this residue an invalid TorsionHandle will be returned.
◆ GetQualifiedName()
| String GetQualifiedName | ( | ) | const |
get fully qualified name of residue, including the chain name, residue name and residue number
◆ GetSecStructure()
| SecStructure GetSecStructure | ( | ) | const |
Get secondary structure type. By default, the residue is in COIL conformation.
◆ GetStringProperty()
◆ GpImpl() [1/2]
|
protected |
◆ GpImpl() [2/2]
|
protected |
◆ Impl() [1/2]
| impl::ResidueImplPtr& Impl | ( | ) |
◆ Impl() [2/2]
| const impl::ResidueImplPtr& Impl | ( | ) | const |
◆ IsLigand()
| bool IsLigand | ( | ) | const |
◆ IsNucleotideLinking()
| bool IsNucleotideLinking | ( | ) | const |
whether the residue can be part of a polynucleotide
◆ IsPeptideLinking()
| bool IsPeptideLinking | ( | ) | const |
whether the residue can form peptide bonds
◆ IsProtein()
| bool IsProtein | ( | ) | const |
whether the residue is part of the protein.
◆ IsValid()
| bool IsValid | ( | ) | const |
check validity of handle
- See also
- operator bool()
◆ operator bool()
|
inline |
check validity of handle
check, whether the residue handle points to a valid residue.
- Note
- It is an error to use any method other than IsValid, Impl and operator bool() when the handle is invalid. An InvalidHandle exception will be thrown.
Definition at line 81 of file residue_base.hh.
◆ SetCentralAtom()
| void SetCentralAtom | ( | const AtomHandle & | a | ) |
set explicit central atom
overrides the heuristic of GetCentralAtom to explicitely use the given one as the central atom; passing in an invalid handle reverts back to the heurstic determination
◆ SetChemClass()
| void SetChemClass | ( | ChemClass | cc | ) |
◆ SetChemType()
| void SetChemType | ( | ChemType | ct | ) |
◆ SetIsLigand()
| void SetIsLigand | ( | bool | ligand | ) |
◆ SetIsProtein()
| void SetIsProtein | ( | bool | protein | ) |
◆ SetOneLetterCode()
| void SetOneLetterCode | ( | char | olc | ) |
◆ SetSecStructure()
| void SetSecStructure | ( | SecStructure | ss | ) |
Set secondary structure type.
- See also
- ResidueHandle::GetSecStructure
Friends And Related Function Documentation
◆ ConstGenericPropContainer< ResidueBase >
|
friend |
Definition at line 84 of file residue_base.hh.
The documentation for this class was generated from the following file:
- build-2.9.0-doc/stage/include/ost/mol/residue_base.hh
