ChainBase Class Reference

#include <chain_base.hh>

Inherits GenericPropContainer< ChainBase >.

Inherited by ChainHandle, and ChainView.

Public Member Functions
	ChainBase ()
	ChainBase (const impl::ChainImplPtr &impl)
String	GetName () const
ChainType	GetType () const
String	GetDescription () const
const impl::ChainImplPtr &	Impl () const
bool	IsPolymer () const
bool	IsPolysaccharide () const
bool	IsPolypeptide () const
bool	IsPolynucleotide () const
impl::ChainImplPtr &	Impl ()
Handle validity
	operator bool () const
bool	IsValid () const
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	RemoveProp (const String &key)
Public Member Functions inherited from ConstGenericPropContainer< ChainBase >
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

Protected Member Functions
GenericPropContainerImpl *	GpImpl ()
const GenericPropContainerImpl *	GpImpl () const
void	CheckValidity () const

Friends
class	ConstGenericPropContainer< ChainBase >

---

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

(

)

ChainBase

(

const impl::ChainImplPtr &

impl

)

---

Member Function Documentation

void CheckValidity ( ) const

protected

String GetDescription

(

)

const

Get information about a chain.

Returns:

description

String GetName

(

)

const

ChainType GetType

(

)

const

Get the type of a chain.

Returns:

chain type of ChainType

GenericPropContainerImpl* GpImpl ( )

protected

const GenericPropContainerImpl* GpImpl ( ) const

protected

const impl::ChainImplPtr& Impl ( ) const

inline

Definition at line 73 of file chain_base.hh.

impl::ChainImplPtr& Impl ( )

inline

Definition at line 92 of file chain_base.hh.

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.

bool IsPolynucleotide

(

)

const

whether the chain is a polynucleotide

bool IsPolypeptide

(

)

const

whether the chain is a polypeptide

bool IsPolysaccharide

(

)

const

whether the chain is a polysaccharide

bool IsValid ( ) const

inline

check validity of handle

See also:

operator bool()

Reimplemented in ChainView.

Definition at line 58 of file chain_base.hh.

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.

Reimplemented in ChainView.

Definition at line 55 of file chain_base.hh.

---

Friends And Related Function Documentation

friend class ConstGenericPropContainer< ChainBase >

friend

Definition at line 60 of file chain_base.hh.

---

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

• stage/include/ost/mol/chain_base.hh