OpenStructure
Public Member Functions
ChainBase Class Reference

#include <chain_base.hh>

Inherits GenericPropContainer< ChainBase >.

Inherited by ChainHandle, and ChainView.

Public Member Functions

 ChainBase ()
 
 ChainBase (const impl::ChainImplPtr &impl)
 
- Public Member Functions inherited from GenericPropContainer< ChainBase >
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
 

Handle validity

class ConstGenericPropContainer< ChainBase >
 
 operator bool () const
 
bool IsValid () const
 
String GetName () const
 
ChainType GetType () const
 
String GetDescription () const
 
const impl::ChainImplPtr & Impl () const
 
bool IsPolymer () const
 
bool IsPolysaccharide () const
 
bool IsOligosaccharide () const
 
bool IsPolypeptide () const
 
bool IsPolynucleotide () const
 
impl::ChainImplPtr & Impl ()
 
GenericPropContainerImpl * GpImpl ()
 
const GenericPropContainerImpl * GpImpl () const
 
void CheckValidity () 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 ChainHandle and ChainView

This class implements the common functionality of ChainHandle and ChainView.

Like residues and atoms, chains are generic property containers and a such able to store user-defined properties.

Chains are linear chains of residues. Peptide chains are ordered from N- to C-terminus.

Definition at line 39 of file chain_base.hh.

Constructor & Destructor Documentation

◆ ChainBase() [1/2]

ChainBase ( )

◆ ChainBase() [2/2]

ChainBase ( const impl::ChainImplPtr &  impl)

Member Function Documentation

◆ CheckValidity()

void CheckValidity ( ) const
protected

◆ GetDescription()

String GetDescription ( ) const

Get information about a chain.

Returns
description

◆ GetName()

String GetName ( ) const

◆ GetType()

ChainType GetType ( ) const

Get the type of a chain.

Returns
chain type of ChainType

◆ GpImpl() [1/2]

GenericPropContainerImpl* GpImpl ( )
protected

◆ GpImpl() [2/2]

const GenericPropContainerImpl* GpImpl ( ) const
protected

◆ Impl() [1/2]

impl::ChainImplPtr& Impl ( )
inline

Definition at line 95 of file chain_base.hh.

◆ Impl() [2/2]

const impl::ChainImplPtr& Impl ( ) const
inline

Definition at line 73 of file chain_base.hh.

◆ IsOligosaccharide()

bool IsOligosaccharide ( ) const

whether the chain is an oligsaccharide (branched mmCIF entity)

◆ IsPolymer()

bool IsPolymer ( ) const

whether the chain is a polymer

True if one of IsPolysaccharide(), IsPolynucleotide(), IsPolypeptide() is true or the chain is of type CHAINTYPE_POLYMER.

◆ IsPolynucleotide()

bool IsPolynucleotide ( ) const

whether the chain is a polynucleotide

◆ IsPolypeptide()

bool IsPolypeptide ( ) const

whether the chain is a polypeptide

◆ IsPolysaccharide()

bool IsPolysaccharide ( ) const

whether the chain is a polysaccharide

◆ IsValid()

bool IsValid ( ) const

check validity of handle

See also
operator bool()

◆ operator bool()

operator bool ( ) const
inline

check validity of handle

check, whether the chain handle points to a valid handle.

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 55 of file chain_base.hh.

Friends And Related Function Documentation

◆ ConstGenericPropContainer< ChainBase >

friend class ConstGenericPropContainer< ChainBase >
friend

Definition at line 58 of file chain_base.hh.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1