#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 | RemoveProp (const String &key) |
| Public Member Functions inherited from ConstGenericPropContainer< ResidueBase > | |
| bool | HasProp (const String &key) const |
| String | GetPropAsString (const String &key) const |
| String | GetStringProp (const String &key) const |
| String | GetStringProp (const String &key, const String &def) const |
| Real | GetFloatProp (const String &key) const |
| Real | GetFloatProp (const String &key, Real def) const |
| int | GetIntProp (const String &key) const |
| int | GetIntProp (const String &key, int def) const |
| bool | GetBoolProp (const String &key) const |
| bool | GetBoolProp (const String &key, bool def) const |
| std::map< String, GenericPropValue > | GetPropMap () const |
| std::vector< String > | GetPropList () 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::LPeptideLinking, indicating that the residue is capable to participate in a peptide bond. For nucleotides, the chemical class is either ChemClass::RNALinking or ChemClass::DNALinking. For unknown compounds the chemical class is ChemClass::Unknown.
When loading an entity from file, the one-letter and chemical class of a residue are assigned by the default builder.
Definition at line 59 of file residue_base.hh.
Constructor & Destructor Documentation
| ResidueBase | ( | ) |
| ResidueBase | ( | const impl::ResidueImplPtr & | impl | ) |
| ResidueBase | ( | const ResidueBase & | rhs | ) |
Member Function Documentation
|
protected |
| ChemClass GetChemClass | ( | ) | const |
| int GetIntProperty | ( | Prop::ID | prop_id | ) | const |
Get int property by id.
| const ResidueKey& GetKey | ( | ) | const |
return the residue key.
| const ResNum& GetNumber | ( | ) | const |
return residue number
| TorsionHandle GetOmegaTorsion | ( | ) | const |
Get omega torsion.
If no omega torsion has been assigned to this residue an invalid TorsionHandle will be returned.
| char GetOneLetterCode | ( | ) | const |
| TorsionHandle GetPhiTorsion | ( | ) | const |
Get phi torsion.
If no phi torsion has been assigned to this residue an invalid TorsionHandle will be returned.
| TorsionHandle GetPsiTorsion | ( | ) | const |
Get psi torsion.
If no psi torsion has been assigned to this residue an invalid TorsionHandle will be returned.
| String GetQualifiedName | ( | ) | const |
get fully qualified name of residue, including the chain name, residue name and residue number
| SecStructure GetSecStructure | ( | ) | const |
Get secondary structure type. By default, the residue is in COIL conformation.
|
protected |
|
protected |
| impl::ResidueImplPtr& Impl | ( | ) |
| const impl::ResidueImplPtr& Impl | ( | ) | const |
| bool IsLigand | ( | ) | const |
| bool IsNucleotideLinking | ( | ) | const |
whether the residue can be part of a polynucleotide
| bool IsPeptideLinking | ( | ) | const |
whether the residue can form peptide bonds
| bool IsProtein | ( | ) | const |
whether the residue is part of the protein.
|
inline |
check validity of handle
- See also:
- operator bool()
Reimplemented in ResidueView.
Definition at line 78 of file residue_base.hh.
|
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.
Reimplemented in ResidueView.
Definition at line 75 of file residue_base.hh.
| void SetChemClass | ( | ChemClass | cc | ) |
| void SetIsLigand | ( | bool | ligand | ) |
| void SetIsProtein | ( | bool | protein | ) |
| void SetOneLetterCode | ( | char | olc | ) |
| void SetSecStructure | ( | SecStructure | ss | ) |
Set secondary structure type.
- See also:
- ResidueHandle::GetSecStructure
Friends And Related Function Documentation
|
friend |
Definition at line 79 of file residue_base.hh.
The documentation for this class was generated from the following file:
- stage/include/ost/mol/residue_base.hh
